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"
import requests
import json
url = "https://api-sandbox.contasimples.com/users/v1/invites?status=PENDING&roleId=uuid-role-id&limit=10&nextPageStartKey=example_string"
headers = {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())
const response = await fetch("https://api-sandbox.contasimples.com/users/v1/invites?status=PENDING&roleId=uuid-role-id&limit=10&nextPageStartKey=example_string", {
method: "GET",
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN"
}
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
)
func main() {
req, err := http.NewRequest("GET", "https://api-sandbox.contasimples.com/users/v1/invites?status=PENDING&roleId=uuid-role-id&limit=10&nextPageStartKey=example_string", nil)
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
fmt.Println("Response Status:", resp.Status)
}
require 'net/http'
require 'json'
uri = URI('https://api-sandbox.contasimples.com/users/v1/invites?status=PENDING&roleId=uuid-role-id&limit=10&nextPageStartKey=example_string')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Get.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN'
response = http.request(request)
puts response.body
{
"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
}
{
"error": "Bad Request",
"message": "The request contains invalid parameters or malformed data",
"code": 400,
"details": [
{
"field": "email",
"message": "Invalid email format"
}
]
}
{
"error": "Unauthorized",
"message": "Authentication required. Please provide a valid API token",
"code": 401
}
{
"error": "Internal Server Error",
"message": "An unexpected error occurred on the server",
"code": 500,
"requestId": "req_1234567890"
}
/users/v1/invites
Token Bearer obtido via OAuth 2.0 Client Credentials. Formato: Bearer {token}
Bearer {token}Filtro por status do convite.
Filtro por ID do papel (role) atribuído ao convite.
Número máximo de convites por página. Mínimo: 1, Máximo: 100. Padrão: 10.
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
Bearer token. Token Bearer obtido via OAuth 2.0 Client Credentials. Formato: Bearer \{token\}
Query Parameters
Filtro por ID do papel (role) atribuído ao convite.
Número máximo de convites por página. Mínimo: 1, Máximo: 100. Padrão: 10.
Token opaco de paginação retornado na resposta anterior. Use exatamente como recebido para obter a próxima página.
Responses
Lista de convites.
Identificador único do convite. Utilize este ID no fluxo de criação de usuário por convite.
E-mail do usuário convidado.
Papel (role) atribuído ao convite.
Identificador único do papel.
Data e hora de expiração do convite (ISO 8601).
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.
Número de itens por página.
Requisição inválida. Verifique os parâmetros enviados.
Não autorizado. Token ausente, inválido ou expirado.
Erro interno do servidor. Tente novamente com retry e backoff exponencial.
Last updated today
Built with Documentation.AI