get /users

Gets the user list.

Returns the list of users.

Query parameters

email (optional)
The email of the user to be used as a filter.
username (optional)
The username to use as a filter.
enabled (optional)
Indicates whether to retrieve the active users (true) or inactive users (false).
offset (optional)
The number of entries to skip. Default is 0.
limit (optional)
The maximum number of entries to return. Default is 50.
sort (optional)

A comma separated list of fields to be used for sorting the users. Allowed field values are "name" and "created". Fields can be prefixed by "+" and "-" to indicate, respectively, ascending and descending order. Default is -created.

Usage example: /users?sort=+name,-created

Return type

UserListResponse

Example data

Content-Type: application/json

{ "data" : { "totalItems" : 0, "offset" : 6, "limit" : 1, "items" : [ { "domainAccount" : "domainAccount", "subFolder" : "subFolder", "created" : "2000-01-23T04:56:07.000+00:00", "timezone" : "timezone", "jobTitle" : "jobTitle", "alternateEmail1" : "alternateEmail1", "description" : "description", "office" : "office", "userName" : "userName", "locale" : "en", "title" : "title", "enabled" : true, "folder" : "folder", "alternateEmail3" : "alternateEmail3", "lastUpdate" : "2000-01-23T04:56:07.000+00:00", "alternateEmail2" : "alternateEmail2", "nickname" : "nickname", "company" : "company", "id" : "00000000-0000-0000-0000-000000000000", "department" : "department", "email" : "email" }, { "domainAccount" : "domainAccount", "subFolder" : "subFolder", "created" : "2000-01-23T04:56:07.000+00:00", "timezone" : "timezone", "jobTitle" : "jobTitle", "alternateEmail1" : "alternateEmail1", "description" : "description", "office" : "office", "userName" : "userName", "locale" : "en", "title" : "title", "enabled" : true, "folder" : "folder", "alternateEmail3" : "alternateEmail3", "lastUpdate" : "2000-01-23T04:56:07.000+00:00", "alternateEmail2" : "alternateEmail2", "nickname" : "nickname", "company" : "company", "id" : "00000000-0000-0000-0000-000000000000", "department" : "department", "email" : "email" } ] } }

Responses

200
Success. A paginated list of users is returned.

400
The query string is malformed.