API Documentation
Tokens
Member API
Campaign API
Reward API
Webhooks
curl --request GET \
--url https://userservice-staging.withbenji.com/users/{id} \
--header 'Authorization: Bearer <token>'{
"user": {
"id": 2,
"first_name": "<string>",
"last_name": "<string>",
"email": "[email protected]",
"phone_number": "<string>",
"created_date": "2023-11-07T05:31:56Z",
"external_id": "<string>",
"partner_status_tiers": [
{
"id": 2,
"user_id": 2,
"partner_id": 2,
"partner_status_tier_id": 2,
"total_rewards_earned": 1,
"total_rewards_redeemed": 1,
"created_date": "2023-11-07T05:31:56Z",
"external_id": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"total_rewards": 1
}
],
"merchants": [
{
"id": 2,
"user_id": 2,
"merchant_id": 2,
"created_date": "2023-11-07T05:31:56Z",
"external_id": "<string>",
"total_rewards_earned": 1,
"total_rewards_redeemed": 1
}
]
}
}Get a single user by ID
curl --request GET \
--url https://userservice-staging.withbenji.com/users/{id} \
--header 'Authorization: Bearer <token>'{
"user": {
"id": 2,
"first_name": "<string>",
"last_name": "<string>",
"email": "[email protected]",
"phone_number": "<string>",
"created_date": "2023-11-07T05:31:56Z",
"external_id": "<string>",
"partner_status_tiers": [
{
"id": 2,
"user_id": 2,
"partner_id": 2,
"partner_status_tier_id": 2,
"total_rewards_earned": 1,
"total_rewards_redeemed": 1,
"created_date": "2023-11-07T05:31:56Z",
"external_id": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"total_rewards": 1
}
],
"merchants": [
{
"id": 2,
"user_id": 2,
"merchant_id": 2,
"created_date": "2023-11-07T05:31:56Z",
"external_id": "<string>",
"total_rewards_earned": 1,
"total_rewards_redeemed": 1
}
]
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Response
OK
The requested user object containing all user details including personal information, partner statuses, and merchant associations.
Show child attributes
Show child attributes
Unique identifier for the user.
x >= 1The 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.
Optional. 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 child attributes
Show child attributes
Unique identifier for the partner status tier record.
x >= 1The user's unique identifier.
x >= 1The partner's unique identifier.
x >= 1The status tier's unique identifier for this partner.
x >= 1Total rewards earned for this partner status tier.
x >= 0Total rewards redeemed for this partner status tier.
x >= 0Date and time when this partner status tier was created.
Optional. 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.
x >= 0List of merchant association objects for the user. Each object contains details about the user's relationship with a merchant.
Show child attributes
Show child attributes
Unique identifier for the user-merchant association record.
x >= 1The user's unique identifier.
x >= 1The merchant's unique identifier.
x >= 1Date and time when this merchant association was created.
Optional. External system identifier for the merchant association, if applicable.
Total rewards earned with this merchant.
x >= 0Total rewards redeemed with this merchant.
x >= 0Was this page helpful?