> ## 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.

# Listar todos os domínios

> Liste todos os hostnames com GET /v2/apps/domains: domínios personalizados primeiro, depois os subdomínios squareweb.app, cada um com sua aplicação.

<ParamField header="Authorization" type="string" placeholder="Chave da API" required>
  A chave da API para sua conta. Você pode encontrá-la nas [configurações da conta](https://squarecloud.app/pt-br/account/security).
</ParamField>

Requer uma chave de API com o [escopo](/pt-br/api-reference/authentication#escopos) `apps:read`.

Use este endpoint para obter uma visão única, de toda a conta, de cada hostname que você configurou, útil para popular uma página de visão geral de domínios sem chamar [Consultar informações da aplicação](/pt-br/api-reference/endpoint/apps/info) uma vez por aplicação. Para anexar ou alterar um domínio personalizado em uma aplicação específica, veja [Definir domínio personalizado](/pt-br/api-reference/endpoint/apps/network/custom); os registros DNS de um domínio são obtidos separadamente via [Consultar registros DNS](/pt-br/api-reference/endpoint/apps/network/dns).

<Note>
  Este endpoint aceita a sua chave da API ou um token de sessão (JWT) no cabeçalho `Authorization`. A autenticação é obrigatória: requisições sem ela retornam `401`.
</Note>

## Resposta

<ResponseField name="status" type="string">
  Indica se a chamada foi bem-sucedida: `success` se foi, `error` se não.
</ResponseField>

O array `response` é uma lista achatada de todos os hostnames das aplicações que você possui. Os domínios personalizados vêm primeiro, seguidos pelos subdomínios padrão `*.squareweb.app`. Aplicações sem domínio web (ex.: workers e bots) são omitidas.

<Info>
  Esta lista é servida a partir da lista de projetos em cache, portanto **não** conta contra os limites de taxa de rede por aplicação.
</Info>

<ResponseField name="response" type="array">
  A lista de hostnames.

  <Expandable title="Alternar objeto">
    <ResponseField name="app_id" type="string">
      O identificador hexadecimal de 32 caracteres da aplicação dona do domínio.
    </ResponseField>

    <ResponseField name="hostname" type="string">
      O hostname totalmente qualificado.
    </ResponseField>

    <ResponseField name="type" type="string">
      `"subdomain"` para o host padrão `*.squareweb.app`; `"custom"` para um domínio personalizado anexado.
    </ResponseField>
  </Expandable>
</ResponseField>

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

## Relacionados

* CLI: [`squarecloud app domains`](/pt-br/cli-reference/domains#squarecloud-app-domains)
* SDKs: [`api.apps.domains()`](/pt-br/sdks/js/managing_application) (JavaScript), [`client.apps.domains()`](/pt-br/sdks/py/managing_application) (Python), [`c.Apps.Domains()`](/pt-br/sdks/go/managing_application) (Go)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.