Get User
curl --request GET \
--url https://api-staging.withbenji.com/users/{id} \
--header 'x-api-key: <api-key>'{
"code": "ok",
"data": {
"user": {
"created_date": "2026-02-08T00:13:59.970754+00:00",
"email": "test@test.com",
"external_id": null,
"first_name": "Test",
"id": 155,
"last_name": "User",
"merchants": [
{
"created_date": "2026-02-09T14:50:17.198641+00:00",
"external_id": "4731354127758848",
"id": 196,
"merchant_id": 85,
"total_rewards_earned": 0,
"total_rewards_redeemed": 0,
"user_id": 155
},
{
"created_date": "2026-02-11T18:08:18.532675+00:00",
"external_id": "daae5365-c895-48bf-bc23-a9861a351e04",
"id": 215,
"merchant_id": 93,
"total_rewards_earned": 3327,
"total_rewards_redeemed": 0,
"user_id": 155
}
],
"partner_status_tiers": [
{
"created_date": "2026-02-08T00:16:10.255945+00:00",
"external_id": "4731354127758848",
"first_name": "Test",
"id": 287,
"last_name": "User",
"partner_id": 61,
"partner_status_tier_id": 92,
"total_rewards": 8696,
"total_rewards_earned": 8873,
"total_rewards_redeemed": 0,
"user_id": 155
}
],
"phone_number": null,
"uuid_id": "77a5ad82-c27a-47fd-b21d-2d19a3ff222d"
}
}
}
Member API
Get User
Get a single user by ID
GET
/
users
/
{id}
Get User
curl --request GET \
--url https://api-staging.withbenji.com/users/{id} \
--header 'x-api-key: <api-key>'{
"code": "ok",
"data": {
"user": {
"created_date": "2026-02-08T00:13:59.970754+00:00",
"email": "test@test.com",
"external_id": null,
"first_name": "Test",
"id": 155,
"last_name": "User",
"merchants": [
{
"created_date": "2026-02-09T14:50:17.198641+00:00",
"external_id": "4731354127758848",
"id": 196,
"merchant_id": 85,
"total_rewards_earned": 0,
"total_rewards_redeemed": 0,
"user_id": 155
},
{
"created_date": "2026-02-11T18:08:18.532675+00:00",
"external_id": "daae5365-c895-48bf-bc23-a9861a351e04",
"id": 215,
"merchant_id": 93,
"total_rewards_earned": 3327,
"total_rewards_redeemed": 0,
"user_id": 155
}
],
"partner_status_tiers": [
{
"created_date": "2026-02-08T00:16:10.255945+00:00",
"external_id": "4731354127758848",
"first_name": "Test",
"id": 287,
"last_name": "User",
"partner_id": 61,
"partner_status_tier_id": 92,
"total_rewards": 8696,
"total_rewards_earned": 8873,
"total_rewards_redeemed": 0,
"user_id": 155
}
],
"phone_number": null,
"uuid_id": "77a5ad82-c27a-47fd-b21d-2d19a3ff222d"
}
}
}
The
x-api-key header value to be used on this API is your partner API key, which can be generated through the dashboard.Unique identifier of the user to retrieve (UUID)
Response
The requested user object containing all user details including personal information, partner statuses, and merchant associations.
Hide properties
Hide properties
UUID identifier for the user.
The user’s first name.
The user’s last name.
The user’s email address.
The user’s phone number in E.164 format.
The date and time when the user was created, in ISO 8601 format.
External system identifier for the user, if applicable.
List of partner status tier objects associated with the user. Each object contains details about the user’s status with a partner.
Show partner status tier properties
Show partner status tier properties
Unique identifier for the partner status tier record.
The user’s unique identifier.
The partner’s unique identifier.
The status tier’s unique identifier for this partner.
External system identifier for the partner status tier, if applicable.
First name as recorded for this partner status tier.
Last name as recorded for this partner status tier.
Total rewards available for this partner status tier.
Total rewards earned for this partner status tier.
Total rewards redeemed for this partner status tier.
Date and time when this partner status tier was created.
List of merchant association objects for the user. Each object contains details about the user’s relationship with a merchant.
Show merchant properties
Show merchant properties
Unique identifier for the user-merchant association record.
The user’s unique identifier.
The merchant’s unique identifier.
External system identifier for the merchant association, if applicable.
Total rewards earned with this merchant.
Total rewards redeemed with this merchant.
Date and time when this merchant association was created.
{
"code": "ok",
"data": {
"user": {
"created_date": "2026-02-08T00:13:59.970754+00:00",
"email": "test@test.com",
"external_id": null,
"first_name": "Test",
"id": 155,
"last_name": "User",
"merchants": [
{
"created_date": "2026-02-09T14:50:17.198641+00:00",
"external_id": "4731354127758848",
"id": 196,
"merchant_id": 85,
"total_rewards_earned": 0,
"total_rewards_redeemed": 0,
"user_id": 155
},
{
"created_date": "2026-02-11T18:08:18.532675+00:00",
"external_id": "daae5365-c895-48bf-bc23-a9861a351e04",
"id": 215,
"merchant_id": 93,
"total_rewards_earned": 3327,
"total_rewards_redeemed": 0,
"user_id": 155
}
],
"partner_status_tiers": [
{
"created_date": "2026-02-08T00:16:10.255945+00:00",
"external_id": "4731354127758848",
"first_name": "Test",
"id": 287,
"last_name": "User",
"partner_id": 61,
"partner_status_tier_id": 92,
"total_rewards": 8696,
"total_rewards_earned": 8873,
"total_rewards_redeemed": 0,
"user_id": 155
}
],
"phone_number": null,
"uuid_id": "77a5ad82-c27a-47fd-b21d-2d19a3ff222d"
}
}
}
This endpoint retrieves detailed information about a specific user, including their loyalty status with all connected partners and merchants.
Was this page helpful?
⌘I