> ## Documentation Index
> Fetch the complete documentation index at: https://docs.squarecloud.app/llms.txt
> Use this file to discover all available pages before exploring further.

# List Domains

> List all hostnames configured across your applications, including the default squareweb.app subdomain and any attached custom domain. It has a rate limit of 20 requests every 60 seconds.

<ParamField header="Authorization" type="string" placeholder="API Key" required>
  The API key for your account. You can find this in your [account settings](https://squarecloud.app/account/security).
</ParamField>

<Note>
  This endpoint accepts either your API key or a session token (JWT) in the `Authorization` header. Authentication is required — requests without it return `401`.
</Note>

### Response

<ResponseField name="status" type="string">
  Indicates whether the call was successful.. `success` if successful, `error` if not.
</ResponseField>

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.

<Info>
  This list is served from the cached project list, so it does **not** count against the per-application network rate limits.
</Info>

<ResponseField name="response" type="array">
  The list of hostnames.

  <Expandable title="Toggle object">
    <ResponseField name="app_id" type="string">
      The 24-character hex identifier of the application that owns the domain.
    </ResponseField>

    <ResponseField name="hostname" type="string">
      The fully qualified hostname.
    </ResponseField>

    <ResponseField name="type" type="string">
      `"subdomain"` for the default `*.squareweb.app` host; `"custom"` for an attached custom domain.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseExample>
  ```json theme={null}
  {
    "status": "success",
    "response": [
      { "app_id": "abc123def456abc123def456", "hostname": "example.com", "type": "custom" },
      { "app_id": "abc123def456abc123def456", "hostname": "my-app.squareweb.app", "type": "subdomain" }
    ]
  }
  ```
</ResponseExample>