Developers
Users38

Create a user

POST/users

Creates a user. Tags and custom field values supplied in the request are applied to the new user.

The Location header of the response contains the URL of the new user.

If another user in the account already has the same email address or external_id, the API returns already_exists. If the account has reached the user limit of its plan, the API returns plan_limit_reached.

Authorization

AuthorizationBearer <token>

Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.

In: header

Header Parameters

Idempotency-Key*string

Client-generated key that makes the request safe to retry. Must be 1 to 128 characters from [A-Za-z0-9._:-]. Required by this operation: a missing key returns idempotency_key_required, and a malformed key returns idempotency_key_invalid. Repeating the request with the same key and the same body returns the stored result with Idempotent-Replayed: true.

X-Client-Request-Id?string

Optional client-generated identifier of the request, up to 64 characters from [A-Za-z0-9._-]. Echoed back in the response and recorded in the request log; it never replaces the server-generated X-Request-Id.

Lengthlength <= 64

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/users" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "email": "user@example.com",    "name": "string"  }'
{  "data": {    "access": "granted",    "created_at": "2019-08-24T14:15:22Z",    "deleted": true,    "document": "string",    "email": "user@example.com",    "external_id": "string",    "id": "string",    "name": "string",    "object": "user",    "phone": "string",    "revision": "string",    "status": "active",    "tags": [      "string"    ],    "updated_at": "2019-08-24T14:15:22Z"  }}

List users GET

Returns the users of the account, using cursor-based pagination. The collection can be filtered by a search term matched against name and email (`q`), by `external_id`, by tag (`tag_id[]`, which matches users with any of the given tags), by `status` (`active` means the user accessed the platform in the last 30 days), by `access` (the same value returned in each user), and by creation date range (`created_after`, `created_before`). Users in the trash are excluded by default; set `deleted=true` to list only users in the trash. Filtering by `access=none` without `deleted` lists the users in the trash. The `document` and `phone` fields are returned only when the credentials have the `users.read_personal` permission.

Retrieve a user GET

Retrieves a user by public ID, including the user's tags and current `revision`. The response includes an `ETag` representing the current revision. Send this value in the `If-Match` header when updating the user to avoid overwriting a newer version. The `document` and `phone` fields are returned only when the credentials have the `users.read_personal` permission; otherwise, they are omitted.