GET
/
partner
/
users
curl --request GET \
  --url https://api.thanx.com/partner/users \
  --header 'Authorization: Bearer <token>'
{
  "users": [
    {
      "id": "wroeiu2304hfwf",
      "email": "john.smith@example.com",
      "phone": "+14158672345",
      "first_name": "Jane",
      "last_name": "Smith",
      "birth_date": {
        "year": 1987,
        "month": 8,
        "day": 14
      },
      "gender": "female",
      "zip_code": "12345"
    }
  ]
}

Scope required: users.read

The user’s phone number is not gathered by Thanx with the permission to use it for marketing.

Parameters

merchant_id
string
required

Filter by Merchant ID

email
string

Optionally filter by email. If there is a match, a single user record will be returned.

phone
string

Optionally filter by phone. If there is a match, a single user record will be returned. This value is expected to be in E.164 format.

Response

id
string

The user's identifier

email
string

The user's email

phone
string

The user's phone number, in E.164 format (eg. +14157582345)

first_name
string

The user's first name

last_name
string

The user's last name

birth_date
hash

The user's birthday information

gender
enum

The user's gender (male, female, other, unknown)

zip_code
string

The user's zip code