GET
/
partner
/
users
curl https://api.thanxsandbox.com/partner/users \
  -X GET \
  -H 'X-ClientId: {client_id}' \
  -H 'Accept-Version: v4.0' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access_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
      },
      "zip_code": "12345",
      "updated_at": "2025-02-01T19:00:00Z",
      "loyalty": {
        "tier": "silver",
        "points_balance": 120.50,
        "user_joined_at": "2023-12-01T19:00:00Z"
      },
      "communication_settings": {
        "marketing_general_email": true
      }
    }
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 10,
    "total_pages":  1
  }
}
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.
​
updated_after
datetime
Optionally filter by records updated after specified updated_after timestamp.
​
updated_before
datetime
Optionally filter by records updated before specified updated_before timestamp.
​
include_loyalty_attributes
boolean
Optionally include loyalty attributes in response. Defaults to false.
​
include_communication_settings
boolean
Optionally include communication setting attributes in response. Defaults to false.
​
page
integer
The current page of paginated resources.
  • Default: 1.
​
per_page
integer
Number of records to be returned per API request.
  • Default: 10
  • Minimum: 1
  • Maximum: 100

​
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
​
zip_code
string
The user's zip code
​
updated_at
datetime
Datetime the user record was last updated.
​
loyalty
hash
​
communication_settings
hash
curl https://api.thanxsandbox.com/partner/users \
  -X GET \
  -H 'X-ClientId: {client_id}' \
  -H 'Accept-Version: v4.0' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access_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
      },
      "zip_code": "12345",
      "updated_at": "2025-02-01T19:00:00Z",
      "loyalty": {
        "tier": "silver",
        "points_balance": 120.50,
        "user_joined_at": "2023-12-01T19:00:00Z"
      },
      "communication_settings": {
        "marketing_general_email": true
      }
    }
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 10,
    "total_pages":  1
  }
}