API Keys
List role permissions
Returns all roles and their associated scopes. Use this to show what permissions each role grants when managing users or creating API keys. **Required scope:** `org:read`
Authorization
BearerAuth AuthorizationBearer <token>
Security scheme for OpenAPI endpoints. Validates both JWT tokens and API keys.
In: header
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/api-keys/roles"{ "roles": [ { "role": "string", "label": "string", "scopes": [ { "key": "string", "label": "string", "category": "string" } ] } ]}Empty
Empty
{ "code": "string", "message": "string", "request_id": "string", "details": [ { "field": "string", "message": "string" } ]}{ "code": "string", "message": "string", "request_id": "string", "details": [ { "field": "string", "message": "string" } ]}{ "code": "string", "message": "string", "request_id": "string", "details": [ { "field": "string", "message": "string" } ]}{ "code": "string", "message": "string", "request_id": "string", "details": [ { "field": "string", "message": "string" } ]}{ "code": "string", "message": "string", "request_id": "string", "details": [ { "field": "string", "message": "string" } ]}{ "code": "string", "message": "string", "request_id": "string", "details": [ { "field": "string", "message": "string" } ]}{ "code": "string", "message": "string", "request_id": "string", "details": [ { "field": "string", "message": "string" } ]}{ "code": "string", "message": "string", "request_id": "string", "details": [ { "field": "string", "message": "string" } ]}{ "code": "string", "message": "string", "request_id": "string", "details": [ { "field": "string", "message": "string" } ]}List available scopes
Returns all scope presets and granular scopes available to the authenticated user's role and seat type. Use this to populate the scope picker when creating API keys. **Required scope:** `apikeys:read`
List all API keys
Returns all API keys for the authenticated user. Does not include revoked keys.