latestOpenAPI 3.0.02026-08-066425196.1 KB
cafec81df996
Accounts
Get public account data directly from the database
Provide any combination of the parameters below to return all users that match this criteria. Use asterisks for wildcards. Values are NOT case sensitive.
get/users
Query parameters
userIdstring
User id of the user account.
emailstring
Email address of the user account.
userNamestring
Username of the user account.
fullNamestring
Full name of the user account.
rolestring
Role of the user account.
status'active' | 'deactivated'
Status of the user account.
limitinteger
Number of records to be returned on a page. Defaults to 5.
pageinteger
Page number of records to display. Defaults to 1.
sortColstring
Column name to sort the results by. Optional.
sortOrder'asc' | 'desc'
Sort order, ascending or descending. Defaults to "asc" if not specified.
Response
A body of response data containing user records from the database that match search criteria.