Skip to content
Primary navigation

Admin API Keys

List all organization and project API keys.
GET/organization/admin_api_keys
Create admin API key
POST/organization/admin_api_keys
Retrieve admin API key
GET/organization/admin_api_keys/{key_id}
Delete admin API key
DELETE/organization/admin_api_keys/{key_id}
ModelsExpand Collapse
AdminAPIKeyListResponse object { id, created_at, last_used_at, 5 more }

Represents an individual Admin API key in an org.

id: string

The identifier, which can be referenced in API endpoints

created_at: number

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

formatint64
last_used_at: number

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

formatint64
name: string

The name of the API key

object: string

The object type, which is always organization.admin_api_key

owner: object { id, created_at, name, 3 more }
id: optional string

The identifier, which can be referenced in API endpoints

created_at: optional number

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

formatint64
name: optional string

The name of the user

object: optional string

The object type, which is always organization.user

role: optional string

Always owner

type: optional string

Always user

redacted_value: string

The redacted value of the API key

value: optional string

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

AdminAPIKeyCreateResponse object { id, created_at, last_used_at, 5 more }

Represents an individual Admin API key in an org.

id: string

The identifier, which can be referenced in API endpoints

created_at: number

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

formatint64
last_used_at: number

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

formatint64
name: string

The name of the API key

object: string

The object type, which is always organization.admin_api_key

owner: object { id, created_at, name, 3 more }
id: optional string

The identifier, which can be referenced in API endpoints

created_at: optional number

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

formatint64
name: optional string

The name of the user

object: optional string

The object type, which is always organization.user

role: optional string

Always owner

type: optional string

Always user

redacted_value: string

The redacted value of the API key

value: optional string

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

AdminAPIKeyRetrieveResponse object { id, created_at, last_used_at, 5 more }

Represents an individual Admin API key in an org.

id: string

The identifier, which can be referenced in API endpoints

created_at: number

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

formatint64
last_used_at: number

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

formatint64
name: string

The name of the API key

object: string

The object type, which is always organization.admin_api_key

owner: object { id, created_at, name, 3 more }
id: optional string

The identifier, which can be referenced in API endpoints

created_at: optional number

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

formatint64
name: optional string

The name of the user

object: optional string

The object type, which is always organization.user

role: optional string

Always owner

type: optional string

Always user

redacted_value: string

The redacted value of the API key

value: optional string

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

AdminAPIKeyDeleteResponse object { id, deleted, object }
id: optional string
deleted: optional boolean
object: optional string