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

# Token List & Get

```bash curl theme={"theme":{"light":"min-light","dark":"min-dark"}}
curl "https://sys.poixe.com/api/tokens?page=1&page_size=20&status=enabled" \
  -H "Authorization: Bearer $POIXE_SYSTEM_TOKEN"
```

```json response theme={"theme":{"light":"min-light","dark":"min-dark"}}
{
  "total": 5,
  "page": 1,
  "page_size": 20,
  "items": [
    {
      "id": 7,
      "name": "my-key",
      "key_mask": "sk-...wxyz",
      "status": "enabled",
      "created_at": 1731000000,
      "unlimited_quota": false,
      "usage": {
        "remain_cash": 8.000,
        "used_cash": 2.000,
        "used_quota": 0.002,
        "request_count": 312
      }
    }
  ],
  "timestamp": 1731337200
}
```

GET
`https://sys.poixe.com/api/tokens`

Retrieve a paginated list of tokens for the current account.

## Query Parameters

**page** `integer` (default: 1)

Page number (1-indexed)

**page\_size** `integer` (default: 20)

Items per page, max 100

**status** `string`

Filter by status. Valid values: `enabled` · `disabled` · `expired` · `exhausted` · `compromised`

## Response Fields

**total** `integer`

Total number of tokens

**page** `integer`

Current page number

**page\_size** `integer`

Items per page

**items** `array`

Token list. Each item contains:

**Token object fields**

**id** `integer`

Token ID

**name** `string`

Token name

**key\_mask** `string`

Masked token key, e.g. `sk-...wxyz`

**status** `string`

Token status: `enabled` · `disabled` · `expired` · `exhausted` · `compromised` · `unknown`

**created\_at** `integer`

Creation timestamp (Unix seconds)

**unlimited\_quota** `boolean`

Whether this token has unlimited quota. When `true`, `remain_cash` is not consumed and should not be displayed as a limit

**usage** `object`

Usage statistics:

**usage fields**

**remain\_cash** `number`

Remaining balance in USD. Top-up balance minus consumed amount

**used\_cash** `number`

Consumed amount in USD. Actual charges deducted from account balance

**used\_quota** `number`

Upstream quota consumed in USD. The actual upstream usage measured at official list prices. Poixe resells upstream quota at a discount — this field reflects real upstream consumption

**request\_count** `integer`

Cumulative number of requests

**timestamp** `integer`

Response timestamp (Unix seconds)

## Get Single Token

```bash curl theme={"theme":{"light":"min-light","dark":"min-dark"}}
curl https://sys.poixe.com/api/tokens/7 \
  -H "Authorization: Bearer $POIXE_SYSTEM_TOKEN"
```

```json response theme={"theme":{"light":"min-light","dark":"min-dark"}}
{
  "id": 7,
  "name": "my-key",
  "key_mask": "sk-...wxyz",
  "status": "enabled",
  "created_at": 1731000000,
  "unlimited_quota": false,
  "usage": {
    "remain_cash": 8.000,
    "used_cash": 2.000,
    "used_quota": 0.002,
    "request_count": 312
  },
  "timestamp": 1731337200
}
```

GET
`https://sys.poixe.com/api/tokens/:tokenID`

Retrieve details for a single token.

## Path Parameters

**tokenID** `integer` *required*

Token ID

## Response

Returns a single token object with the same fields as a list item, plus `timestamp`.


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