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

# Get User Info

> Get account information, quota, and usage history

## Authentication

<ParamField header="X-API-Key" type="string" required>
  Your ClearProxy API key (format: clearpx\_yourkey)
</ParamField>

Alternatively, you can use Bearer token authentication:

<ParamField header="Authorization" type="string">
  Bearer token (format: Bearer clearpx\_yourkey)
</ParamField>

## Example Request

```bash theme={null}
curl https://api.clearproxy.io/me \
  -H "X-API-Key: clearpx_yourkey"
```

## Response

<ResponseField name="user" type="object">
  User account information

  <Expandable title="properties">
    <ResponseField name="id" type="string">
      User ID
    </ResponseField>

    <ResponseField name="email" type="string">
      Email address
    </ResponseField>

    <ResponseField name="checks_used" type="integer">
      Total number of checks used
    </ResponseField>

    <ResponseField name="remaining_checks" type="integer">
      Total remaining checks
    </ResponseField>

    <ResponseField name="breakdown" type="object">
      Breakdown of available checks

      <Expandable title="properties">
        <ResponseField name="root_balance" type="integer">
          Base account balance
        </ResponseField>

        <ResponseField name="temp_balance" type="integer">
          Temporary promotional balance
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="subscription_detail" type="object">
      Information about the user's active subscription

      <Expandable title="properties">
        <ResponseField name="UnlimitedPro" type="boolean">
          Whether the UnlimitedPro plan is active
        </ResponseField>

        <ResponseField name="unlimited_expired_at" type="string">
          Expiration date of the unlimited plan (ISO format)
        </ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="history" type="array">
  Array of recent check operations
</ResponseField>

<ResponseField name="usage_last_30_days" type="array">
  Usage statistics for the last 30 days
</ResponseField>

<ResponseExample>
  ```json theme={null}
  {
    "user": {
      "email": "hello@clearproxy.io",
      "checks_used": 1,
      "remaining_checks": 10938392,
      "subscription_detail": {
        "UnlimitedPro": false
      },
      "breakdown": {
        "root_balance": 10938392,
        "temp_balance": 0
      }
    },
    "history": [],
    "usage_last_30_days": []
  }
  ```
</ResponseExample>