Skip to content
Primary navigation

Suggested
API Dashboard
API Reference
Admin
Organization

Admin API Keys

List all organization and project API keys.
admin.organization.admin_api_keys.list(**kwargs) -> CursorPage<AdminAPIKey { id, created_at, object, 4 more } >
GET/organization/admin_api_keys
Create admin API key
admin.organization.admin_api_keys.create(**kwargs) -> AdminAPIKeyCreateResponse { value }
POST/organization/admin_api_keys
Retrieve admin API key
admin.organization.admin_api_keys.retrieve(key_id) -> AdminAPIKey { id, created_at, object, 4 more }
GET/organization/admin_api_keys/{key_id}
Delete admin API key
admin.organization.admin_api_keys.delete(key_id) -> AdminAPIKeyDeleteResponse { id, deleted, object }
DELETE/organization/admin_api_keys/{key_id}
ModelsExpand Collapse
class AdminAPIKey { id, created_at, object, 4 more }

Represents an individual Admin API key in an org.

id: String

The identifier, which can be referenced in API endpoints

created_at: Integer

The Unix timestamp (in seconds) of when the API key was created

formatunixtime
object: :"organization.admin_api_key"

The object type, which is always organization.admin_api_key

owner: Owner{ id, created_at, name, 3 more}
id: String

The identifier, which can be referenced in API endpoints

created_at: Integer

The Unix timestamp (in seconds) of when the user was created

formatunixtime
name: String

The name of the user

object: String

The object type, which is always organization.user

role: String

Always owner

type: String

Always user

redacted_value: String

The redacted value of the API key

last_used_at: Integer

The Unix timestamp (in seconds) of when the API key was last used

formatunixtime
name: String

The name of the API key

class AdminAPIKeyCreateResponse { value }

Represents an individual Admin API key in an org.

value: String

The value of the API key. Only shown on create.

class AdminAPIKeyDeleteResponse { id, deleted, object }
id: String
deleted: bool
object: :"organization.admin_api_key.deleted"