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

> Liste os workspaces que você tem ou dos quais participa com GET /v2/workspaces, cada um com membros, cargos e aplicações compartilhadas. Vazio se não houver.

<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) `workspaces:manage`.

Retorna todos os workspaces em que o usuário autenticado é dono ou membro, cada um já com sua lista de membros (nomes e funções) e suas aplicações compartilhadas (nome, RAM, linguagem, domínio). É o ponto de entrada ideal para montar um seletor de workspaces ou um dashboard, já que evita uma chamada a [Obter workspace](/pt-br/api-reference/endpoint/workspace/get) por workspace.

A resposta é um array vazio para um usuário sem workspaces, seja porque está em um plano sem acesso a workspaces, seja simplesmente porque ainda não criou nem entrou em nenhum. Para criar o primeiro, veja [Criar workspace](/pt-br/api-reference/endpoint/workspace/create).

## Resposta

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

<ResponseField name="response" type="object">
  O conteúdo da resposta.

  <Expandable title="Alternar objeto">
    <ResponseField name="id" type="string">
      O ID do workspace: 32 caracteres hexadecimais (um UUID v4 sem hífens). Workspaces mais antigos têm um ID hexadecimal de 40 caracteres.
    </ResponseField>

    <ResponseField name="owner" type="string">
      O ID do proprietário do Workspace.
    </ResponseField>

    <ResponseField name="name" type="string">
      O nome do Workspace.
    </ResponseField>

    <ResponseField name="members" type="object">
      A lista de membros do workspace. Ela sempre inclui o dono, com `group: "owner"`.

      <Expandable title="Alternar objeto">
        <ResponseField name="id" type="string">
          O ID do usuário.
        </ResponseField>

        <ResponseField name="name" type="string">
          O nome do usuário. Pode ser `null`, por exemplo quando a conta foi excluída.
        </ResponseField>

        <ResponseField name="group" type="string">
          As permissões do membro nas aplicações do workspace.
        </ResponseField>

        <ResponseField name="joinedAt" type="string">
          O timestamp de entrada em UTC-0.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="applications" type="object">
      A lista de aplicações do workspace.

      <Expandable title="Alternar objeto">
        <ResponseField name="id" type="string">
          O ID da aplicação enviada.
        </ResponseField>

        <ResponseField name="name" type="string">
          O nome da aplicação enviada.
        </ResponseField>

        <ResponseField name="ram" type="number">
          O uso de RAM da aplicação enviada em MB.
        </ResponseField>

        <ResponseField name="language" type="object">
          A linguagem de programação da aplicação enviada.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="createdAt" type="string">
      O timestamp de criação em UTC-0.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseExample>
  ```json theme={"system"}
  {
      "status": "success",
      "response": [
          {
              "id": "3f9c2a7e5b1d4e8a9c6f0b2d4e6a8c1f",
              "name": "Test",
              "owner": "5354d9742d889d49b20134ba0be09ccc0033be68",
              "members": [
              {
                  "name": "Example",
                  "id": "5354d9742d889d49b20134ba0be09ccc0033be68",
                  "group": "owner",
                  "joinedAt": "2025-06-04T20:44:55.934Z"
              }
              ],
              "applications": [],
              "createdAt": "2025-06-04T20:44:55.934Z"
          }
      ]
  }
  ```
</ResponseExample>

## Erros comuns

| Código | HTTP | Significado |
| - | - | - |
| `DATABASE_UNAVAILABLE` | 503 | O serviço está brevemente indisponível. Tente novamente em alguns segundos. |

## Relacionados

* CLI: [`squarecloud workspace list`](/pt-br/cli-reference/workspaces#squarecloud-workspace-list)
* SDKs: [`api.workspaces.list()`](/pt-br/sdks/js/workspaces) (JavaScript), [`client.workspaces.list()`](/pt-br/sdks/py/workspaces) (Python), [`c.Workspaces.List()`](/pt-br/sdks/go/workspaces) (Go)


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