Skip to main content
GET
/
v2
/
apps
/
domains
List Domains
curl --request GET \
  --url https://api.squarecloud.app/v2/apps/domains \
  --header 'Authorization: <authorization>'
{
  "status": "success",
  "response": [
    { "app_id": "abc123def456abc123def456", "hostname": "example.com", "type": "custom" },
    { "app_id": "abc123def456abc123def456", "hostname": "my-app.squareweb.app", "type": "subdomain" }
  ]
}
​
Authorization
string
required
The API key for your account. You can find this in your account settings.
This endpoint accepts either your API key or a session token (JWT) in the Authorization header. Authentication is required — requests without it return 401.

​
Response

​
status
string
Indicates whether the call was successful.. success if successful, error if not.
The response array is a flattened list of every hostname across the applications you own. Custom domains come first, followed by the default *.squareweb.app subdomains. Applications without a web domain (e.g. workers and bots) are omitted.
This list is served from the cached project list, so it does not count against the per-application network rate limits.
​
response
array
The list of hostnames.
{
  "status": "success",
  "response": [
    { "app_id": "abc123def456abc123def456", "hostname": "example.com", "type": "custom" },
    { "app_id": "abc123def456abc123def456", "hostname": "my-app.squareweb.app", "type": "subdomain" }
  ]
}