Users
Get Users
This endpoint will return all the users of the specified merchant.
GET
/partner/users
Bearer*
curl --request GET \
--url https://api.thanx.com/partner/users \
--header 'Authorization: Bearer <token>'
Scope required: users.read
The user’s phone number is not gathered by Thanx with the permission to use it for marketing.
Parameters
merchant_idrequired
string
Filter by Merchant ID
email
string
Optionally filter by email. If there is a match, a single user record will be returned.
Response
id
string
The user’s identifier
email
string
The user’s email
phone
string
The user’s phone number, formatted: +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
{
"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"
}
]
}
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"
}
]
}