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%40company.com&limit=20&nextPageStartKey=example_string" \
  -H "Content-Type: application/json" \
  -H "Signature-Input: example_string" \
  -H "Signature: example_string" \
  -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
Base URLstring

Target server for requests. Edit to use your own host.

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.

header
Signature-Inputstring

What was signed and the signature parameters, in the RFC 9421 format. A credential with a public key must send it on every call, reads included, or the request is refused with 401. The signature covers the @method, @path, and @query components, and also content-digest when there is a body. created and alg are required, and created is valid for 300 seconds. The full format, with examples, is in Request Signing.

header
Signaturestring

The signature of the base defined by RFC 9421, in base64, between : and under the same label used in Signature-Input, for example sig=:SGVsbG8gd29ybGQ=:. It always goes together with Signature-Input.

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).

Example:
user@company.com
limitinteger

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

Example:
20
nextPageStartKeystring

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

Headers

Signature-Inputstring

What was signed and the signature parameters, in the RFC 9421 format. A credential with a public key must send it on every call, reads included, or the request is refused with 401. The signature covers the @method, @path, and @query components, and also content-digest when there is a body. created and alg are required, and created is valid for 300 seconds. The full format, with examples, is in Request Signing.

Signaturestring

The signature of the base defined by RFC 9421, in base64, between : and under the same label used in Signature-Input, for example sig=:SGVsbG8gd29ybGQ=:. It always goes together with Signature-Input.

Responses

dataarray
Required

List of users.

nextPageStartKeystring

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

limitinteger

Items per page.