API Keys

List API Keys

client.organization.apiKeys.list(query?, options?): Page<APIKey>

GET/v1/organizations/api_keys

Retrieve API Key (Admin API)

client.organization.apiKeys.retrieve(apiKeyID, options?): APIKey

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

client.organization.apiKeys.update(apiKeyID, body, options?): APIKey

POST/v1/organizations/api_keys/{api_key_id}

Models

interface APIKey { type: "api_key"; id; created_at; /* 7 more */ }

interface APIKeyCreatedBy { type; id }

type: "service_account" | "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.

interface APIKeyOrganizationScope { 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

interface APIKeyServiceAccountActor { 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.

interface APIKeyUserActor { 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.

interface APIKeyWorkspaceScope { 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.