Developers

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.

38 operations.

OperationSummary
GET /usersList users
POST /usersCreate a user
GET /users/{user_id}Retrieve a user
PATCH /users/{user_id}Update a user
DELETE /users/{user_id}Delete a user
PATCH /users/{user_id}/accessUpdate access duration for all products
POST /users/{user_id}/access-emailsSend an access email
GET /users/{user_id}/activityList user activity
GET /users/{user_id}/attributionRetrieve user attribution
PUT /users/{user_id}/attributionUpdate user attribution
PUT /users/{user_id}/avatarUpdate a user avatar
DELETE /users/{user_id}/avatarDelete a user avatar
GET /users/{user_id}/custom-fieldsList user custom field values
PUT /users/{user_id}/custom-fieldsUpdate user custom field values
DELETE /users/{user_id}/custom-fields/{custom_field_id}Delete a custom field value
GET /users/{user_id}/notesList user notes
POST /users/{user_id}/notesCreate a user note
GET /users/{user_id}/notes/{note_id}Retrieve a user note
PATCH /users/{user_id}/notes/{note_id}Update a user note
DELETE /users/{user_id}/notes/{note_id}Delete a user note
POST /users/{user_id}/password-reset-emailsSend a password reset email
GET /users/{user_id}/productsList product access
GET /users/{user_id}/products/{product_id}/accessRetrieve product access
PATCH /users/{user_id}/products/{product_id}/accessUpdate product access
GET /users/{user_id}/products/{product_id}/access/calendarRetrieve a release calendar
GET /users/{user_id}/products/{product_id}/progressRetrieve product progress
GET /users/{user_id}/products/{product_id}/progress/adjustmentsList progress adjustments
POST /users/{user_id}/products/{product_id}/progress/adjustmentsCreate a progress adjustment
GET /users/{user_id}/products/{product_id}/progress/adjustments/{adjustment_id}Retrieve a progress adjustment
GET /users/{user_id}/products/{product_id}/progress/lessonsList lesson progress
GET /users/{user_id}/progressList user progress
POST /users/{user_id}/score-adjustmentsCreate a points adjustment
GET /users/{user_id}/scoresList point entries
GET /users/{user_id}/scores/{score_id}Retrieve a point entry
GET /users/{user_id}/tagsList user tags
PUT /users/{user_id}/tagsReplace user tags
POST /users/{user_id}/tags/{tag_id}Assign a tag
DELETE /users/{user_id}/tags/{tag_id}Remove a tag

OpenAPI

Previous Page

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`, 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.