Skip to main content
GET
/
organizations
/
{organizationId}
/
invitations
Listar Convites
curl --request GET \
  --url https://api.example.com/organizations/{organizationId}/invitations \
  --header 'Authorization: <authorization>'
{
  "data": [
    {
      "invitationId": "inv_abc123",
      "organizationId": "019525fd-4c38-7e30-a5c1-b6e3f4d8a9c2",
      "inviterUserId": "019525fd-56a8-7db4-8c3e-2a1b4d6f8e0c",
      "acceptedUserId": null,
      "email": "jane@example.com",
      "token": "tok_invitation_xyz",
      "acceptInvitationUrl": "https://app.awsales.com/invite?token=tok_invitation_xyz",
      "roleSlug": null,
      "state": "PENDING",
      "expiresAt": "2026-04-25T14:00:00.000Z",
      "acceptedAt": null,
      "revokedAt": null,
      "createdAt": "2026-03-25T14:00:00.000Z",
      "updatedAt": "2026-03-25T14:00:00.000Z"
    }
  ],
  "meta": {
    "hasMore": false,
    "limit": 10
  }
}
Retorna uma lista de convites. 
curl "https://api.awsales.io/studio/organizations/ORG_ID/invitations?limit=20" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"
Requer permissao invitations:read.

​
Cabecalhos

​
Authorization
string
required
Token bearer.

​
Parametros de Rota

​
organizationId
string
required
O UUID da organizacao.

​
Parametros de Consulta

​
previousCursor
string
Cursor para a pagina anterior.
​
nextCursor
string
Cursor para a proxima pagina.
​
limit
integer
Numero de resultados por pagina.
​
email
string
Filtrar por endereco de email.

​
Resposta

​
data
array
Array de objetos de convite.
​
meta
object
Metadados de paginacao.
{
  "data": [
    {
      "invitationId": "inv_abc123",
      "organizationId": "019525fd-4c38-7e30-a5c1-b6e3f4d8a9c2",
      "inviterUserId": "019525fd-56a8-7db4-8c3e-2a1b4d6f8e0c",
      "acceptedUserId": null,
      "email": "jane@example.com",
      "token": "tok_invitation_xyz",
      "acceptInvitationUrl": "https://app.awsales.com/invite?token=tok_invitation_xyz",
      "roleSlug": null,
      "state": "PENDING",
      "expiresAt": "2026-04-25T14:00:00.000Z",
      "acceptedAt": null,
      "revokedAt": null,
      "createdAt": "2026-03-25T14:00:00.000Z",
      "updatedAt": "2026-03-25T14:00:00.000Z"
    }
  ],
  "meta": {
    "hasMore": false,
    "limit": 10
  }
}

​
Codigos de Erro

StatusCodigoDescricao
400validation_errorEntrada invalida ou campos obrigatorios ausentes
401unauthorizedAutenticacao ausente ou invalida
403forbiddenPermissoes insuficientes
404organization.not_foundOrganizacao nao encontrada
500internal_server_errorOcorreu um erro inesperado