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

# Obter workspace

> Obtenha um workspace com GET /v2/workspaces/{workspaceId}: dono, membros e cargos, aplicações compartilhadas e data de criação. Quem não é membro recebe 404.

<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 os detalhes completos de um workspace: seu dono, a lista de membros com suas funções, as aplicações compartilhadas e a data de criação. O usuário autenticado precisa ser o dono ou um membro atual; qualquer outra pessoa, mesmo tendo apenas o ID do workspace, recebe um 404 em vez de um erro de permissão, então o endpoint também funciona como uma verificação leve de existência.

Use este endpoint depois de [Convidar membro](/pt-br/api-reference/endpoint/workspace/members/invite) ou [Adicionar aplicação](/pt-br/api-reference/endpoint/workspace/apps/add) para confirmar que a mudança foi aplicada, ou use [Listar workspaces](/pt-br/api-reference/endpoint/workspace/list) para buscar de uma vez todos os workspaces aos quais o solicitante tem acesso. Limitado a 30 requisições a cada 60 segundos por usuário, com um bloqueio curto ao exceder o limite.

## Parâmetros

<ParamField path="workspaceId" type="string" placeholder="ID do Workspace" required>
  O ID do workspace.
</ParamField>

## 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 |
| - | - | - |
| `WORKSPACE_NOT_FOUND` | 404 | O workspace não existe, ou o solicitante não é o dono nem um membro. |
| `DATABASE_UNAVAILABLE` | 503 | O serviço está brevemente indisponível. Tente novamente em alguns segundos. |

## Relacionados

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


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