UsersList invites

List invites

Returns a paginated list of user invites, with optional filters for status and role.

Use nextPageStartKey to paginate.

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 "Signature-Input: example_string" \
  -H "Signature: example_string" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "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
}
GET
/users/v1/invites
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
statusstring

Filter by invite status.

Options: PENDING, EXCLUDED, EXPIRED
query
roleIdstring

Filter by the invite’s role ID.

Format: uuid
query
limitinteger

Maximum invites per page. Min: 1, max: 100. Default: 10.

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

statusstring

Filter by invite status.

Allowed values:PENDINGEXCLUDEDEXPIRED
roleIdstring

Filter by the invite’s role ID.

Example:
uuid-role-id
limitinteger

Maximum invites per page. Min: 1, max: 100. Default: 10.

Example:
10
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 invites.

nextPageStartKeystring

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

limitinteger

Items per page.