Users

Get All Users

Get all users managed by the current API key

get/users

Query parameters

querystring

Filter by first name, last name or email, e.g. 'tom@gmail.com'

maxinteger

Maximum number of users to display.

offsetinteger

Offset for pagination.

sortstring

Sorting criteria for result list.

orderstring

Sort the order of the result list asc or desc

locationIdinteger

Id of a location the users must have administration rights to.

identifierstring

Only return users with this identifier.

rolestring[]

Only return users with one of the given roles. Multiple values are OR-joined and may be sent either as repeated params or comma separated. A blank value counts as not sent. Unknown and non-selectable values are dropped; if the param was sent and no value remains, the response is an empty list with count 0 rather than an unfiltered one.

statusstring[]

Only return users with one of the given statuses. Multiple values are OR-joined and may be sent either as repeated params or comma separated. A blank value counts as not sent. Unknown and non-selectable values are dropped; if the param was sent and no value remains, the response is an empty list with count 0 rather than an unfiltered one.

Response

Successfully retrieved list

Changes