Search for Users

Given a search term that is at least 3 characters long, this endpoint will return users that are an exact match of either the userId or the correlationId or a substring/fuzzy match on the name. It will return the results in descending order of when the user was initially created. If the search term is empty or no results are found then the response body will also return no results under the users field. The response will include a maximum of 20 users.

Unlike the v1 search endpoint, the response does not include a dataOrigin field.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required

This query parameter can be used as a search term to exactly match either userId, correlationId or name.

Responses

400

Search query is missing or shorter than 3 characters.

401

API key authentication unsuccessful.

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json