List users

Retrieves a list of users wrapped in the element "results".

SecurityZephrHmacHttp
Request
query Parameters
identifiers.email_address
required
string

Email address of the user to search for.

Example: identifiers.email_address=example@example.com
identifiers.username
required
string

Username of the user to search for.

Example: identifiers.username=username
foreign_key.xxx
required
string

Foreign key of the user to search for. The foreign system is parsed as the remainder of the parameter key name following 'foreign_id.'

Example: foreign_key.xxx=123abc
search
required
string

Search parameter

Example: search=abc
Responses
200

OK

400

Bad Request

get/v3/users
Response samples
application/json
{
  • "results": [
    ]
}