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, and by tag (tag_id[], which matches users with any of the given tags). Users in the trash are excluded by default; set deleted=true to list only 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
1 <= value <= 200Response Body
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": "[email protected]", "external_id": "string", "id": "string", "name": "string", "object": "user", "phone": "string", "revision": "string", "status": "active", "tags": [ "string" ], "updated_at": "2019-08-24T14:15:22Z" } ]}Users
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`.