List users
Returns a paginated list of company users, with an optional email filter.
Use nextPageStartKey to paginate.
curl -X GET "https://api-sandbox.contasimples.com/users/v1/users?email=user%40company.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%40company.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%40company.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%40company.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%40company.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": "John Silva",
"phone": "11999999999",
"role": {
"id": "example_string",
"name": "Accountant"
},
"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": "Not Found",
"message": "The requested resource was not found",
"code": 404
}
{
"error": "Internal Server Error",
"message": "An unexpected error occurred on the server",
"code": 500,
"requestId": "req_1234567890"
}
GET
/users/v1/users
GET
Base URLstring
Target server for requests. Edit to use your own host.
Bearer Token
Bearer Tokenstring
RequiredBearer token from OAuth 2.0 client credentials. Format: Bearer TOKEN
Bearer token from OAuth 2.0 client credentials. Format:
Bearer TOKENquery
emailstring
Filter by user email (exact match).
query
limitinteger
Maximum number of users per page. Min: 1, max: 100.
Min: 1 • Max: 100
query
nextPageStartKeystring
Opaque pagination token from the previous response. Pass it back unchanged to fetch the next page.
Request Preview
Response
Response will appear here after sending the request
Authentication
header
Authorizationstring
RequiredBearer token. Bearer token from OAuth 2.0 client credentials. Format: Bearer TOKEN
Query Parameters
nextPageStartKeystring
Opaque pagination token from the previous response. Pass it back unchanged to fetch the next page.
Responses
dataarray
RequiredList of users.
nextPageStartKeystring
Next page token. If absent, no more pages. Pass in nextPageStartKey.
limitinteger
Items per page.
Was this page helpful?