API Reference

user.list

post
https://api.ashbyhq.com/user.list

Lists all users in the organization with pagination support.

By default, only active (enabled) users are returned. Use includeDeactivated: true to include deactivated users.

Supports incremental sync via syncToken to efficiently retrieve only users updated since the last sync.

Requires the organizationRead permission.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
boolean

Whether to include deactivated users in the results. Defaults to false.

The pagination cursor. Use 'start' for the first page or the nextCursor value from a previous response.

integer
≤ 100

The maximum number of users to return per page. Maximum is 100.

A sync token to retrieve only users updated since the last sync. Obtained from a previous list response.

Response

Updated about 1 month ago

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago