Skip to navigation
REST APIAuthentication and AuthorizationUsers

Get users.

View as Markdown
Retrieve a list of platform users.

Authentication

AuthorizationBearer
Bearer authentication

Query parameters

filterBylist of stringsOptional

Filter results by a parameter. Use the format field-name operator value. Operators are <= Less than or equal, >= Greater than or equal, =@ contains. Dates are in ISO 8601 timestamp format and available for operators <=, >= and ==.

sortByenumOptional
Sort results by a parameters.
sortOrderenumOptionalDefaults to asc
Sort results in descending or ascending order.
Allowed values:
offsetintegerOptional
The offset of the first item returned in the collection.
limitintegerOptional1-500Defaults to 500
The maximum number of entries to return.
searchstringOptional
Filter results by a free text search.

Response

Executed successfully.
idstring
usernamestring
createdBystring
createdAtdatetime or null
updatedAtdatetime or null
lastLogindatetime or null
isLocalboolean or null
groupslist of strings or nullOptional
firstNamestringOptional<=255 characters
lastNamestringOptional<=255 characters

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
500
Internal Server Error
503
Service Unavailable Error