Listar Convites

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_abc123",
      "acceptInvitationUrl": "https://app.awsales.com/invite?token=tok_abc123",
      "roleSlug": "member",
      "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": 20 }
}

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_abc123",
      "acceptInvitationUrl": "https://app.awsales.com/invite?token=tok_abc123",
      "roleSlug": "member",
      "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": 20 }
}

Requer permissao invitations:read.

Headers

Authorization

string

required

Bearer token.

Parametros de Path

organizationId

string

required

UUID da organizacao.

Parametros de Query

cursor

string

Cursor para paginacao.

limit

integer

Resultados por pagina.

string

Filtrar por email.

Resposta

data

array

Lista de convites.

Show propriedades do convite

invitationId

string

ID do convite.

organizationId

string

UUID da organizacao.

inviterUserId

string

ID do usuario que convidou.

acceptedUserId

string

ID do usuario que aceitou.

string

Email convidado.

token

string

Token do convite.

acceptInvitationUrl

string

URL para aceitar o convite.

roleSlug

string

Slug do papel.

state

string

Estado do convite.

expiresAt

string

Data de expiracao.

acceptedAt

string

Timestamp de aceitacao.

revokedAt

string

Timestamp de revogacao.

createdAt

string

Timestamp de criacao.

updatedAt

string

Timestamp da ultima atualizacao.

meta

object

Metadados de paginacao.

Show propriedades do meta

hasMore

boolean

Se ha mais resultados disponiveis.

limit

integer

Resultados por pagina.

{
  "data": [
    {
      "invitationId": "inv_abc123",
      "organizationId": "019525fd-4c38-7e30-a5c1-b6e3f4d8a9c2",
      "inviterUserId": "019525fd-56a8-7db4-8c3e-2a1b4d6f8e0c",
      "acceptedUserId": null,
      "email": "jane@example.com",
      "token": "tok_abc123",
      "acceptInvitationUrl": "https://app.awsales.com/invite?token=tok_abc123",
      "roleSlug": "member",
      "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": 20 }
}

Exemplos de Codigo

curl https://api.awsales.io/admin/organizations/019525fd-4c38-7e30-a5c1-b6e3f4d8a9c2/invitations?limit=20 \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Codigos de Erro

Status	Codigo	Descricao
`400`	`validation_error`	Entrada invalida ou campos obrigatorios ausentes
`401`	`unauthorized`	Autenticacao ausente ou invalida
`403`	`forbidden`	Permissoes insuficientes
`404`	`organization.not_found`	Organizacao nao encontrada
`500`	`internal_server_error`	Ocorreu um erro inesperado

O Objeto Convite

Enviar Convite

⌘I

Primeiros Passos

Auth & Identidade

Gestão de Acesso

Faturamento

Headers

Parametros de Path

Parametros de Query

Resposta

Exemplos de Codigo

Codigos de Erro

Primeiros Passos

Auth & Identidade

Gestão de Acesso

Faturamento

​Headers

​Parametros de Path

​Parametros de Query

​Resposta

​Exemplos de Codigo

​Codigos de Erro

Headers

Parametros de Path

Parametros de Query

Resposta

Exemplos de Codigo

Codigos de Erro