Skip to navigation
REST APIAuthentication and AuthorizationUsers

Get minimal user display information.

View as Markdown

Retrieve a list of users with minimal display information (id, username, firstName, lastName). At least one of search, id, or filterBy is required to scope the lookup. Requires the users-minimal:read permission.

Authentication

AuthorizationBearer
Bearer authentication

Query parameters

filterBylist of stringsOptional

Filter results by username. Use the format field-name operator value. Supported operators are == (exact match) and =@ (contains). Multiple entries (up to 25) are allowed only with the == operator.

searchstringOptional2-100 characters

Filter results by a free text search across username, firstName and lastName (OR logic). Minimum 2 characters.

idlist of stringsOptional

Bulk lookup by user IDs (comma-separated). Returns the matching users in addition to any results from search or filterBy. Up to 25 IDs per request.

limitintegerOptional1-500Defaults to 500
The maximum number of entries to return.

Response

Executed successfully.
idstring
The user's unique identifier.
usernamestring
The user's login name. Typically an email address.
firstNamestring or nullOptional<=255 characters
The user's first name.
lastNamestring or nullOptional<=255 characters
The user's last name.

Errors

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