v1

latestOpenAPI 3.1.0raw.githubusercontent.com2024-09-27192307552.2 KB
users

List Users

Returns a list of all users.

Args: user_filter_model: Model that takes care of filtering, sorting and pagination. hydrate: Flag deciding whether to hydrate the output model(s) by including metadata fields in the response. auth_context: Authentication context.

Returns: A list of all users.

get/api/v1/users

Query parameters

hydrateboolean
sort_bystring
logical_operator'or' | 'and'

Logical Ops to use to combine filters on list methods.

pageinteger
sizeinteger
string uuid
OR
string
string date-time
OR
string
string date-time
OR
string
namestring nullable
full_namestring nullable
emailstring nullable
boolean
OR
string
boolean
OR
string
string uuid
OR
string

Response

Successful Response

indexinteger required
max_sizeinteger required
total_pagesinteger required
totalinteger required