Skip to main content
GET
https://api-staging.withbenji.com
/
users
/
{id}
Get User
curl --request GET \
  --url https://api-staging.withbenji.com/users/{id} \
  --header 'x-api-key: <api-key>'
{
  "user": {
    "uuid_id": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "email": "<string>",
    "phone_number": "<string>",
    "created_date": "<string>",
    "external_id": "<string>",
    "partner_status_tiers": [
      {
        "id": 123,
        "user_id": 123,
        "partner_id": 123,
        "partner_status_tier_id": 123,
        "external_id": "<string>",
        "first_name": "<string>",
        "last_name": "<string>",
        "total_rewards": 123,
        "total_rewards_earned": 123,
        "total_rewards_redeemed": 123,
        "created_date": "<string>"
      }
    ],
    "merchants": [
      {
        "id": 123,
        "user_id": 123,
        "merchant_id": 123,
        "external_id": "<string>",
        "total_rewards_earned": 123,
        "total_rewards_redeemed": 123,
        "created_date": "<string>"
      }
    ]
  }
}
The x-api-key header value to be used on this API is your partner API key, which can be generated through the dashboard.
​
id
string
required
Unique identifier of the user to retrieve (UUID)

​
Response

​
user
object
required
The requested user object containing all user details including personal information, partner statuses, and merchant associations.
This endpoint retrieves detailed information about a specific user, including their loyalty status with all connected partners and merchants.