User Search

Search for users

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

See the search filtering documentation for details about the query syntax. The searchable attributes and the operators each one accepts are listed in the request body below.

User-specific notes

  • contact takes a contact search filter with any, not a plain reference:
    { "contact": { "any": { "contact": { "equal": "/v1/contacts/1000" } } } }
    { "contact": { "any": { "last_name": { "equal": "Smith" } } } }
  • login is the email address the user signs in with:
    { "login": { "ends_with": "@example.com" } }
  • user_id matches users by numeric ID, e.g. { "user_id": { "any": [1000, 3000] } }.
Query Params
int32
≤ 250
Defaults to 50

Maximum number of results per page (max 250). Defaults to 50, or 10 when full-records is true.

boolean

Return every attribute of each result instead of the short list form.

int32

Return results whose ID is greater than or equal to this value. Use the next URL from the previous page rather than building this yourself.

Body Params
login
object

Login email address, e.g. {"ends_with": "@example.com"}

is_active
object

Example: true

contact
object

The user's own contact record. The operand is a contact search filter, e.g. {"any": {"contact": {"equal": "/v1/contacts/1000"}}} or {"any": {"last_name": {"equal": "Smith"}}}.

user_id
object

The user's numeric ID

Responses

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