Skip to main content
GET
/
api
/
api-keys
List API Keys
curl --request GET \
  --url https://api.example.com/api/api-keys \
  --header 'Authorization: <authorization>' \
  --header 'X-Organization-Id: <x-organization-id>'
{
  "success": true,
  "data": [
    {
      "key_id": "apikey_a1b2c3d4e5f6",
      "name": "Production API Key",
      "role": "agent_manager",
      "prefix": "bk_live_xxxx",
      "client_id": "org_abc123",
      "user_id": "user_def456",
      "status": "active",
      "created_at": "2024-01-15T10:30:00Z",
      "last_used_at": "2024-01-15T14:45:00Z",
      "expires_at": "2025-12-31T23:59:59Z"
    }
  ]
}
Retrieve a list of all API keys for your organization.

​
Headers

​
Authorization
string
required
Bearer token from Cognito authentication (JWT).
​
X-Organization-Id
string
required
The organization ID.

​
Response

​
success
boolean
Indicates if the request was successful.
​
data
array
List of API key objects.
{
  "success": true,
  "data": [
    {
      "key_id": "apikey_a1b2c3d4e5f6",
      "name": "Production API Key",
      "role": "agent_manager",
      "prefix": "bk_live_xxxx",
      "client_id": "org_abc123",
      "user_id": "user_def456",
      "status": "active",
      "created_at": "2024-01-15T10:30:00Z",
      "last_used_at": "2024-01-15T14:45:00Z",
      "expires_at": "2025-12-31T23:59:59Z"
    }
  ]
}