Skip to main content
Um convite representa uma solicitacao pendente para um usuario entrar em uma organizacao. Convites sao enviados via email e incluem um token unico e uma URL de aceitacao. Eles progridem por um ciclo de vida: PENDING (aguardando aceitacao), ACCEPTED (usuario entrou), EXPIRED (passou da data de expiracao) ou REVOKED (cancelado manualmente). Voce encontrara objetos de convite ao gerenciar onboarding de equipe ou auditar quem foi convidado.
​
invitationId
string
O identificador unico do convite.
​
organizationId
string
O ID da organizacao (UUIDv7) a qual o convite pertence.
​
inviterUserId
string
O ID do usuario (UUIDv7) do membro que enviou o convite.
​
acceptedUserId
string|null
O ID do usuario (UUIDv7) do membro que aceitou o convite. null se ainda nao foi aceito.
​
email
string
O endereco de email do usuario convidado.
​
token
string
O token unico associado ao convite.
​
acceptInvitationUrl
string
A URL que o usuario convidado pode usar para aceitar o convite.
​
roleSlug
string|null
O slug do role atribuido na aceitacao. null se nao especificado.
​
state
string
O estado do convite. Um de: PENDING, ACCEPTED, EXPIRED, REVOKED.
​
expiresAt
string
Timestamp de expiracao (ISO 8601).
​
acceptedAt
string|null
Timestamp de quando o convite foi aceito (ISO 8601). null se ainda nao foi aceito.
​
revokedAt
string|null
Timestamp de quando o convite foi revogado (ISO 8601). null se nao foi revogado.
​
createdAt
string
Timestamp de criacao (ISO 8601).
​
updatedAt
string
Timestamp da ultima atualizacao (ISO 8601).
{
  "invitationId": "inv_01HQZD4K7M3NX9P2RTYW6JBHF5",
  "organizationId": "019525fd-4c38-7e30-a5c1-b6e3f4d8a9c2",
  "inviterUserId": "019525fd-56a8-7db4-8c3e-2a1b4d6f8e0c",
  "acceptedUserId": null,
  "email": "jane.doe@example.com",
  "token": "tok_8f14e45f-ceea-467f-a123-456789abcdef",
  "acceptInvitationUrl": "https://app.example.com/invitations/accept?token=tok_8f14e45f-ceea-467f-a123-456789abcdef",
  "roleSlug": null,
  "state": "PENDING",
  "expiresAt": "2026-02-15T10:00:00.000Z",
  "acceptedAt": null,
  "revokedAt": null,
  "createdAt": "2026-01-15T10:00:00.000Z",
  "updatedAt": "2026-01-15T10:00:00.000Z"
}