Claude Platform Docs

Organization

Get Current Organization
$ ant beta:organization retrieve
GET/v1/organizations/me

Retrieve information about the organization associated with the authenticated API key.

Models
beta_organization: object{ type: "organization", id, name }
type: "organization"

Object type.

For Organizations, this is always "organization".

id: string

ID of the Organization.

formatuuid
name: string

Name of the Organization.

beta_organization_role: "admin" or "billing" or "claude_code_user" or 6 more
"admin"
"billing"
"claude_code_user"
"developer"
"managed"
"membership_admin"
"owner"
"primary_owner"
"user"

OrganizationAPI Keys

List API Keys
$ ant beta:organization:api-keys list
GET/v1/organizations/api_keys
Retrieve API Key (Admin API)
$ ant beta:organization:api-keys retrieve
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
$ ant beta:organization:api-keys update
POST/v1/organizations/api_keys/{api_key_id}

OrganizationExternal Keys

Create External Key
$ ant beta:organization:external-keys create
POST/v1/organizations/external_keys

Create an external key config owned by the caller's organization.

List External Keys
$ ant beta:organization:external-keys list
GET/v1/organizations/external_keys

List external key configs in the caller's organization.

Get External Key
$ ant beta:organization:external-keys retrieve
GET/v1/organizations/external_keys/{external_key_id}

Retrieve a single external key config in the caller's organization by ID.

Update External Key
$ ant beta:organization:external-keys update
POST/v1/organizations/external_keys/{external_key_id}

Partially update an external key config. Omitted fields are left unchanged.

Delete External Key
$ ant beta:organization:external-keys delete
DELETE/v1/organizations/external_keys/{external_key_id}

Delete an external key config.

Validate External Key
$ ant beta:organization:external-keys validate
POST/v1/organizations/external_keys/{external_key_id}/validate

Validate an external key config against the customer's KMS.

OrganizationFederationIssuers

Create Federation Issuer
$ ant beta:organization:federation:issuers create
POST/v1/organizations/federation_issuers

Requires an OAuth access token with the org:admin scope, from ant auth login --scope org:admin or a workload identity federation rule; Admin API keys are not accepted. See Manage WIF with the Admin API.

List Federation Issuers
$ ant beta:organization:federation:issuers list
GET/v1/organizations/federation_issuers

Requires an OAuth access token with the org:admin scope, from ant auth login --scope org:admin or a workload identity federation rule; Admin API keys are not accepted. See Manage WIF with the Admin API.

Get Federation Issuer
$ ant beta:organization:federation:issuers retrieve
GET/v1/organizations/federation_issuers/{federation_issuer_id}

Requires an OAuth access token with the org:admin scope, from ant auth login --scope org:admin or a workload identity federation rule; Admin API keys are not accepted. See Manage WIF with the Admin API.

Update Federation Issuer
$ ant beta:organization:federation:issuers update
POST/v1/organizations/federation_issuers/{federation_issuer_id}

Requires an OAuth access token with the org:admin scope, from ant auth login --scope org:admin or a workload identity federation rule; Admin API keys are not accepted. See Manage WIF with the Admin API.

Archive Federation Issuer
$ ant beta:organization:federation:issuers archive
POST/v1/organizations/federation_issuers/{federation_issuer_id}/archive

Requires an OAuth access token with the org:admin scope, from ant auth login --scope org:admin or a workload identity federation rule; Admin API keys are not accepted. See Manage WIF with the Admin API.

OrganizationFederationRules

Create Federation Rule
$ ant beta:organization:federation:rules create
POST/v1/organizations/federation_rules

Requires an OAuth access token with the org:admin scope, from ant auth login --scope org:admin or a workload identity federation rule; Admin API keys are not accepted. See Manage WIF with the Admin API.

List Federation Rules
$ ant beta:organization:federation:rules list
GET/v1/organizations/federation_rules

Requires an OAuth access token with the org:admin scope, from ant auth login --scope org:admin or a workload identity federation rule; Admin API keys are not accepted. See Manage WIF with the Admin API.

Get Federation Rule
$ ant beta:organization:federation:rules retrieve
GET/v1/organizations/federation_rules/{federation_rule_id}

Requires an OAuth access token with the org:admin scope, from ant auth login --scope org:admin or a workload identity federation rule; Admin API keys are not accepted. See Manage WIF with the Admin API.

Update Federation Rule
$ ant beta:organization:federation:rules update
POST/v1/organizations/federation_rules/{federation_rule_id}

Requires an OAuth access token with the org:admin scope, from ant auth login --scope org:admin or a workload identity federation rule; Admin API keys are not accepted. See Manage WIF with the Admin API.

Archive Federation Rule
$ ant beta:organization:federation:rules archive
POST/v1/organizations/federation_rules/{federation_rule_id}/archive

Requires an OAuth access token with the org:admin scope, from ant auth login --scope org:admin or a workload identity federation rule; Admin API keys are not accepted. See Manage WIF with the Admin API.

OrganizationFederationRulesWorkspaces

Add Federation Rule Workspace
$ ant beta:organization:federation:rules:workspaces add
POST/v1/organizations/federation_rules/{federation_rule_id}/workspaces

Requires an OAuth access token with the org:admin scope, from ant auth login --scope org:admin or a workload identity federation rule; Admin API keys are not accepted. See Manage WIF with the Admin API.

List Federation Rule Workspaces
$ ant beta:organization:federation:rules:workspaces list
GET/v1/organizations/federation_rules/{federation_rule_id}/workspaces

Requires an OAuth access token with the org:admin scope, from ant auth login --scope org:admin or a workload identity federation rule; Admin API keys are not accepted. See Manage WIF with the Admin API.

Remove Federation Rule Workspace
$ ant beta:organization:federation:rules:workspaces remove
DELETE/v1/organizations/federation_rules/{federation_rule_id}/workspaces/{workspace_id}

Requires an OAuth access token with the org:admin scope, from ant auth login --scope org:admin or a workload identity federation rule; Admin API keys are not accepted. See Manage WIF with the Admin API.

OrganizationInvites

Create Invite
$ ant beta:organization:invites create
POST/v1/organizations/invites

Invite a user to join the organization by email.

List Invites
$ ant beta:organization:invites list
GET/v1/organizations/invites

List the organization's invites.

Get Invite
$ ant beta:organization:invites retrieve
GET/v1/organizations/invites/{invite_id}

Retrieve an invite by ID.

Delete Invite
$ ant beta:organization:invites delete
DELETE/v1/organizations/invites/{invite_id}

Delete a pending invite.

OrganizationService Accounts

Create Service Account
$ ant beta:organization:service-accounts create
POST/v1/organizations/service_accounts

Requires an OAuth access token with the org:admin scope, from ant auth login --scope org:admin or a workload identity federation rule; Admin API keys are not accepted. See Manage WIF with the Admin API.

List Service Accounts
$ ant beta:organization:service-accounts list
GET/v1/organizations/service_accounts

Requires an OAuth access token with the org:admin scope, from ant auth login --scope org:admin or a workload identity federation rule; Admin API keys are not accepted. See Manage WIF with the Admin API.

Get Service Account
$ ant beta:organization:service-accounts retrieve
GET/v1/organizations/service_accounts/{service_account_id}

Requires an OAuth access token with the org:admin scope, from ant auth login --scope org:admin or a workload identity federation rule; Admin API keys are not accepted. See Manage WIF with the Admin API.

Update Service Account
$ ant beta:organization:service-accounts update
POST/v1/organizations/service_accounts/{service_account_id}

Requires an OAuth access token with the org:admin scope, from ant auth login --scope org:admin or a workload identity federation rule; Admin API keys are not accepted. See Manage WIF with the Admin API.

Archive Service Account
$ ant beta:organization:service-accounts archive
POST/v1/organizations/service_accounts/{service_account_id}/archive

Requires an OAuth access token with the org:admin scope, from ant auth login --scope org:admin or a workload identity federation rule; Admin API keys are not accepted. See Manage WIF with the Admin API.

OrganizationService AccountsWorkspaces

Add Workspace To Service Account
$ ant beta:organization:service-accounts:workspaces add
POST/v1/organizations/service_accounts/{service_account_id}/workspaces

Requires an OAuth access token with the org:admin scope, from ant auth login --scope org:admin or a workload identity federation rule; Admin API keys are not accepted. See Manage WIF with the Admin API.

List Workspaces For Service Account
$ ant beta:organization:service-accounts:workspaces list
GET/v1/organizations/service_accounts/{service_account_id}/workspaces

Requires an OAuth access token with the org:admin scope, from ant auth login --scope org:admin or a workload identity federation rule; Admin API keys are not accepted. See Manage WIF with the Admin API.

Remove Workspace From Service Account
$ ant beta:organization:service-accounts:workspaces remove
DELETE/v1/organizations/service_accounts/{service_account_id}/workspaces/{workspace_id}

Requires an OAuth access token with the org:admin scope, from ant auth login --scope org:admin or a workload identity federation rule; Admin API keys are not accepted. See Manage WIF with the Admin API.

OrganizationUsers

List Users
$ ant beta:organization:users list
GET/v1/organizations/users

List the organization's members.

Get User
$ ant beta:organization:users retrieve
GET/v1/organizations/users/{user_id}

Retrieve a member of the organization by user ID.

Update User
$ ant beta:organization:users update
POST/v1/organizations/users/{user_id}

Update a member's organization role.

Remove User
$ ant beta:organization:users remove
DELETE/v1/organizations/users/{user_id}

Remove a member from the organization.

OrganizationWorkspaces

List Workspaces
$ ant beta:organization:workspaces list
GET/v1/organizations/workspaces
Create Workspace
$ ant beta:organization:workspaces create
POST/v1/organizations/workspaces
Get Workspace
$ ant beta:organization:workspaces retrieve
GET/v1/organizations/workspaces/{workspace_id}
Update Workspace
$ ant beta:organization:workspaces update
POST/v1/organizations/workspaces/{workspace_id}
Archive Workspace
$ ant beta:organization:workspaces archive
POST/v1/organizations/workspaces/{workspace_id}/archive

OrganizationWorkspacesRate Limits

List Workspace Rate Limits
$ ant beta:organization:workspaces:rate-limits list
GET/v1/organizations/workspaces/{workspace_id}/rate_limits

List a workspace's rate limits.

OrganizationWorkspacesMembers

List Workspace Members
$ ant beta:organization:workspaces:members list
GET/v1/organizations/workspaces/{workspace_id}/members
Create Workspace Member
$ ant beta:organization:workspaces:members add
POST/v1/organizations/workspaces/{workspace_id}/members
Get Workspace Member
$ ant beta:organization:workspaces:members retrieve
GET/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Update Workspace Member
$ ant beta:organization:workspaces:members update
POST/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Delete Workspace Member
$ ant beta:organization:workspaces:members remove
DELETE/v1/organizations/workspaces/{workspace_id}/members/{user_id}

OrganizationWorkspacesService Accounts

List Service Account Workspace Members
$ ant beta:organization:workspaces:service-accounts list
GET/v1/organizations/workspaces/{workspace_id}/service_accounts

Requires an OAuth access token with the org:admin scope, from ant auth login --scope org:admin or a workload identity federation rule; Admin API keys are not accepted. See Manage WIF with the Admin API.

Create Service Account Workspace Member
$ ant beta:organization:workspaces:service-accounts add
POST/v1/organizations/workspaces/{workspace_id}/service_accounts

Requires an OAuth access token with the org:admin scope, from ant auth login --scope org:admin or a workload identity federation rule; Admin API keys are not accepted. See Manage WIF with the Admin API.

Get Service Account Workspace Member
$ ant beta:organization:workspaces:service-accounts retrieve
GET/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

Requires an OAuth access token with the org:admin scope, from ant auth login --scope org:admin or a workload identity federation rule; Admin API keys are not accepted. See Manage WIF with the Admin API.

Update Service Account Workspace Member
$ ant beta:organization:workspaces:service-accounts update
POST/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

Requires an OAuth access token with the org:admin scope, from ant auth login --scope org:admin or a workload identity federation rule; Admin API keys are not accepted. See Manage WIF with the Admin API.

Delete Service Account Workspace Member
$ ant beta:organization:workspaces:service-accounts remove
DELETE/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

Requires an OAuth access token with the org:admin scope, from ant auth login --scope org:admin or a workload identity federation rule; Admin API keys are not accepted. See Manage WIF with the Admin API.

OrganizationRate Limits

List Organization Rate Limits
$ ant beta:organization:rate-limits list
GET/v1/organizations/rate_limits

List Messages API rate limits for your organization.

OrganizationCompliance Settings

Get Compliance Settings
$ ant beta:organization:compliance-settings retrieve
GET/v1/organizations/compliance_settings

Retrieve your organization's Compliance Settings.

Update Compliance Settings
$ ant beta:organization:compliance-settings update
POST/v1/organizations/compliance_settings

Update your organization's Compliance Settings.

OrganizationAnalyticsSummaries

Get Activity Summaries
$ ant beta:organization:analytics:summaries list
GET/v1/organizations/analytics/summaries

Get organization-wide activity summaries for a date range.

OrganizationAnalyticsUsers

List User Activity
$ ant beta:organization:analytics:users list
GET/v1/organizations/analytics/users

Get per-user activity for a given day, with cursor-based pagination.

OrganizationAnalyticsAppsChatProjects

Get Chat Project Usage
$ ant beta:organization:analytics:apps:chat:projects list
GET/v1/organizations/analytics/apps/chat/projects

Get per-project activity for a given day, with cursor-based pagination.

OrganizationAnalyticsConnectors

Get Connector Usage
$ ant beta:organization:analytics:connectors list
GET/v1/organizations/analytics/connectors

Get per-connector usage for a given day, with cursor-based pagination.

OrganizationAnalyticsPlugins

Get Plugin Usage
$ ant beta:organization:analytics:plugins list
GET/v1/organizations/analytics/plugins

Get per-plugin install + invocation usage for a given day, with pagination.

OrganizationAnalyticsSkills

Get Skill Usage
$ ant beta:organization:analytics:skills list
GET/v1/organizations/analytics/skills

Get per-skill usage for a given day, with cursor-based pagination.

OrganizationAnalyticsArtifacts

Get Artifact Activity
$ ant beta:organization:analytics:artifacts list
GET/v1/organizations/analytics/artifacts

Get artifact-creation activity for a given day, broken out by MIME type.

OrganizationAnalyticsUsage Report

Get Token Usage Over Time
$ ant beta:organization:analytics:usage-report list
GET/v1/organizations/analytics/usage_report

Get token usage over time across a date range.

OrganizationAnalyticsUser Usage Report

Get Per-User Token Usage
$ ant beta:organization:analytics:user-usage-report list
GET/v1/organizations/analytics/user_usage_report

Get per-user token usage across a date range.

OrganizationAnalyticsCost Report

Get Cost Over Time
$ ant beta:organization:analytics:cost-report list
GET/v1/organizations/analytics/cost_report

Get cost in USD over time across a date range.

OrganizationAnalyticsUser Cost Report

Get Per-User Cost
$ ant beta:organization:analytics:user-cost-report list
GET/v1/organizations/analytics/user_cost_report

Get per-user cost in USD across a date range.

OrganizationSpend Limits

Set Spend Limit
$ ant beta:organization:spend-limits set
POST/v1/organizations/spend_limits

Set a spend limit.

Get Spend Limit
$ ant beta:organization:spend-limits retrieve
GET/v1/organizations/spend_limits/{spend_limit_id}

Retrieve a spend limit by ID.

Delete Spend Limit
$ ant beta:organization:spend-limits delete
DELETE/v1/organizations/spend_limits/{spend_limit_id}

Delete a spend limit.

List Spend Limits
$ ant beta:organization:spend-limits list
GET/v1/organizations/spend_limits

List the organization's spend limits.

OrganizationSpend LimitsEffective

List Effective Spend Limits
$ ant beta:organization:spend-limits:effective list
GET/v1/organizations/spend_limits/effective

List each member's effective spend limit and period-to-date spend.

OrganizationSpend LimitsIncrease Requests

List Spend Limit Increase Requests
$ ant beta:organization:spend-limits:increase-requests list
GET/v1/organizations/spend_limit_increase_requests

List spend limit increase requests, most recent first.

Get Spend Limit Increase Request
$ ant beta:organization:spend-limits:increase-requests retrieve
GET/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}

Retrieve a spend limit increase request.

Approve Spend Limit Increase Request
$ ant beta:organization:spend-limits:increase-requests approve
POST/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}/approve

Approve a pending spend limit increase request.

Deny Spend Limit Increase Request
$ ant beta:organization:spend-limits:increase-requests deny
POST/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}/deny

Deny a pending spend limit increase request.

OrganizationRBAC Groups

Create RBAC Group
$ ant beta:organization:rbac-groups create
POST/v1/organizations/rbac_groups

Create an RBAC Group in the Claude Enterprise tenant. Groups created via the API have source type "direct".

List RBAC Groups
$ ant beta:organization:rbac-groups list
GET/v1/organizations/rbac_groups

List RBAC Groups in the Claude Enterprise tenant.

Get RBAC Group
$ ant beta:organization:rbac-groups retrieve
GET/v1/organizations/rbac_groups/{rbac_group_id}

Retrieve an RBAC Group by ID.

Update RBAC Group
$ ant beta:organization:rbac-groups update
POST/v1/organizations/rbac_groups/{rbac_group_id}

Update an RBAC Group's name. Groups provisioned by an identity provider (source type "scim") cannot be modified via the API while an organization in the tenant uses SCIM provisioning.

Delete RBAC Group
$ ant beta:organization:rbac-groups delete
DELETE/v1/organizations/rbac_groups/{rbac_group_id}

Delete an RBAC Group. Groups provisioned by an identity provider (source type "scim") cannot be deleted via the API while an organization in the tenant uses SCIM provisioning.

OrganizationRBAC GroupsMembers

List RBAC Group Members
$ ant beta:organization:rbac-groups:members list
GET/v1/organizations/rbac_groups/{rbac_group_id}/members

List members of an RBAC Group.

Add RBAC Group Member
$ ant beta:organization:rbac-groups:members add
POST/v1/organizations/rbac_groups/{rbac_group_id}/members

Add a User to an RBAC Group. Membership of groups provisioned by an identity provider (source type "scim") cannot be modified via the API while an organization in the tenant uses SCIM provisioning.

Remove RBAC Group Member
$ ant beta:organization:rbac-groups:members remove
DELETE/v1/organizations/rbac_groups/{rbac_group_id}/members/{user_id}

Remove a User from an RBAC Group. Membership of groups provisioned by an identity provider (source type "scim") cannot be modified via the API while an organization in the tenant uses SCIM provisioning.

OrganizationRBAC Roles

List RBAC Roles
$ ant beta:organization:rbac-roles list
GET/v1/organizations/rbac_roles

List RBAC Roles in the organization.

Get RBAC Role
$ ant beta:organization:rbac-roles retrieve
GET/v1/organizations/rbac_roles/{rbac_role_id}

Retrieve an RBAC Role by ID.

OrganizationRBAC RolesPermissions

List RBAC Role Permissions
$ ant beta:organization:rbac-roles:permissions list
GET/v1/organizations/rbac_roles/{rbac_role_id}/permissions

List the permissions an RBAC Role grants.

OrganizationPlugins

Create Plugin
$ ant beta:organization:plugins create
POST/v1/organizations/plugins

Create an organization-owned Plugin and its first version by uploading the version's files.

Get Plugin
$ ant beta:organization:plugins retrieve
GET/v1/organizations/plugins/{plugin_id}

Retrieve a Plugin by ID.

Update Plugin
$ ant beta:organization:plugins update
POST/v1/organizations/plugins/{plugin_id}

Change which stored version of an organization-owned Plugin is served to members, for example to roll back to an earlier one. This pins the served version: later uploads are stored but no longer change what is served, and pinning cannot currently be undone, here or in claude.ai.

List Plugins
$ ant beta:organization:plugins list
GET/v1/organizations/plugins

List the Plugins created under the organization, newest first: those in the organization's own plugin marketplaces and those in members' personal plugin marketplaces.

Delete Plugin
$ ant beta:organization:plugins delete
DELETE/v1/organizations/plugins/{plugin_id}

Permanently delete a Plugin and every version it holds, exactly as when an administrator deletes it in claude.ai. The Plugin may belong to the organization or to a member, including a member who has since left the organization.

OrganizationPluginsVersions

Create Plugin Version
$ ant beta:organization:plugins:versions create
POST/v1/organizations/plugins/{plugin_id}/versions

Add a version to an organization-owned Plugin by uploading the new version's files; it becomes the version served to members unless the Plugin's served version has been pinned.

List Plugin Versions
$ ant beta:organization:plugins:versions list
GET/v1/organizations/plugins/{plugin_id}/versions

List a Plugin's versions, newest first.

Get Plugin Version
$ ant beta:organization:plugins:versions retrieve
GET/v1/organizations/plugins/{plugin_id}/versions/{version}

Retrieve one version of a Plugin by its ID, or the Plugin's newest version.

Download Plugin Version Archive
$ ant beta:organization:plugins:versions download
GET/v1/organizations/plugins/{plugin_id}/versions/{version}/content

Download one version's .zip archive, exactly as stored. Each download of a Plugin from a member's personal plugin marketplace is recorded on the Compliance API activity feed.

OrganizationPluginsInstallation Settings

List Plugin Installation Settings
$ ant beta:organization:plugins:installation-settings list
GET/v1/organizations/plugins/{plugin_id}/installation_settings

List an organization-owned Plugin's installation settings, which say which members it is for, most recently created first.

Set Plugin Installation Setting
$ ant beta:organization:plugins:installation-settings set
POST/v1/organizations/plugins/{plugin_id}/installation_settings/{target}

Set or change an organization-owned Plugin's installation setting for the whole organization or for one RBAC Group.

Remove Plugin Installation Setting
$ ant beta:organization:plugins:installation-settings remove
DELETE/v1/organizations/plugins/{plugin_id}/installation_settings/{target}

Remove an organization-owned Plugin's own installation setting for the whole organization or for one RBAC Group.

OrganizationPluginsShares

List Plugin Shares
$ ant beta:organization:plugins:shares list
GET/v1/organizations/plugins/{plugin_id}/shares

List the shares the owner of a member-owned Plugin has given — to every member of the organization, to an RBAC Group, or to one member — most recently granted first.

OrganizationPlugin Marketplaces

List Plugin Marketplaces
$ ant beta:organization:plugin-marketplaces list
GET/v1/organizations/plugin_marketplaces

List the plugin marketplaces Plugins live in, newest first: the organization's own and its members' personal ones.

Get Plugin Marketplace
$ ant beta:organization:plugin-marketplaces retrieve
GET/v1/organizations/plugin_marketplaces/{marketplace_id}

Retrieve a plugin marketplace by ID.

Update Plugin Marketplace
$ ant beta:organization:plugin-marketplaces update
POST/v1/organizations/plugin_marketplaces/{marketplace_id}

Set the default installation setting of one of the organization's own plugin marketplaces. Every Plugin in it without a setting of its own gets this default as its organization-wide setting, including Plugins added later.

Validate Plugin Marketplace Repository
$ ant beta:organization:plugin-marketplaces validate-repository
POST/v1/organizations/plugin_marketplaces/validate_repository

Check whether a plugin marketplace held in a public GitHub repository would synchronize into claude.ai, without connecting or storing it.

Validate Plugin Marketplace Archive
$ ant beta:organization:plugin-marketplaces validate-archive
POST/v1/organizations/plugin_marketplaces/validate_archive

Check whether a plugin marketplace, uploaded as a .zip of the marketplace directory, would synchronize into claude.ai, without connecting or storing it.