Member Status
Get User Status Data
API Documentation
Tokens
Member Status
Campaigns
Webhooks
Member Status
Get User Status Data
Endpoint to retrieve user basic data, as well as their linked partners and merchants
GET
/
users
/
{id}
curl --request GET \
--url https://userservice.withbenji.com/users/{id} \
--header 'Authorization: Bearer <token>'
{
"code": "ok",
"data": {
"user": {
"created_date": "2024-08-05T16:54:35.804289+00:00",
"email": "test@test.com",
"first_name": "Test",
"last_name": "User",
"id": 1,
"merchants": [
{
"created_date": "2024-08-23T19:46:01.684468+00:00",
"external_id": "7267281436852",
"id": 1,
"merchant_id": 1,
"total_rewards_earned": 266,
"total_rewards_redeemed": 0,
"user_id": 1
}
],
"partner_status_tiers": [
{
"created_date": "2024-08-05T17:31:43.002778+00:00",
"external_id": "123456789",
"id": 1,
"partner_id": 1,
"partner_status_tier_id": 1,
"total_rewards": 19700,
"total_rewards_earned": 0,
"total_rewards_redeemed": 0,
"user_id": 1
}
]
}
}
}
The Bearer token to be used on this API is a user based access token
The Benji Platform ID of the user
Return values
A user object property
Benji Platform user identifier
The user’s first name
The user’s last name
An array of merchants that the user is connected to
The ID of the merchant partner in the Benji Platform
The ID of the user in the Benji Platform
The user’s id on the specific merchant
The total amount of merchant specific rewards earned on the Benji Platform
The total amount of merchant specific rewards redeemed on the Benji Platform
The date this user was associated to the merchant partner on the Benji platform
An array of user partner status tier objects
The ID of the partner in the Benji Platform
The ID of the partner status tier in the Benji Platform
The ID of the user in the Benji Platform
The user’s loyalty program identifier
The current rewards amount in the uer’s account, regardless of Benji originated transactions
The total amount of partner specific rewards earned on the Benji Platform
The total amount of partner specific rewards redeemed on the Benji Platform
The date this user was associated to the loyalty partner on the Benji platform
{
"code": "ok",
"data": {
"user": {
"created_date": "2024-08-05T16:54:35.804289+00:00",
"email": "test@test.com",
"first_name": "Test",
"last_name": "User",
"id": 1,
"merchants": [
{
"created_date": "2024-08-23T19:46:01.684468+00:00",
"external_id": "7267281436852",
"id": 1,
"merchant_id": 1,
"total_rewards_earned": 266,
"total_rewards_redeemed": 0,
"user_id": 1
}
],
"partner_status_tiers": [
{
"created_date": "2024-08-05T17:31:43.002778+00:00",
"external_id": "123456789",
"id": 1,
"partner_id": 1,
"partner_status_tier_id": 1,
"total_rewards": 19700,
"total_rewards_earned": 0,
"total_rewards_redeemed": 0,
"user_id": 1
}
]
}
}
}
Note that you will only receive data that you as a loyalty patner or merchant partner are allowed to see based on the permissions in the access token you provide to the API
Was this page helpful?
curl --request GET \
--url https://userservice.withbenji.com/users/{id} \
--header 'Authorization: Bearer <token>'
{
"code": "ok",
"data": {
"user": {
"created_date": "2024-08-05T16:54:35.804289+00:00",
"email": "test@test.com",
"first_name": "Test",
"last_name": "User",
"id": 1,
"merchants": [
{
"created_date": "2024-08-23T19:46:01.684468+00:00",
"external_id": "7267281436852",
"id": 1,
"merchant_id": 1,
"total_rewards_earned": 266,
"total_rewards_redeemed": 0,
"user_id": 1
}
],
"partner_status_tiers": [
{
"created_date": "2024-08-05T17:31:43.002778+00:00",
"external_id": "123456789",
"id": 1,
"partner_id": 1,
"partner_status_tier_id": 1,
"total_rewards": 19700,
"total_rewards_earned": 0,
"total_rewards_redeemed": 0,
"user_id": 1
}
]
}
}
}