> ## 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 código de convite do workspace

> Gere um código de convite de uso único com GET /v2/workspaces/members/code e passe ao dono de um workspace, que adiciona você com ele. Expira em 5 minutos.

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

Gera um código de convite de curta duração vinculado à identidade do usuário autenticado, não a um workspace específico. Quem quer entrar compartilha esse código por fora da API (chat, e-mail) com o dono de um workspace, que então o envia via [Convidar membro](/pt-br/api-reference/endpoint/workspace/members/invite) junto com a função a ser concedida.

O código expira 5 minutos após ser gerado e é de uso único: é invalidado assim que resgatado. Solicite um novo caso ele expire antes de o dono adicionar você. Limitado a 1 código a cada 5 minutos por usuário.

## Resposta

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

<ResponseField name="code" type="string">
  Seu código de convite da equipe.
</ResponseField>

<ResponseExample>
  ```json theme={"system"}
  {
    "status": "success",
    "code": "9c1a499e623d2410226f1ecdc7e6daaec2fc6704"
  }
  ```
</ResponseExample>

## Erros comuns

| Código | HTTP | Significado |
| - | - | - |
| `INTERNAL_SERVER_ERROR` | 500 | O código de convite não pôde ser salvo no cache. |

## Relacionados

* CLI: [`squarecloud workspace member invite-code`](/pt-br/cli-reference/workspace-members#squarecloud-workspace-member-invite-code)
* SDKs: [`api.workspaces.members.inviteCode()`](/pt-br/sdks/js/workspaces) (JavaScript), [`client.workspaces.members.invite_code()`](/pt-br/sdks/py/workspaces) (Python), [`c.Workspaces.Members.InviteCode()`](/pt-br/sdks/go/workspaces) (Go)


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