logo
UsuáriosListar Convites

Listar Convites

Retorna a lista paginada de convites de usuários da empresa, com filtros opcionais por status e papel (role).

Use nextPageStartKey para navegar entre páginas (paginação por cursor).

curl -X GET "https://api-sandbox.contasimples.com/users/v1/invites?status=PENDING&roleId=uuid-role-id&limit=10&nextPageStartKey=example_string" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "data": [
    {
      "id": "uuid-invite-id",
      "email": "user@company.com",
      "role": {
        "id": "uuid-role-id"
      },
      "expiresAt": "2025-12-31T23:59:59.000Z"
    }
  ],
  "nextPageStartKey": "example_string",
  "limit": 10
}
GET
/users/v1/invites
GET
Bearer Token
Bearer Tokenstring
Required

Token Bearer obtido via OAuth 2.0 Client Credentials. Formato: Bearer {token}

Token Bearer obtido via OAuth 2.0 Client Credentials. Formato: Bearer {token}
query
statusstring

Filtro por status do convite.

Options: PENDING, EXCLUDED, EXPIRED
query
roleIdstring

Filtro por ID do papel (role) atribuído ao convite.

Format: uuid
query
limitinteger

Número máximo de convites por página. Mínimo: 1, Máximo: 100. Padrão: 10.

Min: 1 • Max: 100
query
nextPageStartKeystring

Token opaco de paginação retornado na resposta anterior. Use exatamente como recebido para obter a próxima página.

Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. Token Bearer obtido via OAuth 2.0 Client Credentials. Formato: Bearer \{token\}

Query Parameters

statusstring

Filtro por status do convite.

Allowed values:PENDINGEXCLUDEDEXPIRED
roleIdstring

Filtro por ID do papel (role) atribuído ao convite.

limitinteger

Número máximo de convites por página. Mínimo: 1, Máximo: 100. Padrão: 10.

nextPageStartKeystring

Token opaco de paginação retornado na resposta anterior. Use exatamente como recebido para obter a próxima página.

Responses

dataarray
Required

Lista de convites.

nextPageStartKeystring

Token opaco para a próxima página. Se ausente, não há mais páginas. Use este valor no parâmetro nextPageStartKey da próxima requisição.

limitinteger

Número de itens por página.