Skip to navigation
SDK Referenceuser

List users

Authentication

AuthorizationApi-Key

Type "Api-Key" followed by a space and the project API key.

Query parameters

limitintegerOptional
Page size
cursorstringOptional
Opaque page cursor
order_byenumOptional
Sort field
Allowed values:
orderenumOptional
asc or desc
Allowed values:

Request

Request body
searchstringOptional
Filters results to users whose user ID, email, or name contains this text.

Response

OK
itemslist of objectsOptional
The users on this page.
next_cursorstringOptional

The cursor to pass as the next request's cursor to fetch the following page; absent when no further pages remain.

total_sizeintegerOptional
The total number of matching users, counted at the time of this response. It does not indicate whether more pages remain.

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error