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

# Obter workspace

> Retorna os detalhes completos do workspace, as permissões de quem chama e a organização individual dele.

Qualquer membro pode chamar isto (não há barreira de permissão de leitura no próprio workspace — você
ou faz parte dele, ou recebe `404`). Uma chave de API precisa do escopo `workspaces:read`.

> [!NOTE]
>
> Um workspace que não existe e um do qual você não faz parte respondem da mesma forma:
> `404 WORKSPACE_NOT_FOUND`. Isso é intencional — diferenciar os dois vazaria quais IDs de workspace existem.

### Caminho

**id** `string` *required*

ID do workspace.

### Resposta

**response** `APIWorkspaceInfoResponse`

Tudo de [Listar workspaces](https://docs.vertracloud.app/pt-br/api-reference/endpoint/workspaces/get-all.md), mais:

**Mostrar objeto**

**members** `APIWorkspaceMember[]`

Lista completa de membros, no mesmo formato de [Listar membros](https://docs.vertracloud.app/pt-br/api-reference/endpoint/workspaces/members/list.md).

**roles** `APIWorkspaceRole[]`

Lista completa de papéis, no mesmo formato de [Listar papéis](https://docs.vertracloud.app/pt-br/api-reference/endpoint/workspaces/roles/list.md).

**applications** `APIApplication[]`

Aplicações vinculadas a este workspace.

**databases** `APIDatabase[]`

Bancos de dados vinculados a este workspace.

**permissions** `WorkspacePermission[]`

As permissões resolvidas de quem chama. O dono recebe o catálogo completo de 20 permissões sem precisar de uma linha de papel.

**is\_owner** `boolean`

**owner\_plan** `string | null`

O nome do plano do dono do workspace (por exemplo, `pro` ou `enterprise-8`), ou `null` quando o dono não tem plano. Ele determina quais recursos o workspace tem.

**resource\_organization** `APIWorkspaceResourceOrganization`

Organização pessoal do membro que fez esta requisição neste workspace. Tem `scope` definido como
`workspace`, `user_id`, `workspace_id`, `folders` e `favorites`; não é uma configuração
compartilhada com os outros membros. Veja as [alterações de pastas e favoritos](https://docs.vertracloud.app/pt-br/api-reference/endpoint/workspaces/resource-organization.md).

**Mostrar objeto**

**scope** `string`

Sempre `workspace` nesta resposta.

**user\_id** `string`

ID do membro que fez a requisição.

**workspace\_id** `string`

ID deste workspace.

**folders** `APIWorkspaceResourceFolder[]`

Pastas pessoais com `id`, `name`, `color`, `position`, `resources`, `created_at` e
`updated_at`. `color` é `neutral`, `red`, `orange`, `yellow`, `green`, `blue` ou `purple`.

**favorites** `APIWorkspaceFavorite[]`

Favoritos individuais com `resource_type` (`application` ou `database`), `resource_id`,
`position` e `created_at`.

### Erros

| Status | Código | Quando |
| - | - | - |
| 404 | `WORKSPACE_NOT_FOUND` | O workspace não existe, foi apagado de forma lógica ou você não é membro. |


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