Listar Usuários
Retorna a lista paginada de usuários da empresa, com filtro opcional por e-mail.
Use nextPageStartKey para navegar entre páginas (paginação por cursor).
curl -X GET "https://api-sandbox.contasimples.com/users/v1/users?email=user@company.com&limit=20&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/users?email=user@company.com&limit=20&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/users?email=user@company.com&limit=20&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/users?email=user@company.com&limit=20&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/users?email=user@company.com&limit=20&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": "example_string",
"email": "user@company.com",
"name": "João Silva",
"phone": "11999999999",
"role": {
"id": "example_string",
"name": "Contador(a)"
},
"active": true
}
],
"nextPageStartKey": "example_string",
"limit": 20
}
{
"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/users
Token Bearer obtido via OAuth 2.0 Client Credentials. Formato: Bearer {token}
Bearer {token}Filtro por e-mail do usuário (correspondência exata).
Número máximo de usuários por página. Mínimo: 1, Máximo: 100.
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 e-mail do usuário (correspondência exata).
Número máximo de usuários por página. Mínimo: 1, Máximo: 100.
Token opaco de paginação retornado na resposta anterior. Use exatamente como recebido para obter a próxima página.
Responses
Lista de usuários.
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.
Last updated today
Built with Documentation.AI