Skip to content
Admin API reference
/
v4 API
/
/
List users

List users

Request

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

Security
ZephrHmacHttp
Query
identifiers.email_addressstringrequired

Email address of the user to search for.

Example:identifiers.email_address=example@example.com
identifiers.usernamestringrequired

Username of the user to search for.

Example:identifiers.username=username
foreign_key.xxxstringrequired

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
searchstringrequired

Performs a general search for the specified value across multiple fields, including attributes.

Example:search=abc
search_by_attributesArray of objects(search_by_attributes)

Several attribute filters can be specified to search for users with particular attributes. It needs to be Base64 and URL encoded.

cURL
curl -i -X GET \
  'https://demo.api.zephr.com/v3/users?identifiers.email_address=example%40example.com&identifiers.username=username&foreign_key.xxx=123abc&search=abc&search_by_attributes=%5Bobject%20Object%5D' \
  -H 'Authorization: ZEPHR-HMAC-* <YOUR_TOKEN_HERE>'

Responses

OK

Headers
any
Bodyapplication/json
resultsArray of objects(user-response)
Response
{
  "results": [
    { … }
  ]
}