List users
/usersReturns 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.
Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.
In: header
Query Parameters
Maximum number of items to return, from 1 to 200.
1 <= value <= 200Cursor for the next page, taken from page.next_cursor of the previous response.
Text search term.
Only users with this external ID.
When true, returns only items in the trash. Items in the trash are excluded by default.
Only users with any of these tags, by public ID. Repeat the parameter to send several tags.
Only users with this activity status. active means the user accessed the platform in the last 30 days.
Value in
- "active"
- "inactive"
Only users with this access state.
Value in
- "granted"
- "none"
Only items created after this date and time (ISO 8601).
date-timeOnly items created before this date and time (ISO 8601).
date-timeHeader Parameters
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.
length <= 64Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/users"{ "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" } ], "page": { "limit": 1, "next_cursor": "string", "prev_cursor": "string" }}Users38
Users in API v3: list users, create a user, retrieve a user, update a user, delete a user, update access duration for all products, send an access email, list user activity, retrieve user attribution, update user attribution, update a user avatar, delete a user avatar, list user custom field values, update user custom field values, delete a custom field value, list user notes, create a user note, retrieve a user note, update a user note, delete a user note, send a password reset email, list product access, retrieve product access, update product access, retrieve a release calendar, retrieve product progress, list progress adjustments, create a progress adjustment, retrieve a progress adjustment, list lesson progress, list user progress, create a points adjustment, list point entries, retrieve a point entry, list user tags, replace user tags, assign a tag, remove a tag.
Create a user POST
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`.