> ## 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.</Note>

<ParamField path="id" type="string" required>
  Unique identifier of the user to retrieve (UUID)
</ParamField>

### Response

<ResponseField name="user" type="object" required>
  The requested user object containing all user details including personal information, partner statuses, and merchant associations.

  <Expandable title="properties" defaultOpen="true">
    <ResponseField name="uuid_id" type="string" required>
      UUID identifier for the user.
    </ResponseField>

    <ResponseField name="first_name" type="string" required>
      The user's first name.
    </ResponseField>

    <ResponseField name="last_name" type="string" required>
      The user's last name.
    </ResponseField>

    <ResponseField name="email" type="string" required>
      The user's email address.
    </ResponseField>

    <ResponseField name="phone_number" type="string" required>
      The user's phone number in E.164 format.
    </ResponseField>

    <ResponseField name="created_date" type="string" required>
      The date and time when the user was created, in ISO 8601 format.
    </ResponseField>

    <ResponseField name="external_id" type="string">
      External system identifier for the user, if applicable.
    </ResponseField>

    <ResponseField name="partner_status_tiers" type="array">
      List of partner status tier objects associated with the user. Each object contains details about the user's status with a partner.

      <Expandable title="partner status tier properties">
        <ResponseField name="id" type="integer">Unique identifier for the partner status tier record.</ResponseField>
        <ResponseField name="user_id" type="integer">The user's unique identifier.</ResponseField>
        <ResponseField name="partner_id" type="integer">The partner's unique identifier.</ResponseField>
        <ResponseField name="partner_status_tier_id" type="integer">The status tier's unique identifier for this partner.</ResponseField>
        <ResponseField name="external_id" type="string">External system identifier for the partner status tier, if applicable.</ResponseField>
        <ResponseField name="first_name" type="string">First name as recorded for this partner status tier.</ResponseField>
        <ResponseField name="last_name" type="string">Last name as recorded for this partner status tier.</ResponseField>
        <ResponseField name="total_rewards" type="integer">Total rewards available for this partner status tier.</ResponseField>
        <ResponseField name="total_rewards_earned" type="integer">Total rewards earned for this partner status tier.</ResponseField>
        <ResponseField name="total_rewards_redeemed" type="integer">Total rewards redeemed for this partner status tier.</ResponseField>
        <ResponseField name="created_date" type="string">Date and time when this partner status tier was created.</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="merchants" type="array">
      List of merchant association objects for the user. Each object contains details about the user's relationship with a merchant.

      <Expandable title="merchant properties">
        <ResponseField name="id" type="integer">Unique identifier for the user-merchant association record.</ResponseField>
        <ResponseField name="user_id" type="integer">The user's unique identifier.</ResponseField>
        <ResponseField name="merchant_id" type="integer">The merchant's unique identifier.</ResponseField>
        <ResponseField name="external_id" type="string">External system identifier for the merchant association, if applicable.</ResponseField>
        <ResponseField name="total_rewards_earned" type="integer">Total rewards earned with this merchant.</ResponseField>
        <ResponseField name="total_rewards_redeemed" type="integer">Total rewards redeemed with this merchant.</ResponseField>
        <ResponseField name="created_date" type="string">Date and time when this merchant association was created.</ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseExample>
  ```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"
  }
  ```
</ResponseExample>

<Tip>
  This endpoint retrieves detailed information about a specific user, including their loyalty status with all connected partners and merchants.
</Tip>