> ## Documentation Index
> Fetch the complete documentation index at: https://docs.withbenji.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get User

> Get a single user by ID

> [!NOTE]
>
> 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.

**properties**

**uuid\_id** `string` *required*

UUID identifier for the user.

**first\_name** `string` *required*

The user's first name.

**last\_name** `string` *required*

The user's last name.

**email** `string` *required*

The user's email address.

**phone\_number** `string` *required*

The user's phone number in E.164 format.

**created\_date** `string` *required*

The date and time when the user was created, in ISO 8601 format.

**external\_id** `string`

External system identifier for the user, if applicable.

**partner\_status\_tiers** `array`

List of partner status tier objects associated with the user. Each object contains details about the user's status with a partner.

**partner status tier properties**

**id** `integer`

Unique identifier for the partner status tier record.

**user\_id** `integer`

The user's unique identifier.

**partner\_id** `integer`

The partner's unique identifier.

**partner\_status\_tier\_id** `integer`

The status tier's unique identifier for this partner.

**external\_id** `string`

External system identifier for the partner status tier, if applicable.

**first\_name** `string`

First name as recorded for this partner status tier.

**last\_name** `string`

Last name as recorded for this partner status tier.

**total\_rewards** `integer`

Total rewards available for this partner status tier.

**total\_rewards\_earned** `integer`

Total rewards earned for this partner status tier.

**total\_rewards\_redeemed** `integer`

Total rewards redeemed for this partner status tier.

**created\_date** `string`

Date and time when this partner status tier was created.

**merchants** `array`

List of merchant association objects for the user. Each object contains details about the user's relationship with a merchant.

**merchant properties**

**id** `integer`

Unique identifier for the user-merchant association record.

**user\_id** `integer`

The user's unique identifier.

**merchant\_id** `integer`

The merchant's unique identifier.

**external\_id** `string`

External system identifier for the merchant association, if applicable.

**total\_rewards\_earned** `integer`

Total rewards earned with this merchant.

**total\_rewards\_redeemed** `integer`

Total rewards redeemed with this merchant.

**created\_date** `string`

Date and time when this merchant association was created.

```json 200 theme={null}
{
    "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"
        }
    }
}
```

```json 400 theme={null}
{
  "error": "invalid_token",
  "message": "Invalid token"
}
```

```json 401 theme={null}
{
  "error": "unauthorized_request",
  "message": "Token is not authorized to make this request"
}
```

```json 404 theme={null}
{
  "error": "user_does_not_exist",
  "message": "The user does not exist"
}
```

> [!TIP]
>
> This endpoint retrieves detailed information about a specific user, including their loyalty status with all connected partners and merchants.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.