GET
/
users
/
{id}
Get User Status Data
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
​
id
integer
required

The Benji Platform ID of the user

​
Return values

​
user
object

A user object property

{
    "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