v47

latestOpenAPI 3.0.3Apache 2.0raw.githubusercontent.com2024-10-01163166522.3 KB

Users

List users

List out all users. The users are sorted by creation date, with the most recently-created users coming first

get/v1/user

Query parameters

limitinteger nullable

Limit the number of objects to return

starting_afterstring uuid

Pagination cursor id.

For example, if the final item in the last page you fetched had an id of foo, pass starting_after=foo to fetch the next page. Note: you may only pass one of starting_after and ending_before

Pagination cursor id.

For example, if the final item in the last page you fetched had an id of foo, pass starting_after=foo to fetch the next page. Note: you may only pass one of starting_after and ending_before

ending_beforestring uuid

Pagination cursor id.

For example, if the initial item in the last page you fetched had an id of foo, pass ending_before=foo to fetch the previous page. Note: you may only pass one of starting_after and ending_before

Pagination cursor id.

For example, if the initial item in the last page you fetched had an id of foo, pass ending_before=foo to fetch the previous page. Note: you may only pass one of starting_after and ending_before

string uuid

string[]

Filter search results to a particular set of object IDs. To specify a list of IDs, include the query param multiple times

string

string[]

Given name of the user to search for. You may pass the param multiple times to filter for more than one given name

string

string[]

Family name of the user to search for. You may pass the param multiple times to filter for more than one family name

string

string[]

Email of the user to search for. You may pass the param multiple times to filter for more than one email

org_namestring

Filter search results to within a particular organization

Response

Returns a list of user objects