Claude Platform Docs

API Keys

List API Keys
GET/v1/organizations/api_keys
Retrieve API Key (Admin API)
GET/v1/organizations/api_keys/{api_key_id}

Retrieve information about a single API key in your organization, looked up by its ID. This Admin API endpoint requires an Admin API key, is intended for programmatic key management, and never returns the key's secret value. To view or create your own API keys, go to API keys in the Claude Console.

Update API Key
POST/v1/organizations/api_keys/{api_key_id}
Models
BetaAPIKey object{ type: "api_key", id, created_at, 8 more }
BetaAPIKeyCreatedBy object{ type, id }
type: "service_account" or "user"

Type of the actor that created the object.

One of the following:
"service_account"
"user"
id: string

ID of the actor that created the object.

BetaAPIKeyOrganizationScope object{ type: "organization" }
type: "organization"

Scope type. Always "organization": the API key has no Workspace. Only a principal-bound API key can have this scope.

defaultorganization
BetaAPIKeyServiceAccountActor object{ type: "service_account_actor", service_account_id }
type: "service_account_actor"

Principal type. Always "service_account_actor" for a Service Account.

defaultservice_account_actor
service_account_id: string

ID of the Service Account the API key acts as.

BetaAPIKeyUserActor object{ type: "user_actor", user_id }
type: "user_actor"

Principal type. Always "user_actor" for a User.

defaultuser_actor
user_id: string

ID of the User the API key acts as.

BetaAPIKeyWorkspaceScope object{ type: "workspace", workspace_id }
type: "workspace"

Scope type. Always "workspace": the API key belongs to one Workspace.

defaultworkspace
workspace_id: string

ID of the Workspace the API key belongs to. Unlike the deprecated top-level workspace_id, this is the Workspace's real ID even for the organization's default Workspace.