> ## 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 espaço de trabalho

> Obter informações do espaço de trabalho.

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

### Parâmetros

<ParamField path="workspaceId" type="string" placeholder="ID do Espaço de Trabalho">
  O ID do espaço de trabalho.
</ParamField>

### Resposta

<ResponseField name="status" type="string">
  Indica se a chamada foi bem-sucedida. `success` se bem-sucedida, `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 Espaço de Trabalho.
    </ResponseField>

    <ResponseField name="owner" type="string">
      O ID do proprietário do Espaço de Trabalho.
    </ResponseField>

    <ResponseField name="name" type="string">
      O nome do Espaço de Trabalho.
    </ResponseField>

    <ResponseField name="members" type="object">
      A lista de membros do espaço de trabalho.

      <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.
        </ResponseField>

        <ResponseField name="group" type="string">
          As permissões do membro nas aplicações do espaço de trabalho.
        </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 espaço de trabalho.

      <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={null}
  {
    "status": "success",
    "response": {
      "id": "dcedcd13d7e272a7b32a70f6a1d180f23c12d759",
      "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>