API Reference

user.list

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

Get a list of all Ashby users.

See the Pagination and Incremental Synchronization guide for detailed usage examples.

Requires the organizationRead permission.

The globalRole property in the response specifies the user's access level in Ashby. For more details on the permissions granted with each role, see our documentation here.

Body Params
string

Opaque cursor indicating which page of results to fetch

string

An opaque token representing the last time the data was successfully synced from the API. A new, updated one is returned after successfully fetching the last page of data.

number

The maximum number of items to return. The maximum and default value is 100.

boolean
Defaults to false

If set to true, deactivated users are included in the response. By default, deactivated users are not included.

Response

Updated 3 months ago

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