Sign in

v1

latestOpenAPI 3.0.02026-08-06165119238.1 KB
Users

List users

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

get/v3/users

Query parameters

identifiers.email_addressstring required

Email address of the user to search for.

identifiers.usernamestring required

Username of the user to search for.

foreign_key.xxxstring required

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

searchstring required

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

slugstring

The user attribute slug

operator'is' | 'is_not' | 'contains' | 'does_not_contain' | 'starts_with' | 'ends_with' | 'has_any_value' | 'is_unknown' | 'checked' | 'unchecked'

The operation to apply to search filters for fields that are not of type Number, Range, or Date.

valueobject

The value assigned to the user attribute. Supported types include string, boolean, integer, and double.

fromobject

Used with Number, Range, or Date fields to specify the starting value of the search range.

toobject

Used with Number, Range, or Date fields to specify the ending value of the search range.

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

[
  {
    "slug": "subscriber-id",
    "operator": "is"
  }
]

Response

OK

Example response

{
  "results": [
    {
      "user_id": "123456789ABCD",
      "identifiers": {
        "email_address": "joe.blow@company.com"
      },
      "attributes": {
        "first_name": "Joe",
        "surname": "Blow"
      },
      "email_verified": true
    }
  ]
}