logo
UsersList users

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@company.com&limit=20&nextPageStartKey=example_string" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "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
}
GET
/users/v1/users
GET
Bearer Token
Bearer Tokenstring
Required

Bearer token from OAuth 2.0 client credentials. Format: Bearer {token}

Bearer token from OAuth 2.0 client credentials. Format: Bearer {token}
query
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
Required

Bearer token. Bearer token from OAuth 2.0 client credentials. Format: Bearer {token}

Query Parameters

emailstring

Filter by user email (exact match).

limitinteger

Maximum number of users per page. Min: 1, max: 100.

nextPageStartKeystring

Opaque pagination token from the previous response. Pass it back unchanged to fetch the next page.

Responses

dataarray
Required

List of users.

nextPageStartKeystring

Next page token. If absent, no more pages. Pass in nextPageStartKey.

limitinteger

Items per page.