API Reference

Active

V1

API Keys

View as Markdown

View as Markdown

Copy Markdown

---

Open in Claude

Open in ChatGPT

List API keys for the authenticated user

get/active/v1/api_keys

List API keys for the authenticated user

ReturnsExpand Collapse

data: APIKeyListEntryList { id, created_at, expires_at, 2 more }

id: string

created_at: string

expires_at: string

name: optional string

revoked_at: optional string

List API keys for the authenticated user

HTTP

• HTTP
• TypeScript

curl https://api-active.clearstreet.io/active/v1/api_keys \
    -H "Authorization: Bearer $API_KEY"

200 example

{
  "data": [
    {
      "created_at": "2025-01-15T10:00:00.000000000Z",
      "expires_at": "2026-01-15T10:00:00.000000000Z",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Production Key",
      "revoked_at": null
    },
    {
      "created_at": "2025-01-10T14:30:00.000000000Z",
      "expires_at": "2026-01-10T14:30:00.000000000Z",
      "id": "660e8400-e29b-41d4-a716-446655440001",
      "name": "Development Key",
      "revoked_at": "2025-01-20T09:15:00.000000000Z"
    }
  ],
  "error": null,
  "metadata": {
    "next_page_token": null,
    "page_number": 1,
    "request_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
    "total_items": 2,
    "total_pages": 1
  }
}

Returns Examples

200 example

{
  "data": [
    {
      "created_at": "2025-01-15T10:00:00.000000000Z",
      "expires_at": "2026-01-15T10:00:00.000000000Z",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Production Key",
      "revoked_at": null
    },
    {
      "created_at": "2025-01-10T14:30:00.000000000Z",
      "expires_at": "2026-01-10T14:30:00.000000000Z",
      "id": "660e8400-e29b-41d4-a716-446655440001",
      "name": "Development Key",
      "revoked_at": "2025-01-20T09:15:00.000000000Z"
    }
  ],
  "error": null,
  "metadata": {
    "next_page_token": null,
    "page_number": 1,
    "request_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
    "total_items": 2,
    "total_pages": 1
  }
}