llms.txt@04-API-Reference/Admin · git:20261024.48b8a60 · 2026-10-24 · sha256 be958b2c520043fe
llms.txt@04-API-Reference/Admin git:20261024.48b8a60F
Immutable. This exact content never changes and is served at /api/v1/blob/be958b2c520043fe.
# API Reference / Admin
> Every page below, concatenated. Each section gives the page title, its upstream source and its path in this repository.
---
## List API Keys - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/api_keys/list
Path: 04-API-Reference/Admin/admin-api-keys-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fapi_keys%2Flist)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
List API Keys
Retrieve API Key (Admin API)
Update API Key
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
Looking for your API keys? You can view and create them in [Settings → API keys](../Other/playground.md) in the Claude Console.
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [API Keys](https://platform.claude.com/docs/en/api/http/beta/organization/api_keys)
# List API Keys
GET/v1/organizations/api_keys
List API Keys
##### Query parameters
after_id: optional string
ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object.
before_id: optional string
ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object.
created_by_user_id: optional string
Filter by the ID of the User who created the object.
limit: optional number
Number of items to return per page.
Defaults to `20`. Ranges from `1` to `1000`.
default20
maximum1000
minimum1
status: optional "active" or "archived" or "expired" or "inactive"
Filter by API key status.
One of the following:
"active"
"archived"
"expired"
"inactive"
workspace_id: optional string
Filter by Workspace ID.
##### Returns
data: array of [BetaAPIKey](https://platform.claude.com/docs/en/api/http/beta/organization/api_keys#beta_api_key) { type: "api_key", id, created_at, 8 more }
type: "api_key"
Object type.
For API Keys, this is always `"api_key"`.
defaultapi_key
id: string
ID of the API key.
created_at: string
RFC 3339 datetime string indicating when the API Key was created.
formatdate-time
created_by: [BetaAPIKeyCreatedBy](https://platform.claude.com/docs/en/api/http/beta/organization/api_keys#beta_api_key_created_by) { type, id } or null
The ID and type of the actor that created the API key, or `null` when the creator is not recorded (legacy, workload-identity-federated, or system-created keys).
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.
expires_at: string or null
RFC 3339 datetime string indicating when the API Key expires, or `null` if it never expires.
formatdate-time
name: string
Name of the API key.
partial_key_hint: string or null
Partially redacted hint for the API key.
principal: [BetaAPIKeyUserActor](https://platform.claude.com/docs/en/api/http/beta/organization/api_keys#beta_api_key_user_actor) or [BetaAPIKeyServiceAccountActor](https://platform.claude.com/docs/en/api/http/beta/organization/api_keys#beta_api_key_service_account_actor) or null
The principal the API key acts as (a User or a Service Account), or `null` if the API key is not bound to a principal.
One of the following:
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.
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.
scope: [BetaAPIKeyOrganizationScope](https://platform.claude.com/docs/en/api/http/beta/organization/api_keys#beta_api_key_organization_scope) or [BetaAPIKeyWorkspaceScope](https://platform.claude.com/docs/en/api/http/beta/organization/api_keys#beta_api_key_workspace_scope)
Where the API key belongs: its Workspace (`{"type": "workspace", "workspace_id": "wrkspc_..."}`, with the Workspace's real ID even when it is the organization's default Workspace), or the organization (`{"type": "organization"}`) for a principal-bound API key that has no Workspace.
One of the following:
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
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.
status: "active" or "archived" or "expired" or "inactive"
Status of the API key.
One of the following:
"active"
"archived"
"expired"
"inactive"
workspace_id: string or nullDeprecated
Deprecated: use `scope` instead. ID of the Workspace associated with the API key, or `null` if the API key belongs to the default Workspace. Also `null` for a principal-bound API key that has no Workspace; `scope` tells the two apart.
Use \`scope\` instead. \`workspace_id\` is \`null\` both for an API key in the default Workspace and for a principal-bound API key that has no Workspace.
first_id: string or null
First ID in the `data` list. Can be used as the `before_id` for the previous page.
has_more: boolean
Indicates if there are more results in the requested page direction.
last_id: string or null
Last ID in the `data` list. Can be used as the `after_id` for the next page.
List API Keys
cURL
```python
curl https://api.anthropic.com/v1/organizations/api_keys \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"data": [
{
"id": "apikey_01Rj2N8SVvo6BePZj99NhmiT",
"created_at": "2024-10-30T23:58:27.427722Z",
"created_by": {
"id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"type": "user"
},
"expires_at": "2024-10-30T23:58:27.427722Z",
"name": "Developer Key",
"partial_key_hint": "sk-ant-api03-R2D...igAA",
"principal": {
"type": "user_actor",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"scope": {
"type": "workspace",
"workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"
},
"status": "active",
"type": "api_key",
"workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"
}
],
"first_id": "first_id",
"has_more": true,
"last_id": "last_id"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"id": "apikey_01Rj2N8SVvo6BePZj99NhmiT",
"created_at": "2024-10-30T23:58:27.427722Z",
"created_by": {
"id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"type": "user"
},
"expires_at": "2024-10-30T23:58:27.427722Z",
"name": "Developer Key",
"partial_key_hint": "sk-ant-api03-R2D...igAA",
"principal": {
"type": "user_actor",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"scope": {
"type": "workspace",
"workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"
},
"status": "active",
"type": "api_key",
"workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"
---
## Retrieve API Key (Admin API) - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/api_keys/retrieve
Path: 04-API-Reference/Admin/admin-api-keys-retrieve.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Fapi_keys%2Fretrieve)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
API Keys
Retrieve API Key (Admin API)
List API Keys
Update API Key
External Keys
Usage Report
Cost Report
Analytics
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
Looking for your API keys? You can view and create them in [Settings → API keys](../Other/playground.md) in the Claude Console.
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [API Keys](https://platform.claude.com/docs/en/api/http/admin/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](../Other/playground.md) in the Claude Console.
##### Path parameters
api_key_id: string
ID of the API key.
##### Returns
APIKey object{ id, created_at, created_by, 8 more }
Retrieve API Key (Admin API)
cURL
```python
curl https://api.anthropic.com/v1/organizations/api_keys/$API_KEY_ID \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
```
Response 200
```python
{
"id": "apikey_01Rj2N8SVvo6BePZj99NhmiT",
"created_at": "2024-10-30T23:58:27.427722Z",
"created_by": {
"id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"type": "user"
},
"expires_at": "2024-10-30T23:58:27.427722Z",
"name": "Developer Key",
"partial_key_hint": "sk-ant-api03-R2D...igAA",
"principal": {
"type": "user_actor",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"scope": {
"type": "workspace",
"workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"
},
"status": "active",
"type": "api_key",
"workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"
}
```
##### Returns Examples
Response 200
```python
{
"id": "apikey_01Rj2N8SVvo6BePZj99NhmiT",
"created_at": "2024-10-30T23:58:27.427722Z",
"created_by": {
"id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"type": "user"
},
"expires_at": "2024-10-30T23:58:27.427722Z",
"name": "Developer Key",
"partial_key_hint": "sk-ant-api03-R2D...igAA",
"principal": {
"type": "user_actor",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"scope": {
"type": "workspace",
"workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"
},
"status": "active",
"type": "api_key",
"workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"
---
## Update API Key - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/api_keys/update
Path: 04-API-Reference/Admin/admin-api-keys-update.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Fapi_keys%2Fupdate)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
API Keys
Retrieve API Key (Admin API)
List API Keys
Update API Key
External Keys
Usage Report
Cost Report
Analytics
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
Looking for your API keys? You can view and create them in [Settings → API keys](../Other/playground.md) in the Claude Console.
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [API Keys](https://platform.claude.com/docs/en/api/http/admin/api_keys)
# Update API Key
POST/v1/organizations/api_keys/{api_key_id}
Update API Key
##### Path parameters
api_key_id: string
ID of the API key.
##### Body
name: optional string or null
Name of the API key.
maxLength500
minLength1
status: optional "active" or "archived" or "inactive" or null
Status of the API key.
One of the following:
"active"
"archived"
"inactive"
##### Returns
APIKey object{ id, created_at, created_by, 8 more }
Update API Key
cURL
```python
curl https://api.anthropic.com/v1/organizations/api_keys/$API_KEY_ID \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN" \
-d '{}'
```
Response 200
```python
{
"id": "apikey_01Rj2N8SVvo6BePZj99NhmiT",
"created_at": "2024-10-30T23:58:27.427722Z",
"created_by": {
"id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"type": "user"
},
"expires_at": "2024-10-30T23:58:27.427722Z",
"name": "Developer Key",
"partial_key_hint": "sk-ant-api03-R2D...igAA",
"principal": {
"type": "user_actor",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"scope": {
"type": "workspace",
"workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"
},
"status": "active",
"type": "api_key",
"workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"
}
```
##### Returns Examples
Response 200
```python
{
"id": "apikey_01Rj2N8SVvo6BePZj99NhmiT",
"created_at": "2024-10-30T23:58:27.427722Z",
"created_by": {
"id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"type": "user"
},
"expires_at": "2024-10-30T23:58:27.427722Z",
"name": "Developer Key",
"partial_key_hint": "sk-ant-api03-R2D...igAA",
"principal": {
"type": "user_actor",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"scope": {
"type": "workspace",
"workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"
},
"status": "active",
"type": "api_key",
"workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"
---
## API Keys - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/api_keys
Path: 04-API-Reference/Admin/admin-api-keys.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Fapi_keys)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
API Keys
Retrieve API Key (Admin API)
List API Keys
Update API Key
External Keys
Usage Report
Cost Report
Analytics
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
Looking for your API keys? You can view and create them in [Settings → API keys](../Other/playground.md) in the Claude Console.
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
# API Keys
##### [Retrieve API Key (Admin API)](https://platform.claude.com/docs/en/api/http/admin/api_keys/retrieve)
GET/v1/organizations/api_keys/{api_key_id}
##### [List API Keys](https://platform.claude.com/docs/en/api/http/admin/api_keys/list)
GET/v1/organizations/api_keys
##### [Update API Key](https://platform.claude.com/docs/en/api/http/admin/api_keys/update)
POST/v1/organizations/api_keys/{api_key_id}
---
## Get Cost Report - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/cost_report/retrieve
Path: 04-API-Reference/Admin/admin-cost-report-retrieve.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Fcost_report%2Fretrieve)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
API Keys
External Keys
Usage Report
Cost Report
Get Cost Report
Analytics
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [Cost Report](https://platform.claude.com/docs/en/api/http/admin/cost_report)
# Get Cost Report
GET/v1/organizations/cost_report
Get Cost Report
##### Query parameters
starting_at: string
Time buckets that start on or after this RFC 3339 timestamp will be returned. Each time bucket will be snapped to the start of the minute/hour/day in UTC.
formatdate-time
bucket_width: optional "1d"
Time granularity of the response data.
default1d
ending_at: optional string
Time buckets that end before this RFC 3339 timestamp will be returned.
formatdate-time
group_by: optional array of "description" or "workspace_id"
Group by any subset of the available options.
One of the following:
"description"
"workspace_id"
limit: optional number
Maximum number of time buckets to return in the response.
default7
maximum31
minimum1
page: optional string
Optionally set to the `next_page` token from the previous response.
##### Headers
"anthropic-beta": optional array of string
Optional header to specify the beta version(s) you want to use.
To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta.
##### Returns
CostReport object{ data, has_more, next_page }
Get Cost Report
cURL
```python
curl https://api.anthropic.com/v1/organizations/cost_report \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
```
Response 200
```python
{
"data": [
{
"ending_at": "2025-08-02T00:00:00Z",
"results": [
{
"amount": "123.78912",
"context_window": "0-200k",
"cost_type": "tokens",
"currency": "USD",
"description": "Claude Opus 5 Usage - Input Tokens",
"inference_geo": "global",
"model": "claude-opus-5",
"service_tier": "standard",
"token_type": "uncached_input_tokens",
"workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"
}
],
"starting_at": "2025-08-01T00:00:00Z"
}
],
"has_more": true,
"next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo="
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"ending_at": "2025-08-02T00:00:00Z",
"results": [
{
"amount": "123.78912",
"context_window": "0-200k",
"cost_type": "tokens",
"currency": "USD",
"description": "Claude Opus 5 Usage - Input Tokens",
"inference_geo": "global",
"model": "claude-opus-5",
"service_tier": "standard",
"token_type": "uncached_input_tokens",
"workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"
}
],
"starting_at": "2025-08-01T00:00:00Z"
}
],
"has_more": true,
"next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo="
---
## Cost Report - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/cost_report
Path: 04-API-Reference/Admin/admin-cost-report.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Fcost_report)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
API Keys
External Keys
Usage Report
Cost Report
Get Cost Report
Analytics
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
# Cost Report
##### [Get Cost Report](https://platform.claude.com/docs/en/api/http/admin/cost_report/retrieve)
GET/v1/organizations/cost_report
##### Models
CostReport object{ data, has_more, next_page }
---
## Create External Key - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/external_keys/create
Path: 04-API-Reference/Admin/admin-external-keys-create.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Fexternal_keys%2Fcreate)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
API Keys
External Keys
Create External Key
List External Keys
Get External Key
Update External Key
Delete External Key
Validate External Key
Usage Report
Cost Report
Analytics
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [External Keys](https://platform.claude.com/docs/en/api/http/admin/external_keys)
# Create External Key
POST/v1/organizations/external_keys
Create an external key config owned by the caller's organization.
##### Body
provider_config: object{ kms_arn, type, region, role_arn } or object{ key_name, type } or object{ key_name, tenant_id, type, 2 more }
KMS provider identity and auth coordinates.
One of the following:
Aws object{ kms_arn, type, region, role_arn }
kms_arn: string
Full ARN of the AWS KMS key. On Claude Platform on AWS the key must be a single-Region key in your organization's own AWS account; cross-account keys, multi-Region keys, and alias ARNs are rejected.
maxLength2048
type: "aws"
region: optional string or null
AWS region. Derived from `kms_arn` if omitted.
role_arn: optional string or nullDeprecated
IAM role ARN. Deprecated — Anthropic reaches the KMS key through its own intermediate role (or, on Claude Platform on AWS, with credentials AWS issues for the Workspace); this field is ignored.
Gcp object{ key_name, type }
key_name: string
Full resource name of the Cloud KMS key.
type: "gcp"
Azure object{ key_name, tenant_id, type, 2 more }
Azure Key Vault provider configuration.
key_name: string
Name of the key within the vault.
tenant_id: string
Azure AD tenant ID.
type: "azure"
vault_uri: string
Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`.
client_id: optional string or null
Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory.
display_name: optional string or null
Human-friendly display name.
maxLength255
minLength1
geo: optional "us"
Data residency geo. Only `us` is supported.
##### Returns
id: string
Identifier of the external key config. A tagged ID prefixed `ekey_`, or — for organizations on the Claude Platform on AWS — the AWS KMS key ARN.
attachment: object{ type } or object{ type }
Whether any workspace uses this config to encrypt its data — counting live and archived workspaces (an archived workspace's data remains encrypted under the config), excluding deleted ones. Only an attached config is used by the encryption path; an `unattached` config is inert and can be deleted.
One of the following:
Attached object{ type }
type: "attached"
defaultattached
Unattached object{ type }
type: "unattached"
defaultunattached
created_at: string
formatdate-time
display_name: string or null
Human-friendly display name. Null if none was set.
geo: string
Data residency geo. Selects which regional validator handles this key's encrypt/decrypt roundtrips.
provider_config: object{ kms_arn, type, region, role_arn } or object{ key_name, type } or object{ key_name, tenant_id, type, 2 more }
KMS provider identity and auth coordinates.
One of the following:
Aws object{ kms_arn, type, region, role_arn }
kms_arn: string
Full ARN of the AWS KMS key. On Claude Platform on AWS the key must be a single-Region key in your organization's own AWS account; cross-account keys, multi-Region keys, and alias ARNs are rejected.
maxLength2048
type: "aws"
region: optional string or null
AWS region. Derived from `kms_arn` if omitted.
role_arn: optional string or nullDeprecated
IAM role ARN. Deprecated — Anthropic reaches the KMS key through its own intermediate role (or, on Claude Platform on AWS, with credentials AWS issues for the Workspace); this field is ignored.
Gcp object{ key_name, type }
key_name: string
Full resource name of the Cloud KMS key.
type: "gcp"
Azure object{ key_name, tenant_id, type, 2 more }
key_name: string
Name of the key within the vault.
tenant_id: string
Azure AD tenant ID.
type: "azure"
vault_uri: string
Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`.
client_id: optional string or null
Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory.
type: "external_key"
defaultexternal_key
updated_at: string
formatdate-time
Create External Key
cURL
```python
curl https://api.anthropic.com/v1/organizations/external_keys \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN" \
-d '{
"provider_config": {
"kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222",
"type": "aws"
}
}'
```
Response 200
```python
{
"id": "ekey_01SDCCSbTxrXDpWc1phhtcfK",
"attachment": {
"type": "attached"
},
"created_at": "2024-10-30T23:58:27.427722Z",
"display_name": "prod-us-key",
"geo": "us",
"provider_config": {
"kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222",
"type": "aws",
"region": "us-east-1",
"role_arn": "arn:aws:iam::111122223333:role/anthropic-cmek"
},
"type": "external_key",
"updated_at": "2024-10-30T23:58:27.427722Z"
}
```
##### Returns Examples
Response 200
```python
{
"id": "ekey_01SDCCSbTxrXDpWc1phhtcfK",
"attachment": {
"type": "attached"
},
"created_at": "2024-10-30T23:58:27.427722Z",
"display_name": "prod-us-key",
"geo": "us",
"provider_config": {
"kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222",
"type": "aws",
"region": "us-east-1",
"role_arn": "arn:aws:iam::111122223333:role/anthropic-cmek"
},
"type": "external_key",
"updated_at": "2024-10-30T23:58:27.427722Z"
---
## Delete External Key - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/external_keys/delete
Path: 04-API-Reference/Admin/admin-external-keys-delete.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Fexternal_keys%2Fdelete)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
API Keys
External Keys
Create External Key
List External Keys
Get External Key
Update External Key
Delete External Key
Validate External Key
Usage Report
Cost Report
Analytics
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [External Keys](https://platform.claude.com/docs/en/api/http/admin/external_keys)
# Delete External Key
DELETE/v1/organizations/external_keys/{external_key_id}
Delete an external key config.
The request is rejected if any workspace still references this config.
##### Path parameters
external_key_id: string
ID of the External Key.
maxLength2048
##### Returns
id: string
ID of the deleted External Key.
type: "external_key_deleted"
defaultexternal_key_deleted
Delete External Key
cURL
```python
curl https://api.anthropic.com/v1/organizations/external_keys/$EXTERNAL_KEY_ID \
-X DELETE \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
```
Response 200
```python
{
"id": "ekey_01AbCdEfGhIjKlMnOpQrStUv",
"type": "external_key_deleted"
}
```
##### Returns Examples
Response 200
```python
{
"id": "ekey_01AbCdEfGhIjKlMnOpQrStUv",
"type": "external_key_deleted"
---
## List External Keys - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/external_keys/list
Path: 04-API-Reference/Admin/admin-external-keys-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Fexternal_keys%2Flist)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
API Keys
External Keys
Create External Key
List External Keys
Get External Key
Update External Key
Delete External Key
Validate External Key
Usage Report
Cost Report
Analytics
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [External Keys](https://platform.claude.com/docs/en/api/http/admin/external_keys)
# List External Keys
GET/v1/organizations/external_keys
List external key configs in the caller's organization.
Results are ordered by creation time (newest first). Use the `next_page` cursor from the response to fetch subsequent pages.
##### Query parameters
limit: optional number
Number of results per page.
default20
maximum100
minimum1
page: optional string
Opaque cursor from a previous response's `next_page`.
##### Returns
data: array of object{ id, attachment, created_at, 5 more }
id: string
Identifier of the external key config. A tagged ID prefixed `ekey_`, or — for organizations on the Claude Platform on AWS — the AWS KMS key ARN.
attachment: object{ type } or object{ type }
Whether any workspace uses this config to encrypt its data — counting live and archived workspaces (an archived workspace's data remains encrypted under the config), excluding deleted ones. Only an attached config is used by the encryption path; an `unattached` config is inert and can be deleted.
One of the following:
Attached object{ type }
type: "attached"
defaultattached
Unattached object{ type }
type: "unattached"
defaultunattached
created_at: string
formatdate-time
display_name: string or null
Human-friendly display name. Null if none was set.
geo: string
Data residency geo. Selects which regional validator handles this key's encrypt/decrypt roundtrips.
provider_config: object{ kms_arn, type, region, role_arn } or object{ key_name, type } or object{ key_name, tenant_id, type, 2 more }
KMS provider identity and auth coordinates.
One of the following:
Aws object{ kms_arn, type, region, role_arn }
kms_arn: string
Full ARN of the AWS KMS key. On Claude Platform on AWS the key must be a single-Region key in your organization's own AWS account; cross-account keys, multi-Region keys, and alias ARNs are rejected.
maxLength2048
type: "aws"
region: optional string or null
AWS region. Derived from `kms_arn` if omitted.
role_arn: optional string or nullDeprecated
IAM role ARN. Deprecated — Anthropic reaches the KMS key through its own intermediate role (or, on Claude Platform on AWS, with credentials AWS issues for the Workspace); this field is ignored.
Gcp object{ key_name, type }
key_name: string
Full resource name of the Cloud KMS key.
type: "gcp"
Azure object{ key_name, tenant_id, type, 2 more }
key_name: string
Name of the key within the vault.
tenant_id: string
Azure AD tenant ID.
type: "azure"
vault_uri: string
Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`.
client_id: optional string or null
Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory.
type: "external_key"
defaultexternal_key
updated_at: string
formatdate-time
next_page: string or null
Opaque cursor for the next page, or null if no more results. Pass as `?page=` to fetch the next page.
List External Keys
cURL
```python
curl https://api.anthropic.com/v1/organizations/external_keys \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
```
Response 200
```python
{
"data": [
{
"id": "ekey_01SDCCSbTxrXDpWc1phhtcfK",
"attachment": {
"type": "attached"
},
"created_at": "2024-10-30T23:58:27.427722Z",
"display_name": "prod-us-key",
"geo": "us",
"provider_config": {
"kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222",
"type": "aws",
"region": "us-east-1",
"role_arn": "arn:aws:iam::111122223333:role/anthropic-cmek"
},
"type": "external_key",
"updated_at": "2024-10-30T23:58:27.427722Z"
}
],
"next_page": "next_page"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"id": "ekey_01SDCCSbTxrXDpWc1phhtcfK",
"attachment": {
"type": "attached"
},
"created_at": "2024-10-30T23:58:27.427722Z",
"display_name": "prod-us-key",
"geo": "us",
"provider_config": {
"kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222",
"type": "aws",
"region": "us-east-1",
"role_arn": "arn:aws:iam::111122223333:role/anthropic-cmek"
},
"type": "external_key",
"updated_at": "2024-10-30T23:58:27.427722Z"
---
## Get External Key - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/external_keys/retrieve
Path: 04-API-Reference/Admin/admin-external-keys-retrieve.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Fexternal_keys%2Fretrieve)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
API Keys
External Keys
Create External Key
List External Keys
Get External Key
Update External Key
Delete External Key
Validate External Key
Usage Report
Cost Report
Analytics
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [External Keys](https://platform.claude.com/docs/en/api/http/admin/external_keys)
# Get External Key
GET/v1/organizations/external_keys/{external_key_id}
Retrieve a single external key config in the caller's organization by ID.
##### Path parameters
external_key_id: string
ID of the External Key.
maxLength2048
##### Returns
id: string
Identifier of the external key config. A tagged ID prefixed `ekey_`, or — for organizations on the Claude Platform on AWS — the AWS KMS key ARN.
attachment: object{ type } or object{ type }
Whether any workspace uses this config to encrypt its data — counting live and archived workspaces (an archived workspace's data remains encrypted under the config), excluding deleted ones. Only an attached config is used by the encryption path; an `unattached` config is inert and can be deleted.
One of the following:
Attached object{ type }
type: "attached"
defaultattached
Unattached object{ type }
type: "unattached"
defaultunattached
created_at: string
formatdate-time
display_name: string or null
Human-friendly display name. Null if none was set.
geo: string
Data residency geo. Selects which regional validator handles this key's encrypt/decrypt roundtrips.
provider_config: object{ kms_arn, type, region, role_arn } or object{ key_name, type } or object{ key_name, tenant_id, type, 2 more }
KMS provider identity and auth coordinates.
One of the following:
Aws object{ kms_arn, type, region, role_arn }
kms_arn: string
Full ARN of the AWS KMS key. On Claude Platform on AWS the key must be a single-Region key in your organization's own AWS account; cross-account keys, multi-Region keys, and alias ARNs are rejected.
maxLength2048
type: "aws"
region: optional string or null
AWS region. Derived from `kms_arn` if omitted.
role_arn: optional string or nullDeprecated
IAM role ARN. Deprecated — Anthropic reaches the KMS key through its own intermediate role (or, on Claude Platform on AWS, with credentials AWS issues for the Workspace); this field is ignored.
Gcp object{ key_name, type }
key_name: string
Full resource name of the Cloud KMS key.
type: "gcp"
Azure object{ key_name, tenant_id, type, 2 more }
key_name: string
Name of the key within the vault.
tenant_id: string
Azure AD tenant ID.
type: "azure"
vault_uri: string
Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`.
client_id: optional string or null
Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory.
type: "external_key"
defaultexternal_key
updated_at: string
formatdate-time
Get External Key
cURL
```python
curl https://api.anthropic.com/v1/organizations/external_keys/$EXTERNAL_KEY_ID \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
```
Response 200
```python
{
"id": "ekey_01SDCCSbTxrXDpWc1phhtcfK",
"attachment": {
"type": "attached"
},
"created_at": "2024-10-30T23:58:27.427722Z",
"display_name": "prod-us-key",
"geo": "us",
"provider_config": {
"kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222",
"type": "aws",
"region": "us-east-1",
"role_arn": "arn:aws:iam::111122223333:role/anthropic-cmek"
},
"type": "external_key",
"updated_at": "2024-10-30T23:58:27.427722Z"
}
```
##### Returns Examples
Response 200
```python
{
"id": "ekey_01SDCCSbTxrXDpWc1phhtcfK",
"attachment": {
"type": "attached"
},
"created_at": "2024-10-30T23:58:27.427722Z",
"display_name": "prod-us-key",
"geo": "us",
"provider_config": {
"kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222",
"type": "aws",
"region": "us-east-1",
"role_arn": "arn:aws:iam::111122223333:role/anthropic-cmek"
},
"type": "external_key",
"updated_at": "2024-10-30T23:58:27.427722Z"
---
## Update External Key - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/external_keys/update
Path: 04-API-Reference/Admin/admin-external-keys-update.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Fexternal_keys%2Fupdate)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
API Keys
External Keys
Create External Key
List External Keys
Get External Key
Update External Key
Delete External Key
Validate External Key
Usage Report
Cost Report
Analytics
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [External Keys](https://platform.claude.com/docs/en/api/http/admin/external_keys)
# Update External Key
POST/v1/organizations/external_keys/{external_key_id}
Partially update an external key config. Omitted fields are left unchanged.
`display_name` is always editable. `geo` and `provider_config` cannot be changed once any workspace references this config, because previously encrypted data requires the original key identity to decrypt.
##### Path parameters
external_key_id: string
ID of the External Key.
maxLength2048
##### Body
display_name: optional string or null
Human-friendly display name.
maxLength255
minLength1
geo: optional "us" or null
Data residency geo. Only `us` is supported.
provider_config: optional object{ kms_arn, type, region, role_arn } or object{ key_name, type } or object{ key_name, tenant_id, type, 2 more } or null
KMS provider identity and auth coordinates.
One of the following:
Aws object{ kms_arn, type, region, role_arn }
kms_arn: string
Full ARN of the AWS KMS key. On Claude Platform on AWS the key must be a single-Region key in your organization's own AWS account; cross-account keys, multi-Region keys, and alias ARNs are rejected.
maxLength2048
type: "aws"
region: optional string or null
AWS region. Derived from `kms_arn` if omitted.
role_arn: optional string or nullDeprecated
IAM role ARN. Deprecated — Anthropic reaches the KMS key through its own intermediate role (or, on Claude Platform on AWS, with credentials AWS issues for the Workspace); this field is ignored.
Gcp object{ key_name, type }
key_name: string
Full resource name of the Cloud KMS key.
type: "gcp"
Azure object{ key_name, tenant_id, type, 2 more }
Azure Key Vault provider configuration.
key_name: string
Name of the key within the vault.
tenant_id: string
Azure AD tenant ID.
type: "azure"
vault_uri: string
Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`.
client_id: optional string or null
Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory.
##### Returns
id: string
Identifier of the external key config. A tagged ID prefixed `ekey_`, or — for organizations on the Claude Platform on AWS — the AWS KMS key ARN.
attachment: object{ type } or object{ type }
Whether any workspace uses this config to encrypt its data — counting live and archived workspaces (an archived workspace's data remains encrypted under the config), excluding deleted ones. Only an attached config is used by the encryption path; an `unattached` config is inert and can be deleted.
One of the following:
Attached object{ type }
type: "attached"
defaultattached
Unattached object{ type }
type: "unattached"
defaultunattached
created_at: string
formatdate-time
display_name: string or null
Human-friendly display name. Null if none was set.
geo: string
Data residency geo. Selects which regional validator handles this key's encrypt/decrypt roundtrips.
provider_config: object{ kms_arn, type, region, role_arn } or object{ key_name, type } or object{ key_name, tenant_id, type, 2 more }
KMS provider identity and auth coordinates.
One of the following:
Aws object{ kms_arn, type, region, role_arn }
kms_arn: string
Full ARN of the AWS KMS key. On Claude Platform on AWS the key must be a single-Region key in your organization's own AWS account; cross-account keys, multi-Region keys, and alias ARNs are rejected.
maxLength2048
type: "aws"
region: optional string or null
AWS region. Derived from `kms_arn` if omitted.
role_arn: optional string or nullDeprecated
IAM role ARN. Deprecated — Anthropic reaches the KMS key through its own intermediate role (or, on Claude Platform on AWS, with credentials AWS issues for the Workspace); this field is ignored.
Gcp object{ key_name, type }
key_name: string
Full resource name of the Cloud KMS key.
type: "gcp"
Azure object{ key_name, tenant_id, type, 2 more }
key_name: string
Name of the key within the vault.
tenant_id: string
Azure AD tenant ID.
type: "azure"
vault_uri: string
Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`.
client_id: optional string or null
Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory.
type: "external_key"
defaultexternal_key
updated_at: string
formatdate-time
Update External Key
cURL
```python
curl https://api.anthropic.com/v1/organizations/external_keys/$EXTERNAL_KEY_ID \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN" \
-d '{}'
```
Response 200
```python
{
"id": "ekey_01SDCCSbTxrXDpWc1phhtcfK",
"attachment": {
"type": "attached"
},
"created_at": "2024-10-30T23:58:27.427722Z",
"display_name": "prod-us-key",
"geo": "us",
"provider_config": {
"kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222",
"type": "aws",
"region": "us-east-1",
"role_arn": "arn:aws:iam::111122223333:role/anthropic-cmek"
},
"type": "external_key",
"updated_at": "2024-10-30T23:58:27.427722Z"
}
```
##### Returns Examples
Response 200
```python
{
"id": "ekey_01SDCCSbTxrXDpWc1phhtcfK",
"attachment": {
"type": "attached"
},
"created_at": "2024-10-30T23:58:27.427722Z",
"display_name": "prod-us-key",
"geo": "us",
"provider_config": {
"kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222",
"type": "aws",
"region": "us-east-1",
"role_arn": "arn:aws:iam::111122223333:role/anthropic-cmek"
},
"type": "external_key",
"updated_at": "2024-10-30T23:58:27.427722Z"
---
## Validate External Key - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/external_keys/validate
Path: 04-API-Reference/Admin/admin-external-keys-validate.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Fexternal_keys%2Fvalidate)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
API Keys
External Keys
Create External Key
List External Keys
Get External Key
Update External Key
Delete External Key
Validate External Key
Usage Report
Cost Report
Analytics
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [External Keys](https://platform.claude.com/docs/en/api/http/admin/external_keys)
# Validate External Key
POST/v1/organizations/external_keys/{external_key_id}/validate
Validate an external key config against the customer's KMS.
Anthropic performs an encrypt/decrypt roundtrip against the configured KMS key and waits up to 30 seconds for the result. The response status is `success` if the roundtrip succeeded, or `failure` with an error message if it failed or timed out.
##### Path parameters
external_key_id: string
ID of the External Key.
maxLength2048
##### Returns
error: string or null
Error message when status is `failure`. Null otherwise.
status: "failure" or "success"
`success` — encrypt/decrypt roundtrip succeeded. `failure` — the roundtrip failed or timed out; see `error`.
One of the following:
"failure"
"success"
type: "external_key_validation"
defaultexternal_key_validation
Validate External Key
cURL
```python
curl https://api.anthropic.com/v1/organizations/external_keys/$EXTERNAL_KEY_ID/validate \
-X POST \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
```
Response 200
```python
{
"error": null,
"status": "success",
"type": "external_key_validation"
}
```
##### Returns Examples
Response 200
```python
{
"error": null,
"status": "success",
"type": "external_key_validation"
---
## External Keys - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/external_keys
Path: 04-API-Reference/Admin/admin-external-keys.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Fexternal_keys)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
API Keys
External Keys
Create External Key
List External Keys
Get External Key
Update External Key
Delete External Key
Validate External Key
Usage Report
Cost Report
Analytics
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
# External Keys
##### [Create External Key](https://platform.claude.com/docs/en/api/http/admin/external_keys/create)
POST/v1/organizations/external_keys
##### [List External Keys](https://platform.claude.com/docs/en/api/http/admin/external_keys/list)
GET/v1/organizations/external_keys
##### [Get External Key](https://platform.claude.com/docs/en/api/http/admin/external_keys/retrieve)
GET/v1/organizations/external_keys/{external_key_id}
##### [Update External Key](https://platform.claude.com/docs/en/api/http/admin/external_keys/update)
POST/v1/organizations/external_keys/{external_key_id}
##### [Delete External Key](https://platform.claude.com/docs/en/api/http/admin/external_keys/delete)
DELETE/v1/organizations/external_keys/{external_key_id}
##### [Validate External Key](https://platform.claude.com/docs/en/api/http/admin/external_keys/validate)
POST/v1/organizations/external_keys/{external_key_id}/validate
##### Models
ExternalKeyCreateResponse object{ id, attachment, created_at, 5 more }
CMEK external key config belonging to the caller's organization.
Configs are organization-scoped. Workspaces attach to a config; once any workspace references it, the provider fields become effectively immutable (existing encrypted data needs the config for decrypt).
ExternalKeyRetrieveResponse object{ id, attachment, created_at, 5 more }
CMEK external key config belonging to the caller's organization.
Configs are organization-scoped. Workspaces attach to a config; once any workspace references it, the provider fields become effectively immutable (existing encrypted data needs the config for decrypt).
ExternalKeyUpdateResponse object{ id, attachment, created_at, 5 more }
CMEK external key config belonging to the caller's organization.
Configs are organization-scoped. Workspaces attach to a config; once any workspace references it, the provider fields become effectively immutable (existing encrypted data needs the config for decrypt).
ExternalKeyListResponse object{ id, attachment, created_at, 5 more }
CMEK external key config belonging to the caller's organization.
Configs are organization-scoped. Workspaces attach to a config; once any workspace references it, the provider fields become effectively immutable (existing encrypted data needs the config for decrypt).
ExternalKeyDeleteResponse object{ id, type }
id: string
ID of the deleted External Key.
type: "external_key_deleted"
defaultexternal_key_deleted
ExternalKeyValidateResponse object{ error, status, type }
Result of a validation roundtrip against the customer's KMS.
HTTP 200 for both outcomes — the operation completed; `status` says whether the key works.
error: string or null
Error message when status is `failure`. Null otherwise.
status: "failure" or "success"
`success` — encrypt/decrypt roundtrip succeeded. `failure` — the roundtrip failed or timed out; see `error`.
One of the following:
"failure"
"success"
type: "external_key_validation"
defaultexternal_key_validation
---
## Archive Federation Issuer - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/federation_issuers/archive
Path: 04-API-Reference/Admin/admin-federation-issuers-archive.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Ffederation_issuers%2Farchive)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
API Keys
External Keys
Usage Report
Cost Report
Analytics
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Create Federation Issuer
Get Federation Issuer
List Federation Issuers
Update Federation Issuer
Archive Federation Issuer
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [Federation Issuers](https://platform.claude.com/docs/en/api/http/admin/federation_issuers)
# Archive Federation Issuer
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](../Other/manage-claude-wif-admin-api.md).
Archive a federation issuer.
Idempotent; re-archiving returns the issuer with its original `archived_at`. Rejected with 400 if any live (non-archived) federation rule still references the issuer; archive those rules first (a rule's issuer cannot be changed), or recreate them against another issuer.
##### Path parameters
federation_issuer_id: string
ID of the federation issuer to archive.
##### Headers
"anthropic-beta": optional array of string
Optional header to specify the beta version(s) you want to use.
To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta.
##### Returns
FederationIssuer object{ id, archived_at, archived_by_actor_id, 12 more }
Registered external OIDC identity provider.
Records an external IdP the organization trusts for the RFC 7523 jwt-bearer grant. The `issuer_url` must match the JWT `iss` claim exactly.
Archive Federation Issuer
cURL
```python
curl https://api.anthropic.com/v1/organizations/federation_issuers/$FEDERATION_ISSUER_ID/archive \
-X POST \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
```
Response 200
```python
{
"id": "fdis_01SDCCSbTxrXDpWc1phhtcfK",
"archived_at": "2019-12-27T18:11:19.117Z",
"archived_by_actor_id": "archived_by_actor_id",
"check_jti": true,
"created_at": "2024-10-30T23:58:27.427722Z",
"created_by_actor_id": "created_by_actor_id",
"issuer_url": "https://token.actions.githubusercontent.com",
"jwks": {
"type": "discovery",
"ca_cert_pem": "ca_cert_pem",
"discovery_base": "discovery_base"
},
"jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z",
"max_jwt_lifetime_seconds": 0,
"name": "github-actions",
"poll_status": {
"consecutive_failures": 0,
"last_fetched_at": "2019-12-27T18:11:19.117Z",
"next_poll_at": "2019-12-27T18:11:19.117Z"
},
"type": "federation_issuer",
"updated_at": "2024-10-30T23:58:27.427722Z",
"updated_by_actor_id": "updated_by_actor_id"
}
```
##### Returns Examples
Response 200
```python
{
"id": "fdis_01SDCCSbTxrXDpWc1phhtcfK",
"archived_at": "2019-12-27T18:11:19.117Z",
"archived_by_actor_id": "archived_by_actor_id",
"check_jti": true,
"created_at": "2024-10-30T23:58:27.427722Z",
"created_by_actor_id": "created_by_actor_id",
"issuer_url": "https://token.actions.githubusercontent.com",
"jwks": {
"type": "discovery",
"ca_cert_pem": "ca_cert_pem",
"discovery_base": "discovery_base"
},
"jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z",
"max_jwt_lifetime_seconds": 0,
"name": "github-actions",
"poll_status": {
"consecutive_failures": 0,
"last_fetched_at": "2019-12-27T18:11:19.117Z",
"next_poll_at": "2019-12-27T18:11:19.117Z"
},
"type": "federation_issuer",
"updated_at": "2024-10-30T23:58:27.427722Z",
"updated_by_actor_id": "updated_by_actor_id"
---
## Create Federation Issuer - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/federation_issuers/create
Path: 04-API-Reference/Admin/admin-federation-issuers-create.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Ffederation_issuers%2Fcreate)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
API Keys
External Keys
Usage Report
Cost Report
Analytics
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Create Federation Issuer
Get Federation Issuer
List Federation Issuers
Update Federation Issuer
Archive Federation Issuer
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [Federation Issuers](https://platform.claude.com/docs/en/api/http/admin/federation_issuers)
# Create Federation Issuer
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](../Other/manage-claude-wif-admin-api.md).
Register an OIDC issuer that Anthropic will trust for workload identity federation in your organization.
The `jwks` field controls how the issuer's signing keys are obtained and takes one of three shapes selected by `type`: `discovery` (resolve keys through OIDC discovery), `explicit_url` (fetch keys from a fixed JWKS URL), or `inline` (provide a static key set). When `jwks.type` is `discovery` and no `discovery_base` is set, the issuer URL must be publicly reachable over HTTPS so Anthropic can fetch the discovery document; for `explicit_url` and `inline` modes the issuer URL is only matched as the JWT's `iss` claim and is not fetched.
##### Headers
"anthropic-beta": optional array of string
Optional header to specify the beta version(s) you want to use.
To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta.
##### Body
issuer_url: string
The `iss` claim value to match against.
minLength1
name: string
Slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409.
maxLength255
minLength1
check_jti: optional boolean or null
Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Defaults to true. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement.
jwks: optional object{ type, ca_cert_pem, discovery_base } or object{ type, url, ca_cert_pem } or object{ keys, type }
How signing keys are obtained. Defaults to OIDC discovery.
One of the following:
Discovery object{ type, ca_cert_pem, discovery_base }
JWKS via the issuer's OIDC discovery document.
type: "discovery"
ca_cert_pem: optional string or null
Optional custom CA (PEM) for TLS verification of the JWKS fetch.
maxLength8192
discovery_base: optional string or null
Set when the discovery URL differs from `issuer_url`.
ExplicitURL object{ type, url, ca_cert_pem }
JWKS fetched from a fixed endpoint.
type: "explicit_url"
url: string
JWKS endpoint.
minLength1
ca_cert_pem: optional string or null
Optional custom CA (PEM) for TLS verification of the JWKS fetch.
maxLength8192
Inline object{ keys, type }
JWKS supplied directly; no network fetch.
keys: array of map\[unknown\]
Inline JWK objects.
minItems1
type: "inline"
max_jwt_lifetime_seconds: optional number or null
Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Defaults to 3600 (1h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected.
maximum176400
exclusiveMinimum0
##### Returns
FederationIssuer object{ id, archived_at, archived_by_actor_id, 12 more }
Registered external OIDC identity provider.
Records an external IdP the organization trusts for the RFC 7523 jwt-bearer grant. The `issuer_url` must match the JWT `iss` claim exactly.
Create Federation Issuer
cURL
```python
curl https://api.anthropic.com/v1/organizations/federation_issuers \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN" \
-d '{
"issuer_url": "x",
"name": "x"
}'
```
Response 200
```python
{
"id": "fdis_01SDCCSbTxrXDpWc1phhtcfK",
"archived_at": "2019-12-27T18:11:19.117Z",
"archived_by_actor_id": "archived_by_actor_id",
"check_jti": true,
"created_at": "2024-10-30T23:58:27.427722Z",
"created_by_actor_id": "created_by_actor_id",
"issuer_url": "https://token.actions.githubusercontent.com",
"jwks": {
"type": "discovery",
"ca_cert_pem": "ca_cert_pem",
"discovery_base": "discovery_base"
},
"jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z",
"max_jwt_lifetime_seconds": 0,
"name": "github-actions",
"poll_status": {
"consecutive_failures": 0,
"last_fetched_at": "2019-12-27T18:11:19.117Z",
"next_poll_at": "2019-12-27T18:11:19.117Z"
},
"type": "federation_issuer",
"updated_at": "2024-10-30T23:58:27.427722Z",
"updated_by_actor_id": "updated_by_actor_id"
}
```
##### Returns Examples
Response 200
```python
{
"id": "fdis_01SDCCSbTxrXDpWc1phhtcfK",
"archived_at": "2019-12-27T18:11:19.117Z",
"archived_by_actor_id": "archived_by_actor_id",
"check_jti": true,
"created_at": "2024-10-30T23:58:27.427722Z",
"created_by_actor_id": "created_by_actor_id",
"issuer_url": "https://token.actions.githubusercontent.com",
"jwks": {
"type": "discovery",
"ca_cert_pem": "ca_cert_pem",
"discovery_base": "discovery_base"
},
"jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z",
"max_jwt_lifetime_seconds": 0,
"name": "github-actions",
"poll_status": {
"consecutive_failures": 0,
"last_fetched_at": "2019-12-27T18:11:19.117Z",
"next_poll_at": "2019-12-27T18:11:19.117Z"
},
"type": "federation_issuer",
"updated_at": "2024-10-30T23:58:27.427722Z",
"updated_by_actor_id": "updated_by_actor_id"
---
## List Federation Issuers - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/federation_issuers/list
Path: 04-API-Reference/Admin/admin-federation-issuers-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Ffederation_issuers%2Flist)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
API Keys
External Keys
Usage Report
Cost Report
Analytics
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Create Federation Issuer
Get Federation Issuer
List Federation Issuers
Update Federation Issuer
Archive Federation Issuer
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [Federation Issuers](https://platform.claude.com/docs/en/api/http/admin/federation_issuers)
# List Federation Issuers
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](../Other/manage-claude-wif-admin-api.md).
List federation issuers in your organization.
Archived issuers are excluded unless `include_archived=true`.
##### Query parameters
include_archived: optional boolean
Include archived resources. Defaults to false.
defaultfalse
limit: optional number
Number of results per page.
default20
maximum100
minimum1
page: optional string
Opaque cursor from a previous response's `next_page`.
##### Headers
"anthropic-beta": optional array of string
Optional header to specify the beta version(s) you want to use.
To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta.
##### Returns
data: array of [FederationIssuer](https://platform.claude.com/docs/en/api/http/admin/federation_issuers#federation_issuer) { id, archived_at, archived_by_actor_id, 12 more }
id: string
Tagged ID of the federation issuer.
archived_at: string or null
If set, all rules referencing this issuer reject token exchange.
formatdate-time
archived_by_actor_id: string or null
Tagged ID (`user_`/`svac_`) of the actor that archived this issuer.
check_jti: boolean
Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement.
created_at: string
When this issuer was created.
formatdate-time
created_by_actor_id: string or null
Tagged ID (`user_`/`svac_`) of the actor that created this issuer.
issuer_url: string
The `iss` claim value. Incoming JWTs must match exactly.
jwks: object{ type, ca_cert_pem, discovery_base } or object{ type, url, ca_cert_pem } or object{ keys, type }
How signing keys are obtained for signature verification.
One of the following:
Discovery object{ type, ca_cert_pem, discovery_base }
JWKS via the issuer's OIDC discovery document.
type: "discovery"
ca_cert_pem: optional string or null
Optional custom CA (PEM) for TLS verification of the JWKS fetch.
maxLength8192
discovery_base: optional string or null
Set when the discovery URL differs from `issuer_url`.
ExplicitURL object{ type, url, ca_cert_pem }
JWKS fetched from a fixed endpoint.
type: "explicit_url"
url: string
JWKS endpoint.
minLength1
ca_cert_pem: optional string or null
Optional custom CA (PEM) for TLS verification of the JWKS fetch.
maxLength8192
Inline object{ keys, type }
JWKS supplied directly; no network fetch.
keys: array of map\[unknown\]
Inline JWK objects.
minItems1
type: "inline"
jwks_polling_disabled_at: string or null
If set, Anthropic's JWKS poller has paused polling for this issuer after repeated fetch failures. Re-enable by sending `jwks_polling_disabled: false` via the issuer update endpoint (POST) once the upstream JWKS endpoint is fixed. An OAuth caller cannot send this when the issuer backs a rule with any scope other than `workspace:developer` or `workspace:inference`; use a Console session.
formatdate-time
max_jwt_lifetime_seconds: number
Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected.
name: string
Admin-chosen slug identifier.
poll_status: object{ consecutive_failures, last_fetched_at, next_poll_at } or null
Status of automatic JWKS polling for a federation issuer.
Anthropic periodically fetches the issuer's signing keys in the background. These fields summarize the most recent fetches so the health of the JWKS endpoint can be monitored.
consecutive_failures: number
Consecutive fetch failures since the last success.
last_fetched_at: string or null
When the last successful fetch completed.
formatdate-time
next_poll_at: string or null
When the next fetch is scheduled. Null if paused.
formatdate-time
type: "federation_issuer"
defaultfederation_issuer
updated_at: string
When this issuer was last updated.
formatdate-time
updated_by_actor_id: string or null
Tagged ID (`user_`/`svac_`) of the actor that last updated this issuer.
next_page: string or null
Opaque cursor for the next page, or null if no more results.
List Federation Issuers
cURL
```python
curl https://api.anthropic.com/v1/organizations/federation_issuers \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
```
Response 200
```python
{
"data": [
{
"id": "fdis_01SDCCSbTxrXDpWc1phhtcfK",
"archived_at": "2019-12-27T18:11:19.117Z",
"archived_by_actor_id": "archived_by_actor_id",
"check_jti": true,
"created_at": "2024-10-30T23:58:27.427722Z",
"created_by_actor_id": "created_by_actor_id",
"issuer_url": "https://token.actions.githubusercontent.com",
"jwks": {
"type": "discovery",
"ca_cert_pem": "ca_cert_pem",
"discovery_base": "discovery_base"
},
"jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z",
"max_jwt_lifetime_seconds": 0,
"name": "github-actions",
"poll_status": {
"consecutive_failures": 0,
"last_fetched_at": "2019-12-27T18:11:19.117Z",
"next_poll_at": "2019-12-27T18:11:19.117Z"
},
"type": "federation_issuer",
"updated_at": "2024-10-30T23:58:27.427722Z",
"updated_by_actor_id": "updated_by_actor_id"
}
],
"next_page": "next_page"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"id": "fdis_01SDCCSbTxrXDpWc1phhtcfK",
"archived_at": "2019-12-27T18:11:19.117Z",
"archived_by_actor_id": "archived_by_actor_id",
"check_jti": true,
"created_at": "2024-10-30T23:58:27.427722Z",
"created_by_actor_id": "created_by_actor_id",
"issuer_url": "https://token.actions.githubusercontent.com",
"jwks": {
"type": "discovery",
"ca_cert_pem": "ca_cert_pem",
"discovery_base": "discovery_base"
},
"jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z",
"max_jwt_lifetime_seconds": 0,
"name": "github-actions",
"poll_status": {
"consecutive_failures": 0,
"last_fetched_at": "2019-12-27T18:11:19.117Z",
"next_poll_at": "2019-12-27T18:11:19.117Z"
},
"type": "federation_issuer",
"updated_at": "2024-10-30T23:58:27.427722Z",
"updated_by_actor_id": "updated_by_actor_id"
---
## Get Federation Issuer - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/federation_issuers/retrieve
Path: 04-API-Reference/Admin/admin-federation-issuers-retrieve.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Ffederation_issuers%2Fretrieve)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
API Keys
External Keys
Usage Report
Cost Report
Analytics
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Create Federation Issuer
Get Federation Issuer
List Federation Issuers
Update Federation Issuer
Archive Federation Issuer
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [Federation Issuers](https://platform.claude.com/docs/en/api/http/admin/federation_issuers)
# Get Federation Issuer
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](../Other/manage-claude-wif-admin-api.md).
Retrieve a federation issuer by its ID (`fdis_...`).
##### Path parameters
federation_issuer_id: string
ID of the federation issuer.
##### Headers
"anthropic-beta": optional array of string
Optional header to specify the beta version(s) you want to use.
To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta.
##### Returns
FederationIssuer object{ id, archived_at, archived_by_actor_id, 12 more }
Registered external OIDC identity provider.
Records an external IdP the organization trusts for the RFC 7523 jwt-bearer grant. The `issuer_url` must match the JWT `iss` claim exactly.
Get Federation Issuer
cURL
```python
curl https://api.anthropic.com/v1/organizations/federation_issuers/$FEDERATION_ISSUER_ID \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
```
Response 200
```python
{
"id": "fdis_01SDCCSbTxrXDpWc1phhtcfK",
"archived_at": "2019-12-27T18:11:19.117Z",
"archived_by_actor_id": "archived_by_actor_id",
"check_jti": true,
"created_at": "2024-10-30T23:58:27.427722Z",
"created_by_actor_id": "created_by_actor_id",
"issuer_url": "https://token.actions.githubusercontent.com",
"jwks": {
"type": "discovery",
"ca_cert_pem": "ca_cert_pem",
"discovery_base": "discovery_base"
},
"jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z",
"max_jwt_lifetime_seconds": 0,
"name": "github-actions",
"poll_status": {
"consecutive_failures": 0,
"last_fetched_at": "2019-12-27T18:11:19.117Z",
"next_poll_at": "2019-12-27T18:11:19.117Z"
},
"type": "federation_issuer",
"updated_at": "2024-10-30T23:58:27.427722Z",
"updated_by_actor_id": "updated_by_actor_id"
}
```
##### Returns Examples
Response 200
```python
{
"id": "fdis_01SDCCSbTxrXDpWc1phhtcfK",
"archived_at": "2019-12-27T18:11:19.117Z",
"archived_by_actor_id": "archived_by_actor_id",
"check_jti": true,
"created_at": "2024-10-30T23:58:27.427722Z",
"created_by_actor_id": "created_by_actor_id",
"issuer_url": "https://token.actions.githubusercontent.com",
"jwks": {
"type": "discovery",
"ca_cert_pem": "ca_cert_pem",
"discovery_base": "discovery_base"
},
"jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z",
"max_jwt_lifetime_seconds": 0,
"name": "github-actions",
"poll_status": {
"consecutive_failures": 0,
"last_fetched_at": "2019-12-27T18:11:19.117Z",
"next_poll_at": "2019-12-27T18:11:19.117Z"
},
"type": "federation_issuer",
"updated_at": "2024-10-30T23:58:27.427722Z",
"updated_by_actor_id": "updated_by_actor_id"
---
## Update Federation Issuer - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/federation_issuers/update
Path: 04-API-Reference/Admin/admin-federation-issuers-update.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Ffederation_issuers%2Fupdate)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
API Keys
External Keys
Usage Report
Cost Report
Analytics
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Create Federation Issuer
Get Federation Issuer
List Federation Issuers
Update Federation Issuer
Archive Federation Issuer
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [Federation Issuers](https://platform.claude.com/docs/en/api/http/admin/federation_issuers)
# Update Federation Issuer
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](../Other/manage-claude-wif-admin-api.md).
Partially update a federation issuer.
Setting `jwks` replaces the full JWKS shape at once. Archived issuers cannot be updated; this returns 400. Create a new issuer instead.
Updating an issuer that backs a rule with a scope outside `workspace:developer` or `workspace:inference` requires a Console session.
##### Path parameters
federation_issuer_id: string
ID of the federation issuer to update.
##### Headers
"anthropic-beta": optional array of string
Optional header to specify the beta version(s) you want to use.
To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta.
##### Body
check_jti: optional boolean or null
Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement.
issuer_url: optional string or null
Replaces the `iss` claim value to match against. For discovery-mode issuers without a `discovery_base`, this is also the URL Anthropic fetches the OIDC discovery document and signing keys from, so changing it repoints the JWKS source. Changing the issuer URL to a well-known shared platform is rejected while any live rule under this issuer would not constrain tenant identity.
minLength1
jwks: optional object{ type, ca_cert_pem, discovery_base } or object{ type, url, ca_cert_pem } or object{ keys, type } or null
Replaces the entire JWKS configuration.
One of the following:
Discovery object{ type, ca_cert_pem, discovery_base }
JWKS via the issuer's OIDC discovery document.
type: "discovery"
ca_cert_pem: optional string or null
Optional custom CA (PEM) for TLS verification of the JWKS fetch.
maxLength8192
discovery_base: optional string or null
Set when the discovery URL differs from `issuer_url`.
ExplicitURL object{ type, url, ca_cert_pem }
JWKS fetched from a fixed endpoint.
type: "explicit_url"
url: string
JWKS endpoint.
minLength1
ca_cert_pem: optional string or null
Optional custom CA (PEM) for TLS verification of the JWKS fetch.
maxLength8192
Inline object{ keys, type }
JWKS supplied directly; no network fetch.
keys: array of map\[unknown\]
Inline JWK objects.
minItems1
type: "inline"
jwks_polling_disabled: optional boolean or null
Only `false` is accepted, to re-enable polling after the system pauses it. Polling is paused automatically; sending `true` is rejected.
max_jwt_lifetime_seconds: optional number or null
Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected.
maximum176400
exclusiveMinimum0
name: optional string or null
Replaces the slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409.
maxLength255
minLength1
##### Returns
FederationIssuer object{ id, archived_at, archived_by_actor_id, 12 more }
Registered external OIDC identity provider.
Records an external IdP the organization trusts for the RFC 7523 jwt-bearer grant. The `issuer_url` must match the JWT `iss` claim exactly.
Update Federation Issuer
cURL
```python
curl https://api.anthropic.com/v1/organizations/federation_issuers/$FEDERATION_ISSUER_ID \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN" \
-d '{}'
```
Response 200
```python
{
"id": "fdis_01SDCCSbTxrXDpWc1phhtcfK",
"archived_at": "2019-12-27T18:11:19.117Z",
"archived_by_actor_id": "archived_by_actor_id",
"check_jti": true,
"created_at": "2024-10-30T23:58:27.427722Z",
"created_by_actor_id": "created_by_actor_id",
"issuer_url": "https://token.actions.githubusercontent.com",
"jwks": {
"type": "discovery",
"ca_cert_pem": "ca_cert_pem",
"discovery_base": "discovery_base"
},
"jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z",
"max_jwt_lifetime_seconds": 0,
"name": "github-actions",
"poll_status": {
"consecutive_failures": 0,
"last_fetched_at": "2019-12-27T18:11:19.117Z",
"next_poll_at": "2019-12-27T18:11:19.117Z"
},
"type": "federation_issuer",
"updated_at": "2024-10-30T23:58:27.427722Z",
"updated_by_actor_id": "updated_by_actor_id"
}
```
##### Returns Examples
Response 200
```python
{
"id": "fdis_01SDCCSbTxrXDpWc1phhtcfK",
"archived_at": "2019-12-27T18:11:19.117Z",
"archived_by_actor_id": "archived_by_actor_id",
"check_jti": true,
"created_at": "2024-10-30T23:58:27.427722Z",
"created_by_actor_id": "created_by_actor_id",
"issuer_url": "https://token.actions.githubusercontent.com",
"jwks": {
"type": "discovery",
"ca_cert_pem": "ca_cert_pem",
"discovery_base": "discovery_base"
},
"jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z",
"max_jwt_lifetime_seconds": 0,
"name": "github-actions",
"poll_status": {
"consecutive_failures": 0,
"last_fetched_at": "2019-12-27T18:11:19.117Z",
"next_poll_at": "2019-12-27T18:11:19.117Z"
},
"type": "federation_issuer",
"updated_at": "2024-10-30T23:58:27.427722Z",
"updated_by_actor_id": "updated_by_actor_id"
---
## Federation Issuers - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/federation_issuers
Path: 04-API-Reference/Admin/admin-federation-issuers.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Ffederation_issuers)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
API Keys
External Keys
Usage Report
Cost Report
Analytics
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Create Federation Issuer
Get Federation Issuer
List Federation Issuers
Update Federation Issuer
Archive Federation Issuer
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
# Federation Issuers
##### [Create Federation Issuer](https://platform.claude.com/docs/en/api/http/admin/federation_issuers/create)
POST/v1/organizations/federation_issuers
##### [Get Federation Issuer](https://platform.claude.com/docs/en/api/http/admin/federation_issuers/retrieve)
GET/v1/organizations/federation_issuers/{federation_issuer_id}
##### [List Federation Issuers](https://platform.claude.com/docs/en/api/http/admin/federation_issuers/list)
GET/v1/organizations/federation_issuers
##### [Update Federation Issuer](https://platform.claude.com/docs/en/api/http/admin/federation_issuers/update)
POST/v1/organizations/federation_issuers/{federation_issuer_id}
##### [Archive Federation Issuer](https://platform.claude.com/docs/en/api/http/admin/federation_issuers/archive)
POST/v1/organizations/federation_issuers/{federation_issuer_id}/archive
##### Models
FederationIssuer object{ id, archived_at, archived_by_actor_id, 12 more }
Registered external OIDC identity provider.
Records an external IdP the organization trusts for the RFC 7523 jwt-bearer grant. The `issuer_url` must match the JWT `iss` claim exactly.
---
## Archive Federation Rule - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/federation_rules/archive
Path: 04-API-Reference/Admin/admin-federation-rules-archive.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Ffederation_rules%2Farchive)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
API Keys
External Keys
Usage Report
Cost Report
Analytics
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
Create Federation Rule
Get Federation Rule
List Federation Rules
Update Federation Rule
Archive Federation Rule
Workspaces
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [Federation Rules](https://platform.claude.com/docs/en/api/http/admin/federation_rules)
# Archive Federation Rule
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](../Other/manage-claude-wif-admin-api.md).
Archive a federation rule.
Token exchange through this rule stops immediately. Idempotent; re-archiving returns the rule with its original `archived_at`. Archiving clears the rule's workspace targeting (`workspace_id` and `workspace_ids` are emptied). Tokens already minted before archive remain valid until they expire. OAuth callers may only manage rules whose `oauth_scope` is `workspace:developer` or `workspace:inference`; other scopes require a Console session.
##### Path parameters
federation_rule_id: string
ID of the federation rule to archive.
##### Headers
"anthropic-beta": optional array of string
Optional header to specify the beta version(s) you want to use.
To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta.
##### Returns
FederationRule object{ id, applies_to_all_workspaces, archived_at, 17 more }
Authorization rule binding an external OIDC identity to Anthropic.
Evaluates the match conditions and mints an OAuth access token for the resolved target, scoped to a single workspace where the rule is enabled (chosen by the caller at exchange time when the rule is enabled for more than one). For rules enabled via `workspace_ids` or `applies_to_all_workspaces`, the target service account must be a member of that workspace (it is implicitly a member of the default workspace); rules carrying only the legacy `workspace_id` binding do not enforce this.
Archive Federation Rule
cURL
```python
curl https://api.anthropic.com/v1/organizations/federation_rules/$FEDERATION_RULE_ID/archive \
-X POST \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
```
Response 200
```python
{
"id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK",
"applies_to_all_workspaces": true,
"archived_at": "2019-12-27T18:11:19.117Z",
"archived_by_actor_id": "archived_by_actor_id",
"attributes": {
"foo": "string"
},
"created_at": "2024-10-30T23:58:27.427722Z",
"created_by_actor_id": "created_by_actor_id",
"description": "description",
"issuer_id": "issuer_id",
"issuer_name": "issuer_name",
"match": {
"audience": "audience",
"claims": {
"foo": "string"
},
"condition": "condition",
"subject_prefix": "subject_prefix"
},
"name": "prod-deploy-pipeline",
"oauth_scope": "oauth_scope",
"target": {
"service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK",
"type": "service_account",
"service_account_name": "service_account_name"
},
"token_lifetime_seconds": 0,
"type": "federation_rule",
"updated_at": "2024-10-30T23:58:27.427722Z",
"updated_by_actor_id": "updated_by_actor_id",
"workspace_id": "workspace_id",
"workspace_ids": [
"string"
]
}
```
##### Returns Examples
Response 200
```python
{
"id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK",
"applies_to_all_workspaces": true,
"archived_at": "2019-12-27T18:11:19.117Z",
"archived_by_actor_id": "archived_by_actor_id",
"attributes": {
"foo": "string"
},
"created_at": "2024-10-30T23:58:27.427722Z",
"created_by_actor_id": "created_by_actor_id",
"description": "description",
"issuer_id": "issuer_id",
"issuer_name": "issuer_name",
"match": {
"audience": "audience",
"claims": {
"foo": "string"
},
"condition": "condition",
"subject_prefix": "subject_prefix"
},
"name": "prod-deploy-pipeline",
"oauth_scope": "oauth_scope",
"target": {
"service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK",
"type": "service_account",
"service_account_name": "service_account_name"
},
"token_lifetime_seconds": 0,
"type": "federation_rule",
"updated_at": "2024-10-30T23:58:27.427722Z",
"updated_by_actor_id": "updated_by_actor_id",
"workspace_id": "workspace_id",
---
## Create Federation Rule - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/federation_rules/create
Path: 04-API-Reference/Admin/admin-federation-rules-create.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Ffederation_rules%2Fcreate)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
API Keys
External Keys
Usage Report
Cost Report
Analytics
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
Create Federation Rule
Get Federation Rule
List Federation Rules
Update Federation Rule
Archive Federation Rule
Workspaces
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [Federation Rules](https://platform.claude.com/docs/en/api/http/admin/federation_rules)
# Create Federation Rule
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](../Other/manage-claude-wif-admin-api.md).
Create a federation rule owned by your organization.
The referenced issuer and the target service account must already exist in the same organization; invalid references are rejected with a 400 error. The workspace reference is validated. Membership is not checked at rule creation: token exchange resolves a single enabled workspace per call and is rejected unless the target service account is a member of that workspace (it is implicitly a member of the default workspace). Rules on well-known shared issuers (GitHub Actions, GitLab, Buildkite, Terraform Cloud, Google) must constrain tenant identity via an identity-bearing claim, a tenant-pinning subject prefix (such as `repo:YOUR_ORG/...`), or a CEL condition referencing one of those identity claims (e.g. `claims.repository_owner`). OAuth callers may only manage rules whose `oauth_scope` is `workspace:developer` or `workspace:inference`; other scopes require a Console session.
##### Headers
"anthropic-beta": optional array of string
Optional header to specify the beta version(s) you want to use.
To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta.
##### Body
issuer_id: string
Tagged ID of the federation issuer.
match: object{ audience, claims, condition, subject_prefix }
Conditions the verified JWT must satisfy for this rule to apply. At least one of `subject_prefix` (other than a wildcard-only value like `*`), `claims`, or `condition` is required; `audience` alone is not sufficient.
audience: optional string or null
Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default.
maxLength1024
claims: optional map\[string\] or null
Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims.
condition: optional string or null
CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400.
maxLength4096
subject_prefix: optional string or null
Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`.
maxLength1024
name: string
Slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409.
maxLength255
minLength1
oauth_scope: string
Space-separated OAuth scopes. OAuth callers may only set `workspace:developer` or `workspace:inference`; other scopes (such as `org:admin`) require a Console session.
minLength1
target: object{ service_account_id, type, service_account_name }
Identity that tokens minted via this rule act as. Currently always a `service_account` target.
service_account_id: string
Tagged ID of the service account to mint tokens for.
type: "service_account"
service_account_name: optional string or null
Service account's display name at read time. Ignored on writes.
applies_to_all_workspaces: optional boolean
When true, enable this rule for every workspace in the org (including workspaces created later).
attributes: optional map\[string\] or null
CEL expressions `{name: expr}` extracting named values from claims. Not yet supported; any non-empty value is rejected with 400.
description: optional string or null
Optional free-text description.
maxLength2000
token_lifetime_seconds: optional number
Lifetime in seconds for access tokens minted via this rule (60-86400). Defaults to 3600 (1h). Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds.
maximum86400
minimum60
workspace_id: optional string or null
Tagged ID of the workspace to enable this rule for. Required unless `applies_to_all_workspaces` is true. Additional workspaces can be added via the `/federation_rules/{federation_rule_id}/workspaces` sub-resource.
##### Returns
FederationRule object{ id, applies_to_all_workspaces, archived_at, 17 more }
Authorization rule binding an external OIDC identity to Anthropic.
Evaluates the match conditions and mints an OAuth access token for the resolved target, scoped to a single workspace where the rule is enabled (chosen by the caller at exchange time when the rule is enabled for more than one). For rules enabled via `workspace_ids` or `applies_to_all_workspaces`, the target service account must be a member of that workspace (it is implicitly a member of the default workspace); rules carrying only the legacy `workspace_id` binding do not enforce this.
Create Federation Rule
cURL
```python
curl https://api.anthropic.com/v1/organizations/federation_rules \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN" \
-d '{
"issuer_id": "issuer_id",
"match": {},
"name": "x",
"oauth_scope": "x",
"target": {
"service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK",
"type": "service_account"
}
}'
```
Response 200
```python
{
"id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK",
"applies_to_all_workspaces": true,
"archived_at": "2019-12-27T18:11:19.117Z",
"archived_by_actor_id": "archived_by_actor_id",
"attributes": {
"foo": "string"
},
"created_at": "2024-10-30T23:58:27.427722Z",
"created_by_actor_id": "created_by_actor_id",
"description": "description",
"issuer_id": "issuer_id",
"issuer_name": "issuer_name",
"match": {
"audience": "audience",
"claims": {
"foo": "string"
},
"condition": "condition",
"subject_prefix": "subject_prefix"
},
"name": "prod-deploy-pipeline",
"oauth_scope": "oauth_scope",
"target": {
"service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK",
"type": "service_account",
"service_account_name": "service_account_name"
},
"token_lifetime_seconds": 0,
"type": "federation_rule",
"updated_at": "2024-10-30T23:58:27.427722Z",
"updated_by_actor_id": "updated_by_actor_id",
"workspace_id": "workspace_id",
"workspace_ids": [
"string"
]
}
```
##### Returns Examples
Response 200
```python
{
"id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK",
"applies_to_all_workspaces": true,
"archived_at": "2019-12-27T18:11:19.117Z",
"archived_by_actor_id": "archived_by_actor_id",
"attributes": {
"foo": "string"
},
"created_at": "2024-10-30T23:58:27.427722Z",
"created_by_actor_id": "created_by_actor_id",
"description": "description",
"issuer_id": "issuer_id",
"issuer_name": "issuer_name",
"match": {
"audience": "audience",
"claims": {
"foo": "string"
},
"condition": "condition",
"subject_prefix": "subject_prefix"
},
"name": "prod-deploy-pipeline",
"oauth_scope": "oauth_scope",
"target": {
"service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK",
"type": "service_account",
"service_account_name": "service_account_name"
},
"token_lifetime_seconds": 0,
"type": "federation_rule",
"updated_at": "2024-10-30T23:58:27.427722Z",
"updated_by_actor_id": "updated_by_actor_id",
"workspace_id": "workspace_id",
---
## List Federation Rules - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/federation_rules/list
Path: 04-API-Reference/Admin/admin-federation-rules-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Ffederation_rules%2Flist)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
API Keys
External Keys
Usage Report
Cost Report
Analytics
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
Create Federation Rule
Get Federation Rule
List Federation Rules
Update Federation Rule
Archive Federation Rule
Workspaces
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [Federation Rules](https://platform.claude.com/docs/en/api/http/admin/federation_rules)
# List Federation Rules
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](../Other/manage-claude-wif-admin-api.md).
List federation rules in your organization.
Optionally filter by issuer with `issuer_id`. Archived rules are excluded unless `include_archived=true`.
##### Query parameters
include_archived: optional boolean
Include archived resources. Defaults to false.
defaultfalse
issuer_id: optional string
Filter to rules referencing this federation issuer.
limit: optional number
Number of results per page.
default20
maximum100
minimum1
page: optional string
Opaque cursor from a previous response's `next_page`.
##### Headers
"anthropic-beta": optional array of string
Optional header to specify the beta version(s) you want to use.
To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta.
##### Returns
data: array of [FederationRule](https://platform.claude.com/docs/en/api/http/admin/federation_rules#federation_rule) { id, applies_to_all_workspaces, archived_at, 17 more }
id: string
Tagged ID of the federation rule.
applies_to_all_workspaces: boolean
When true, this rule is enabled for every workspace in the org (including ones created after the rule). `workspace_ids` is ignored at exchange time.
archived_at: string or null
If set, this rule is archived and rejects token exchange.
formatdate-time
archived_by_actor_id: string or null
Tagged ID (`user_`/`svac_`) of the actor that archived this rule.
attributes: map\[string\] or null
CEL expressions extracting named values from claims. Not yet supported; always null.
created_at: string
When this rule was created.
formatdate-time
created_by_actor_id: string or null
Tagged ID (`user_`/`svac_`) of the actor that created this rule.
description: string or null
Optional free-text description.
issuer_id: string
Tagged ID of the issuer whose tokens this rule accepts.
issuer_name: string or null
Issuer's display name at read time.
match: object{ audience, claims, condition, subject_prefix }
Conditions the verified JWT must satisfy for this rule to apply. All populated matcher fields must pass.
audience: optional string or null
Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default.
maxLength1024
claims: optional map\[string\] or null
Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims.
condition: optional string or null
CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400.
maxLength4096
subject_prefix: optional string or null
Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`.
maxLength1024
name: string
Admin-chosen slug identifier.
oauth_scope: string
Space-separated OAuth scopes granted on the minted token.
target: object{ service_account_id, type, service_account_name }
Identity that tokens minted via this rule act as. Currently always a `service_account` target.
service_account_id: string
Tagged ID of the service account to mint tokens for.
type: "service_account"
service_account_name: optional string or null
Service account's display name at read time. Ignored on writes.
token_lifetime_seconds: number
Lifetime in seconds of access tokens minted via this rule. Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds.
type: "federation_rule"
defaultfederation_rule
updated_at: string
When this rule was last updated.
formatdate-time
updated_by_actor_id: string or null
Tagged ID (`user_`/`svac_`) of the actor that last updated this rule.
workspace_id: string or null
Legacy single-workspace binding. Prefer `workspace_ids` and the `/federation_rules/{federation_rule_id}/workspaces` sub-resource for managing workspace enablement.
workspace_ids: array of string
Tagged IDs of the workspaces this rule is enabled for. May be empty for older rules that only carry the legacy `workspace_id` binding. Ignored at exchange time when `applies_to_all_workspaces` is true (the list may still be non-empty).
next_page: string or null
Opaque cursor for the next page, or null if no more results.
List Federation Rules
cURL
```python
curl https://api.anthropic.com/v1/organizations/federation_rules \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
```
Response 200
```python
{
"data": [
{
"id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK",
"applies_to_all_workspaces": true,
"archived_at": "2019-12-27T18:11:19.117Z",
"archived_by_actor_id": "archived_by_actor_id",
"attributes": {
"foo": "string"
},
"created_at": "2024-10-30T23:58:27.427722Z",
"created_by_actor_id": "created_by_actor_id",
"description": "description",
"issuer_id": "issuer_id",
"issuer_name": "issuer_name",
"match": {
"audience": "audience",
"claims": {
"foo": "string"
},
"condition": "condition",
"subject_prefix": "subject_prefix"
},
"name": "prod-deploy-pipeline",
"oauth_scope": "oauth_scope",
"target": {
"service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK",
"type": "service_account",
"service_account_name": "service_account_name"
},
"token_lifetime_seconds": 0,
"type": "federation_rule",
"updated_at": "2024-10-30T23:58:27.427722Z",
"updated_by_actor_id": "updated_by_actor_id",
"workspace_id": "workspace_id",
"workspace_ids": [
"string"
]
}
],
"next_page": "next_page"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK",
"applies_to_all_workspaces": true,
"archived_at": "2019-12-27T18:11:19.117Z",
"archived_by_actor_id": "archived_by_actor_id",
"attributes": {
"foo": "string"
},
"created_at": "2024-10-30T23:58:27.427722Z",
"created_by_actor_id": "created_by_actor_id",
"description": "description",
"issuer_id": "issuer_id",
"issuer_name": "issuer_name",
"match": {
"audience": "audience",
"claims": {
"foo": "string"
},
"condition": "condition",
"subject_prefix": "subject_prefix"
},
"name": "prod-deploy-pipeline",
"oauth_scope": "oauth_scope",
"target": {
"service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK",
"type": "service_account",
"service_account_name": "service_account_name"
},
"token_lifetime_seconds": 0,
"type": "federation_rule",
"updated_at": "2024-10-30T23:58:27.427722Z",
"updated_by_actor_id": "updated_by_actor_id",
"workspace_id": "workspace_id",
---
## Get Federation Rule - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/federation_rules/retrieve
Path: 04-API-Reference/Admin/admin-federation-rules-retrieve.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Ffederation_rules%2Fretrieve)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
API Keys
External Keys
Usage Report
Cost Report
Analytics
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
Create Federation Rule
Get Federation Rule
List Federation Rules
Update Federation Rule
Archive Federation Rule
Workspaces
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [Federation Rules](https://platform.claude.com/docs/en/api/http/admin/federation_rules)
# Get Federation Rule
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](../Other/manage-claude-wif-admin-api.md).
Retrieve a federation rule by its ID (`fdrl_...`).
##### Path parameters
federation_rule_id: string
ID of the federation rule.
##### Headers
"anthropic-beta": optional array of string
Optional header to specify the beta version(s) you want to use.
To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta.
##### Returns
FederationRule object{ id, applies_to_all_workspaces, archived_at, 17 more }
Authorization rule binding an external OIDC identity to Anthropic.
Evaluates the match conditions and mints an OAuth access token for the resolved target, scoped to a single workspace where the rule is enabled (chosen by the caller at exchange time when the rule is enabled for more than one). For rules enabled via `workspace_ids` or `applies_to_all_workspaces`, the target service account must be a member of that workspace (it is implicitly a member of the default workspace); rules carrying only the legacy `workspace_id` binding do not enforce this.
Get Federation Rule
cURL
```python
curl https://api.anthropic.com/v1/organizations/federation_rules/$FEDERATION_RULE_ID \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
```
Response 200
```python
{
"id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK",
"applies_to_all_workspaces": true,
"archived_at": "2019-12-27T18:11:19.117Z",
"archived_by_actor_id": "archived_by_actor_id",
"attributes": {
"foo": "string"
},
"created_at": "2024-10-30T23:58:27.427722Z",
"created_by_actor_id": "created_by_actor_id",
"description": "description",
"issuer_id": "issuer_id",
"issuer_name": "issuer_name",
"match": {
"audience": "audience",
"claims": {
"foo": "string"
},
"condition": "condition",
"subject_prefix": "subject_prefix"
},
"name": "prod-deploy-pipeline",
"oauth_scope": "oauth_scope",
"target": {
"service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK",
"type": "service_account",
"service_account_name": "service_account_name"
},
"token_lifetime_seconds": 0,
"type": "federation_rule",
"updated_at": "2024-10-30T23:58:27.427722Z",
"updated_by_actor_id": "updated_by_actor_id",
"workspace_id": "workspace_id",
"workspace_ids": [
"string"
]
}
```
##### Returns Examples
Response 200
```python
{
"id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK",
"applies_to_all_workspaces": true,
"archived_at": "2019-12-27T18:11:19.117Z",
"archived_by_actor_id": "archived_by_actor_id",
"attributes": {
"foo": "string"
},
"created_at": "2024-10-30T23:58:27.427722Z",
"created_by_actor_id": "created_by_actor_id",
"description": "description",
"issuer_id": "issuer_id",
"issuer_name": "issuer_name",
"match": {
"audience": "audience",
"claims": {
"foo": "string"
},
"condition": "condition",
"subject_prefix": "subject_prefix"
},
"name": "prod-deploy-pipeline",
"oauth_scope": "oauth_scope",
"target": {
"service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK",
"type": "service_account",
"service_account_name": "service_account_name"
},
"token_lifetime_seconds": 0,
"type": "federation_rule",
"updated_at": "2024-10-30T23:58:27.427722Z",
"updated_by_actor_id": "updated_by_actor_id",
"workspace_id": "workspace_id",
---
## Update Federation Rule - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/federation_rules/update
Path: 04-API-Reference/Admin/admin-federation-rules-update.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Ffederation_rules%2Fupdate)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
API Keys
External Keys
Usage Report
Cost Report
Analytics
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
Create Federation Rule
Get Federation Rule
List Federation Rules
Update Federation Rule
Archive Federation Rule
Workspaces
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [Federation Rules](https://platform.claude.com/docs/en/api/http/admin/federation_rules)
# Update Federation Rule
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](../Other/manage-claude-wif-admin-api.md).
Partially update a federation rule.
`issuer_id` is immutable. `match` and `target` are replaced as whole objects when set. Referenced service accounts and workspaces must exist in your organization; invalid references are rejected with a 400 error. Archived rules cannot be updated; this returns 400. Create a new rule instead. Rules on well-known shared issuers (GitHub Actions, GitLab, Buildkite, Terraform Cloud, Google) must constrain tenant identity via an identity-bearing claim, a tenant-pinning subject prefix (such as `repo:YOUR_ORG/...`), or a CEL condition referencing one of those identity claims (e.g. `claims.repository_owner`). On these issuers the requirement is re-checked on every update; if an existing rule's stored match does not yet constrain tenant identity, any update (even a rename or description change) must also supply a conforming `match` in the same request. OAuth callers may only manage rules whose `oauth_scope` is `workspace:developer` or `workspace:inference`; other scopes require a Console session.
##### Path parameters
federation_rule_id: string
ID of the federation rule to update.
##### Headers
"anthropic-beta": optional array of string
Optional header to specify the beta version(s) you want to use.
To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta.
##### Body
applies_to_all_workspaces: optional boolean or null
When true, enables this rule for every workspace in the org (including workspaces created later). Setting `false` is rejected with 400 if no workspace would remain enabled; a rule with only a legacy `workspace_id` binding continues to mint.
attributes: optional map\[string\] or null
Replaces the CEL expressions `{name: expr}` extracting named values from claims. Send null to clear them. Not yet supported; any non-empty value is rejected with 400.
description: optional string or null
Replaces the description. Omit to leave unchanged; send `null` to clear (the field is stored as an empty string).
maxLength2000
match: optional object{ audience, claims, condition, subject_prefix } or null
Does the incoming JWT qualify?
All populated fields must pass; omitted fields are skipped. At least one of `subject_prefix` (other than a wildcard-only value like `*`), `claims`, or `condition` is required; `audience` alone is not sufficient.
audience: optional string or null
Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default.
maxLength1024
claims: optional map\[string\] or null
Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims.
condition: optional string or null
CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400.
maxLength4096
subject_prefix: optional string or null
Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`.
maxLength1024
name: optional string or null
Replaces the slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409.
maxLength255
minLength1
oauth_scope: optional string or null
Replaces the space-separated OAuth scopes granted on minted tokens. OAuth callers may only set `workspace:developer` or `workspace:inference`; other scopes (such as `org:admin`) require a Console session.
minLength1
target: optional object{ service_account_id, type, service_account_name } or null
Bind to a fixed service account by ID.
service_account_id: string
Tagged ID of the service account to mint tokens for.
type: "service_account"
service_account_name: optional string or null
Service account's display name at read time. Ignored on writes.
token_lifetime_seconds: optional number or null
Replaces the lifetime in seconds for access tokens minted via this rule (60-86400). Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds.
maximum86400
minimum60
workspace_id: optional string or null
Replaces the existing single workspace enablement (the previous one is removed). Rejected with 400 if the rule is enabled for more than one workspace; use the `/federation_rules/{federation_rule_id}/workspaces` sub-resource instead.
##### Returns
FederationRule object{ id, applies_to_all_workspaces, archived_at, 17 more }
Authorization rule binding an external OIDC identity to Anthropic.
Evaluates the match conditions and mints an OAuth access token for the resolved target, scoped to a single workspace where the rule is enabled (chosen by the caller at exchange time when the rule is enabled for more than one). For rules enabled via `workspace_ids` or `applies_to_all_workspaces`, the target service account must be a member of that workspace (it is implicitly a member of the default workspace); rules carrying only the legacy `workspace_id` binding do not enforce this.
Update Federation Rule
cURL
```python
curl https://api.anthropic.com/v1/organizations/federation_rules/$FEDERATION_RULE_ID \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN" \
-d '{}'
```
Response 200
```python
{
"id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK",
"applies_to_all_workspaces": true,
"archived_at": "2019-12-27T18:11:19.117Z",
"archived_by_actor_id": "archived_by_actor_id",
"attributes": {
"foo": "string"
},
"created_at": "2024-10-30T23:58:27.427722Z",
"created_by_actor_id": "created_by_actor_id",
"description": "description",
"issuer_id": "issuer_id",
"issuer_name": "issuer_name",
"match": {
"audience": "audience",
"claims": {
"foo": "string"
},
"condition": "condition",
"subject_prefix": "subject_prefix"
},
"name": "prod-deploy-pipeline",
"oauth_scope": "oauth_scope",
"target": {
"service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK",
"type": "service_account",
"service_account_name": "service_account_name"
},
"token_lifetime_seconds": 0,
"type": "federation_rule",
"updated_at": "2024-10-30T23:58:27.427722Z",
"updated_by_actor_id": "updated_by_actor_id",
"workspace_id": "workspace_id",
"workspace_ids": [
"string"
]
}
```
##### Returns Examples
Response 200
```python
{
"id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK",
"applies_to_all_workspaces": true,
"archived_at": "2019-12-27T18:11:19.117Z",
"archived_by_actor_id": "archived_by_actor_id",
"attributes": {
"foo": "string"
},
"created_at": "2024-10-30T23:58:27.427722Z",
"created_by_actor_id": "created_by_actor_id",
"description": "description",
"issuer_id": "issuer_id",
"issuer_name": "issuer_name",
"match": {
"audience": "audience",
"claims": {
"foo": "string"
},
"condition": "condition",
"subject_prefix": "subject_prefix"
},
"name": "prod-deploy-pipeline",
"oauth_scope": "oauth_scope",
"target": {
"service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK",
"type": "service_account",
"service_account_name": "service_account_name"
},
"token_lifetime_seconds": 0,
"type": "federation_rule",
"updated_at": "2024-10-30T23:58:27.427722Z",
"updated_by_actor_id": "updated_by_actor_id",
"workspace_id": "workspace_id",
---
## Add Federation Rule Workspace - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/federation_rules/workspaces/create
Path: 04-API-Reference/Admin/admin-federation-rules-workspaces-create.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Ffederation_rules%2Fworkspaces%2Fcreate)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
API Keys
External Keys
Usage Report
Cost Report
Analytics
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
Create Federation Rule
Get Federation Rule
List Federation Rules
Update Federation Rule
Archive Federation Rule
Workspaces
List Federation Rule Workspaces
Add Federation Rule Workspace
Remove Federation Rule Workspace
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [Federation Rules](https://platform.claude.com/docs/en/api/http/admin/federation_rules)
4. [Workspaces](https://platform.claude.com/docs/en/api/http/admin/federation_rules/workspaces)
# Add Federation Rule Workspace
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](../Other/manage-claude-wif-admin-api.md).
Enable a federation rule for a workspace.
Idempotent; re-enabling returns the existing enablement. The rule and workspace must both belong to your organization. Membership of the rule's target service account in this workspace is not checked at enablement: token exchange into this workspace is rejected unless the target is a member (it is implicitly a member of the default workspace). Archived rules are rejected with 400. OAuth callers may only manage rules whose `oauth_scope` is `workspace:developer` or `workspace:inference`; other scopes require a Console session.
##### Path parameters
federation_rule_id: string
ID of the federation rule.
##### Headers
"anthropic-beta": optional array of string
Optional header to specify the beta version(s) you want to use.
To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta.
##### Body
workspace_id: string
Tagged ID of the workspace to enable this rule for.
##### Returns
created_at: string
When this workspace was enabled for the rule.
formatdate-time
created_by_actor_id: string or null
Tagged ID (`user_...` or `svac_...`) of the actor that enabled this workspace for the rule, if known.
federation_rule_id: string
Tagged ID of the federation rule.
type: "federation_rule_workspace"
defaultfederation_rule_workspace
workspace_id: string
Tagged ID of the workspace this rule is enabled for.
workspace_name: string or null
Workspace display name. Populated when listing; null in the enable response.
Add Federation Rule Workspace
cURL
```python
curl https://api.anthropic.com/v1/organizations/federation_rules/$FEDERATION_RULE_ID/workspaces \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN" \
-d '{
"workspace_id": "workspace_id"
}'
```
Response 200
```python
{
"created_at": "2024-10-30T23:58:27.427722Z",
"created_by_actor_id": "created_by_actor_id",
"federation_rule_id": "federation_rule_id",
"type": "federation_rule_workspace",
"workspace_id": "workspace_id",
"workspace_name": "workspace_name"
}
```
##### Returns Examples
Response 200
```python
{
"created_at": "2024-10-30T23:58:27.427722Z",
"created_by_actor_id": "created_by_actor_id",
"federation_rule_id": "federation_rule_id",
"type": "federation_rule_workspace",
"workspace_id": "workspace_id",
"workspace_name": "workspace_name"
---
## Remove Federation Rule Workspace - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/federation_rules/workspaces/delete
Path: 04-API-Reference/Admin/admin-federation-rules-workspaces-delete.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Ffederation_rules%2Fworkspaces%2Fdelete)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
API Keys
External Keys
Usage Report
Cost Report
Analytics
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
Create Federation Rule
Get Federation Rule
List Federation Rules
Update Federation Rule
Archive Federation Rule
Workspaces
List Federation Rule Workspaces
Add Federation Rule Workspace
Remove Federation Rule Workspace
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [Federation Rules](https://platform.claude.com/docs/en/api/http/admin/federation_rules)
4. [Workspaces](https://platform.claude.com/docs/en/api/http/admin/federation_rules/workspaces)
# Remove Federation Rule Workspace
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](../Other/manage-claude-wif-admin-api.md).
Disable a federation rule for a workspace.
Idempotent; succeeds even if the enablement was already removed. OAuth callers may only manage rules whose `oauth_scope` is `workspace:developer` or `workspace:inference`; other scopes require a Console session.
##### Path parameters
federation_rule_id: string
ID of the federation rule.
workspace_id: string
ID of the workspace to disable for.
##### Headers
"anthropic-beta": optional array of string
Optional header to specify the beta version(s) you want to use.
To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta.
##### Returns
federation_rule_id: string
Tagged ID of the federation rule.
type: "federation_rule_workspace_deleted"
defaultfederation_rule_workspace_deleted
workspace_id: string
Tagged ID of the workspace named in the delete request. Removal is idempotent.
Remove Federation Rule Workspace
cURL
```python
curl https://api.anthropic.com/v1/organizations/federation_rules/$FEDERATION_RULE_ID/workspaces/$WORKSPACE_ID \
-X DELETE \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
```
Response 200
```python
{
"federation_rule_id": "federation_rule_id",
"type": "federation_rule_workspace_deleted",
"workspace_id": "workspace_id"
}
```
##### Returns Examples
Response 200
```python
{
"federation_rule_id": "federation_rule_id",
"type": "federation_rule_workspace_deleted",
"workspace_id": "workspace_id"
---
## List Federation Rule Workspaces - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/federation_rules/workspaces/list
Path: 04-API-Reference/Admin/admin-federation-rules-workspaces-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Ffederation_rules%2Fworkspaces%2Flist)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
API Keys
External Keys
Usage Report
Cost Report
Analytics
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
Create Federation Rule
Get Federation Rule
List Federation Rules
Update Federation Rule
Archive Federation Rule
Workspaces
List Federation Rule Workspaces
Add Federation Rule Workspace
Remove Federation Rule Workspace
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [Federation Rules](https://platform.claude.com/docs/en/api/http/admin/federation_rules)
4. [Workspaces](https://platform.claude.com/docs/en/api/http/admin/federation_rules/workspaces)
# List Federation Rule Workspaces
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](../Other/manage-claude-wif-admin-api.md).
List workspaces where this federation rule is enabled.
Returns all workspace enablements in a single response; the `limit` and `page` parameters are accepted but have no effect, and `next_page` is always `null`. Returns explicit per-workspace enablements only; for rules with `applies_to_all_workspaces` or a legacy single `workspace_id`, check those fields on the rule itself.
##### Path parameters
federation_rule_id: string
ID of the federation rule.
##### Query parameters
limit: optional number
Number of results per page.
default20
maximum100
minimum1
page: optional string
Opaque cursor from a previous response's `next_page`.
##### Headers
"anthropic-beta": optional array of string
Optional header to specify the beta version(s) you want to use.
To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta.
##### Returns
data: array of object{ created_at, created_by_actor_id, federation_rule_id, 3 more }
created_at: string
When this workspace was enabled for the rule.
formatdate-time
created_by_actor_id: string or null
Tagged ID (`user_...` or `svac_...`) of the actor that enabled this workspace for the rule, if known.
federation_rule_id: string
Tagged ID of the federation rule.
type: "federation_rule_workspace"
defaultfederation_rule_workspace
workspace_id: string
Tagged ID of the workspace this rule is enabled for.
workspace_name: string or null
Workspace display name. Populated when listing; null in the enable response.
next_page: string or null
Opaque cursor for the next page; null when there are no more results.
List Federation Rule Workspaces
cURL
```python
curl https://api.anthropic.com/v1/organizations/federation_rules/$FEDERATION_RULE_ID/workspaces \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
```
Response 200
```python
{
"data": [
{
"created_at": "2024-10-30T23:58:27.427722Z",
"created_by_actor_id": "created_by_actor_id",
"federation_rule_id": "federation_rule_id",
"type": "federation_rule_workspace",
"workspace_id": "workspace_id",
"workspace_name": "workspace_name"
}
],
"next_page": "next_page"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"created_at": "2024-10-30T23:58:27.427722Z",
"created_by_actor_id": "created_by_actor_id",
"federation_rule_id": "federation_rule_id",
"type": "federation_rule_workspace",
"workspace_id": "workspace_id",
"workspace_name": "workspace_name"
---
## Workspaces - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/federation_rules/workspaces
Path: 04-API-Reference/Admin/admin-federation-rules-workspaces.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Ffederation_rules%2Fworkspaces)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
API Keys
External Keys
Usage Report
Cost Report
Analytics
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
Create Federation Rule
Get Federation Rule
List Federation Rules
Update Federation Rule
Archive Federation Rule
Workspaces
List Federation Rule Workspaces
Add Federation Rule Workspace
Remove Federation Rule Workspace
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [Federation Rules](https://platform.claude.com/docs/en/api/http/admin/federation_rules)
# Workspaces
##### [List Federation Rule Workspaces](https://platform.claude.com/docs/en/api/http/admin/federation_rules/workspaces/list)
GET/v1/organizations/federation_rules/{federation_rule_id}/workspaces
##### [Add Federation Rule Workspace](https://platform.claude.com/docs/en/api/http/admin/federation_rules/workspaces/create)
POST/v1/organizations/federation_rules/{federation_rule_id}/workspaces
##### [Remove Federation Rule Workspace](https://platform.claude.com/docs/en/api/http/admin/federation_rules/workspaces/delete)
DELETE/v1/organizations/federation_rules/{federation_rule_id}/workspaces/{workspace_id}
##### Models
WorkspaceCreateResponse object{ created_at, created_by_actor_id, federation_rule_id, 3 more }
created_at: string
When this workspace was enabled for the rule.
formatdate-time
created_by_actor_id: string or null
Tagged ID (`user_...` or `svac_...`) of the actor that enabled this workspace for the rule, if known.
federation_rule_id: string
Tagged ID of the federation rule.
type: "federation_rule_workspace"
defaultfederation_rule_workspace
workspace_id: string
Tagged ID of the workspace this rule is enabled for.
workspace_name: string or null
Workspace display name. Populated when listing; null in the enable response.
WorkspaceListResponse object{ created_at, created_by_actor_id, federation_rule_id, 3 more }
created_at: string
When this workspace was enabled for the rule.
formatdate-time
created_by_actor_id: string or null
Tagged ID (`user_...` or `svac_...`) of the actor that enabled this workspace for the rule, if known.
federation_rule_id: string
Tagged ID of the federation rule.
type: "federation_rule_workspace"
defaultfederation_rule_workspace
workspace_id: string
Tagged ID of the workspace this rule is enabled for.
workspace_name: string or null
Workspace display name. Populated when listing; null in the enable response.
WorkspaceDeleteResponse object{ federation_rule_id, type, workspace_id }
federation_rule_id: string
Tagged ID of the federation rule.
type: "federation_rule_workspace_deleted"
defaultfederation_rule_workspace_deleted
workspace_id: string
Tagged ID of the workspace named in the delete request. Removal is idempotent.
---
## Federation Rules - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/federation_rules
Path: 04-API-Reference/Admin/admin-federation-rules.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Ffederation_rules)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
API Keys
External Keys
Usage Report
Cost Report
Analytics
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
Create Federation Rule
Get Federation Rule
List Federation Rules
Update Federation Rule
Archive Federation Rule
Workspaces
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
# Federation Rules
##### [Create Federation Rule](https://platform.claude.com/docs/en/api/http/admin/federation_rules/create)
POST/v1/organizations/federation_rules
##### [Get Federation Rule](https://platform.claude.com/docs/en/api/http/admin/federation_rules/retrieve)
GET/v1/organizations/federation_rules/{federation_rule_id}
##### [List Federation Rules](https://platform.claude.com/docs/en/api/http/admin/federation_rules/list)
GET/v1/organizations/federation_rules
##### [Update Federation Rule](https://platform.claude.com/docs/en/api/http/admin/federation_rules/update)
POST/v1/organizations/federation_rules/{federation_rule_id}
##### [Archive Federation Rule](https://platform.claude.com/docs/en/api/http/admin/federation_rules/archive)
POST/v1/organizations/federation_rules/{federation_rule_id}/archive
##### Models
FederationRule object{ id, applies_to_all_workspaces, archived_at, 17 more }
Authorization rule binding an external OIDC identity to Anthropic.
Evaluates the match conditions and mints an OAuth access token for the resolved target, scoped to a single workspace where the rule is enabled (chosen by the caller at exchange time when the rule is enabled for more than one). For rules enabled via `workspace_ids` or `applies_to_all_workspaces`, the target service account must be a member of that workspace (it is implicitly a member of the default workspace); rules carrying only the legacy `workspace_id` binding do not enforce this.
#### Federation Rules[Workspaces](https://platform.claude.com/docs/en/api/http/admin/federation_rules/workspaces)
##### [List Federation Rule Workspaces](https://platform.claude.com/docs/en/api/http/admin/federation_rules/workspaces/list)
GET/v1/organizations/federation_rules/{federation_rule_id}/workspaces
##### [Add Federation Rule Workspace](https://platform.claude.com/docs/en/api/http/admin/federation_rules/workspaces/create)
POST/v1/organizations/federation_rules/{federation_rule_id}/workspaces
##### [Remove Federation Rule Workspace](https://platform.claude.com/docs/en/api/http/admin/federation_rules/workspaces/delete)
DELETE/v1/organizations/federation_rules/{federation_rule_id}/workspaces/{workspace_id}
---
## List Invites - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/invites/list
Path: 04-API-Reference/Admin/admin-invites-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Finvites%2Flist)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Create Invite
List Invites
Get Invite
Delete Invite
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Invites](https://platform.claude.com/docs/en/api/http/beta/organization/invites)
# List Invites
GET/v1/organizations/invites
List the organization's invites.
##### Query parameters
after_id: optional string
ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object.
before_id: optional string
ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object.
email: optional string
Filter by the email address the Invite was sent to. Matches the same way as the Users list's `email` filter (normalized, case-insensitive).
formatemail
limit: optional number
Number of items to return per page.
Defaults to `20`. Ranges from `1` to `1000`.
default20
maximum1000
minimum1
roles: optional array of string
Filter to items whose `role` equals one of the supplied values. Repeatable; values are OR'ed together.
Accepted values depend on the organization type: Console and API organizations accept `user`, `developer`, `billing`, `admin`, and `claude_code_user`; Claude Enterprise organizations accept `user`, `owner`, `primary_owner`, `membership_admin`, and `managed`.
statuses: optional array of "accepted" or "expired" or "pending"
Filter by Invite status. Repeatable; values are OR'ed together. Omit to return `pending`, `accepted`, and `expired` Invites alike.
One of the following:
"accepted"
"expired"
"pending"
##### Returns
data: array of [BetaOrganizationInvite](https://platform.claude.com/docs/en/api/http/beta/organization/invites#beta_organization_invite) { type: "invite", id, accepted_at, 6 more }
type: "invite"
Object type.
For Invites, this is always `"invite"`.
defaultinvite
id: string
ID of the Invite.
accepted_at: string or null
RFC 3339 datetime string indicating when the Invite was accepted, or null.
formatdate-time
email: string
Email of the User being invited.
expires_at: string
RFC 3339 datetime string indicating when the Invite expires.
formatdate-time
invited_at: string
RFC 3339 datetime string indicating when the Invite was created.
formatdate-time
rbac_group_ids: array of string
RBAC group IDs recorded on the Invite (Claude Enterprise organizations), to be assigned to the User when the Invite is accepted. `[]` when none.
role: [BetaOrganizationRole](platform-claude-com-http-beta-organization.md#beta_organization_role)
Organization role of the User.
One of the following:
"admin"
"billing"
"claude_code_user"
"developer"
"managed"
"membership_admin"
"owner"
"primary_owner"
"user"
status: "accepted" or "deleted" or "expired" or "pending"
Status of the Invite.
One of the following:
"accepted"
"deleted"
"expired"
"pending"
first_id: string or null
First ID in the `data` list. Can be used as the `before_id` for the previous page.
has_more: boolean
Indicates if there are more results in the requested page direction.
last_id: string or null
Last ID in the `data` list. Can be used as the `after_id` for the next page.
List Invites
cURL
```python
curl https://api.anthropic.com/v1/organizations/invites \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"data": [
{
"id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu",
"accepted_at": "2019-12-27T18:11:19.117Z",
"email": "user@emaildomain.com",
"expires_at": "2024-11-20T23:58:27.427722Z",
"invited_at": "2024-10-30T23:58:27.427722Z",
"rbac_group_ids": [
"string"
],
"role": "admin",
"status": "pending",
"type": "invite"
}
],
"first_id": "first_id",
"has_more": true,
"last_id": "last_id"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu",
"accepted_at": "2019-12-27T18:11:19.117Z",
"email": "user@emaildomain.com",
"expires_at": "2024-11-20T23:58:27.427722Z",
"invited_at": "2024-10-30T23:58:27.427722Z",
---
## Invites - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/invites
Path: 04-API-Reference/Admin/admin-invites.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Finvites)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Create Invite
Get Invite
List Invites
Delete Invite
Users
RBAC Groups
RBAC Roles
Workspaces
API Keys
External Keys
Usage Report
Cost Report
Analytics
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
# Invites
##### [Create Invite](https://platform.claude.com/docs/en/api/http/admin/invites/create)
POST/v1/organizations/invites
##### [Get Invite](https://platform.claude.com/docs/en/api/http/admin/invites/retrieve)
GET/v1/organizations/invites/{invite_id}
##### [List Invites](https://platform.claude.com/docs/en/api/http/admin/invites/list)
GET/v1/organizations/invites
##### [Delete Invite](https://platform.claude.com/docs/en/api/http/admin/invites/delete)
DELETE/v1/organizations/invites/{invite_id}
##### Models
Invite object{ id, accepted_at, email, 6 more }
InviteDeleteResponse object{ id, type }
id: string
ID of the Invite.
type: "invite_deleted"
Deleted object type.
For Invites, this is always `"invite_deleted"`.
---
## Archive Tunnel - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/mcp_tunnels/archive
Path: 04-API-Reference/Admin/admin-mcp-tunnels-archive.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Fmcp_tunnels%2Farchive)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
API Keys
External Keys
Usage Report
Cost Report
Analytics
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
MCP Tunnels
Get Tunnel
List Tunnels
Reveal Tunnel Token
Rotate Tunnel Token
Archive Tunnel
Tunnel Certificates
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [MCP Tunnels](https://platform.claude.com/docs/en/api/http/admin/mcp_tunnels)
# Archive Tunnel
Deprecated
POST/v1/organizations/tunnels/{tunnel_id}/archive
**Deprecated.** This Admin API endpoint is superseded by `/v1/tunnels` on the Claude API and will be removed after a migration window. New integrations should use [`/v1/tunnels`](../Endpoints/http-beta-tunnels.md) with the `anthropic-beta: mcp-tunnels-2026-06-22` header and a WIF token carrying the `workspace:manage_tunnels` scope. Existing integrations continue to work with the `mcp-tunnels-2026-05-19` header and `org:manage_tunnels` scope during the migration window.
Archive a tunnel. Archival is irreversible.
Every non-archived certificate on the tunnel is archived in the same operation, the hostname is retired and never re-allocated, and the tunnel token is invalidated. Retrying against an already-archived tunnel returns the existing record unchanged.
##### Path parameters
tunnel_id: string
ID of the Tunnel.
##### Headers
"anthropic-beta": array of "mcp-tunnels-2026-05-19"
Required for all Tunnel endpoints.
##### Returns
id: string
ID of the Tunnel.
archived_at: string or null
RFC 3339 datetime string indicating when the Tunnel was archived, or `null` if it is not archived.
formatdate-time
created_at: string
RFC 3339 datetime string indicating when the Tunnel was created.
formatdate-time
display_name: string or null
Human-readable name for the Tunnel (1–255 characters), or `null` if unset.
domain: string
Anthropic-assigned hostname for the Tunnel. MCP server URLs whose host is a subdomain of this value are routed through the Tunnel. Globally unique and never reused, even after the Tunnel is archived.
type: "tunnel"
Object type. Always `tunnel` for Tunnels.
defaulttunnel
workspace_id: string or null
ID of the Workspace this Tunnel belongs to, or `null` for the default Workspace. Immutable after creation.
Archive Tunnel
cURL
```python
curl https://api.anthropic.com/v1/organizations/tunnels/$TUNNEL_ID/archive \
-X POST \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
```
Response 200
```python
{
"id": "tnl_01Hx9Kp2RtQvMn3sWbYdLcF8",
"archived_at": "2024-11-01T23:59:27.427722Z",
"created_at": "2024-10-30T23:58:27.427722Z",
"display_name": "Production",
"domain": "a1b2c3d4.tunnel.anthropic.com",
"type": "tunnel",
"workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"
}
```
##### Returns Examples
Response 200
```python
{
"id": "tnl_01Hx9Kp2RtQvMn3sWbYdLcF8",
"archived_at": "2024-11-01T23:59:27.427722Z",
"created_at": "2024-10-30T23:58:27.427722Z",
"display_name": "Production",
"domain": "a1b2c3d4.tunnel.anthropic.com",
"type": "tunnel",
"workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"
---
## List Tunnels - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/mcp_tunnels/list
Path: 04-API-Reference/Admin/admin-mcp-tunnels-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Fmcp_tunnels%2Flist)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
API Keys
External Keys
Usage Report
Cost Report
Analytics
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
MCP Tunnels
Get Tunnel
List Tunnels
Reveal Tunnel Token
Rotate Tunnel Token
Archive Tunnel
Tunnel Certificates
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [MCP Tunnels](https://platform.claude.com/docs/en/api/http/admin/mcp_tunnels)
# List Tunnels
Deprecated
GET/v1/organizations/tunnels
**Deprecated.** This Admin API endpoint is superseded by `/v1/tunnels` on the Claude API and will be removed after a migration window. New integrations should use [`/v1/tunnels`](../Endpoints/http-beta-tunnels.md) with the `anthropic-beta: mcp-tunnels-2026-06-22` header and a WIF token carrying the `workspace:manage_tunnels` scope. Existing integrations continue to work with the `mcp-tunnels-2026-05-19` header and `org:manage_tunnels` scope during the migration window.
List the organization's tunnels.
Results span the caller's organization, ordered by creation time (newest first). Use `workspace_id` to filter to a single workspace; archived tunnels are excluded unless `include_archived` is set.
##### Query parameters
include_archived: optional boolean
Include archived tunnels in the results. Archived tunnels are excluded by default.
defaultfalse
limit: optional number
Maximum number of tunnels to return in a single page.
default20
maximum1000
minimum1
page: optional string
Opaque pagination cursor from a previous response's `next_page`. Omit to fetch the first page.
workspace_id: optional string
Return only tunnels in this Workspace. Accepts a `wrkspc_`-prefixed Workspace ID; omit to list tunnels across all Workspaces.
##### Headers
"anthropic-beta": array of "mcp-tunnels-2026-05-19"
Required for all Tunnel endpoints.
##### Returns
data: array of object{ id, archived_at, created_at, 4 more }
id: string
ID of the Tunnel.
archived_at: string or null
RFC 3339 datetime string indicating when the Tunnel was archived, or `null` if it is not archived.
formatdate-time
created_at: string
RFC 3339 datetime string indicating when the Tunnel was created.
formatdate-time
display_name: string or null
Human-readable name for the Tunnel (1–255 characters), or `null` if unset.
domain: string
Anthropic-assigned hostname for the Tunnel. MCP server URLs whose host is a subdomain of this value are routed through the Tunnel. Globally unique and never reused, even after the Tunnel is archived.
type: "tunnel"
Object type. Always `tunnel` for Tunnels.
defaulttunnel
workspace_id: string or null
ID of the Workspace this Tunnel belongs to, or `null` for the default Workspace. Immutable after creation.
next_page: string or null
Opaque cursor for the next page, or `null` if there are no more results.
List Tunnels
cURL
```python
curl https://api.anthropic.com/v1/organizations/tunnels \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
```
Response 200
```python
{
"data": [
{
"id": "tnl_01Hx9Kp2RtQvMn3sWbYdLcF8",
"archived_at": "2024-11-01T23:59:27.427722Z",
"created_at": "2024-10-30T23:58:27.427722Z",
"display_name": "Production",
"domain": "a1b2c3d4.tunnel.anthropic.com",
"type": "tunnel",
"workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"
}
],
"next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo="
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"id": "tnl_01Hx9Kp2RtQvMn3sWbYdLcF8",
"archived_at": "2024-11-01T23:59:27.427722Z",
"created_at": "2024-10-30T23:58:27.427722Z",
"display_name": "Production",
"domain": "a1b2c3d4.tunnel.anthropic.com",
"type": "tunnel",
"workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"
}
],
"next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo="
---
## Get Tunnel - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/mcp_tunnels/retrieve
Path: 04-API-Reference/Admin/admin-mcp-tunnels-retrieve.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Fmcp_tunnels%2Fretrieve)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
API Keys
External Keys
Usage Report
Cost Report
Analytics
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
MCP Tunnels
Get Tunnel
List Tunnels
Reveal Tunnel Token
Rotate Tunnel Token
Archive Tunnel
Tunnel Certificates
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [MCP Tunnels](https://platform.claude.com/docs/en/api/http/admin/mcp_tunnels)
# Get Tunnel
Deprecated
GET/v1/organizations/tunnels/{tunnel_id}
**Deprecated.** This Admin API endpoint is superseded by `/v1/tunnels` on the Claude API and will be removed after a migration window. New integrations should use [`/v1/tunnels`](../Endpoints/http-beta-tunnels.md) with the `anthropic-beta: mcp-tunnels-2026-06-22` header and a WIF token carrying the `workspace:manage_tunnels` scope. Existing integrations continue to work with the `mcp-tunnels-2026-05-19` header and `org:manage_tunnels` scope during the migration window.
Retrieve a single tunnel in the caller's organization by ID.
##### Path parameters
tunnel_id: string
ID of the Tunnel.
##### Headers
"anthropic-beta": array of "mcp-tunnels-2026-05-19"
Required for all Tunnel endpoints.
##### Returns
id: string
ID of the Tunnel.
archived_at: string or null
RFC 3339 datetime string indicating when the Tunnel was archived, or `null` if it is not archived.
formatdate-time
created_at: string
RFC 3339 datetime string indicating when the Tunnel was created.
formatdate-time
display_name: string or null
Human-readable name for the Tunnel (1–255 characters), or `null` if unset.
domain: string
Anthropic-assigned hostname for the Tunnel. MCP server URLs whose host is a subdomain of this value are routed through the Tunnel. Globally unique and never reused, even after the Tunnel is archived.
type: "tunnel"
Object type. Always `tunnel` for Tunnels.
defaulttunnel
workspace_id: string or null
ID of the Workspace this Tunnel belongs to, or `null` for the default Workspace. Immutable after creation.
Get Tunnel
cURL
```python
curl https://api.anthropic.com/v1/organizations/tunnels/$TUNNEL_ID \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
```
Response 200
```python
{
"id": "tnl_01Hx9Kp2RtQvMn3sWbYdLcF8",
"archived_at": "2024-11-01T23:59:27.427722Z",
"created_at": "2024-10-30T23:58:27.427722Z",
"display_name": "Production",
"domain": "a1b2c3d4.tunnel.anthropic.com",
"type": "tunnel",
"workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"
}
```
##### Returns Examples
Response 200
```python
{
"id": "tnl_01Hx9Kp2RtQvMn3sWbYdLcF8",
"archived_at": "2024-11-01T23:59:27.427722Z",
"created_at": "2024-10-30T23:58:27.427722Z",
"display_name": "Production",
"domain": "a1b2c3d4.tunnel.anthropic.com",
"type": "tunnel",
"workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"
---
## Reveal Tunnel Token - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/mcp_tunnels/reveal_token
Path: 04-API-Reference/Admin/admin-mcp-tunnels-reveal-token.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Fmcp_tunnels%2Freveal_token)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
API Keys
External Keys
Usage Report
Cost Report
Analytics
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
MCP Tunnels
Get Tunnel
List Tunnels
Reveal Tunnel Token
Rotate Tunnel Token
Archive Tunnel
Tunnel Certificates
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [MCP Tunnels](https://platform.claude.com/docs/en/api/http/admin/mcp_tunnels)
# Reveal Tunnel Token
Deprecated
POST/v1/organizations/tunnels/{tunnel_id}/reveal_token
**Deprecated.** This Admin API endpoint is superseded by `/v1/tunnels` on the Claude API and will be removed after a migration window. New integrations should use [`/v1/tunnels`](../Endpoints/http-beta-tunnels.md) with the `anthropic-beta: mcp-tunnels-2026-06-22` header and a WIF token carrying the `workspace:manage_tunnels` scope. Existing integrations continue to work with the `mcp-tunnels-2026-05-19` header and `org:manage_tunnels` scope during the migration window.
Return the tunnel's current connection token.
The value is fetched live on each call; Anthropic does not store it. Repeated calls return the same value until the token is rotated. Exposed as `POST` so the token does not appear in intermediary access logs.
##### Path parameters
tunnel_id: string
ID of the Tunnel.
##### Headers
"anthropic-beta": array of "mcp-tunnels-2026-05-19"
Required for all Tunnel endpoints.
##### Returns
id: string
Stable identifier for the current token value. Changes when the token is rotated.
tunnel_token: string
The tunnel's connection token.
type: "tunnel_token"
Object type. Always `tunnel_token` for Tunnel Tokens.
defaulttunnel_token
Reveal Tunnel Token
cURL
```python
curl https://api.anthropic.com/v1/organizations/tunnels/$TUNNEL_ID/reveal_token \
-X POST \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
```
Response 200
```python
{
"id": "ttkn_bb97000eaec162831399ca9b6684a4fdf5be49ace5683057b017aab5c87e19e0",
"tunnel_token": "eyJhIjoiRVhBTVBMRSIsInQiOiJFWEFNUExFIiwicyI6IkVYQU1QTEUifQ==",
"type": "tunnel_token"
}
```
##### Returns Examples
Response 200
```python
{
"id": "ttkn_bb97000eaec162831399ca9b6684a4fdf5be49ace5683057b017aab5c87e19e0",
"tunnel_token": "eyJhIjoiRVhBTVBMRSIsInQiOiJFWEFNUExFIiwicyI6IkVYQU1QTEUifQ==",
---
## Rotate Tunnel Token - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/mcp_tunnels/rotate_token
Path: 04-API-Reference/Admin/admin-mcp-tunnels-rotate-token.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Fmcp_tunnels%2Frotate_token)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
API Keys
External Keys
Usage Report
Cost Report
Analytics
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
MCP Tunnels
Get Tunnel
List Tunnels
Reveal Tunnel Token
Rotate Tunnel Token
Archive Tunnel
Tunnel Certificates
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [MCP Tunnels](https://platform.claude.com/docs/en/api/http/admin/mcp_tunnels)
# Rotate Tunnel Token
Deprecated
POST/v1/organizations/tunnels/{tunnel_id}/rotate_token
**Deprecated.** This Admin API endpoint is superseded by `/v1/tunnels` on the Claude API and will be removed after a migration window. New integrations should use [`/v1/tunnels`](../Endpoints/http-beta-tunnels.md) with the `anthropic-beta: mcp-tunnels-2026-06-22` header and a WIF token carrying the `workspace:manage_tunnels` scope. Existing integrations continue to work with the `mcp-tunnels-2026-05-19` header and `org:manage_tunnels` scope during the migration window.
Invalidate the tunnel's current token for new connections and return a fresh value.
Established connections are not severed by rotation; a connector restarted after rotation must use the new value. An optional `reason` is captured for operational context.
##### Path parameters
tunnel_id: string
ID of the Tunnel.
##### Headers
"anthropic-beta": array of "mcp-tunnels-2026-05-19"
Required for all Tunnel endpoints.
##### Body
reason: optional string or null
Optional free-text reason for the rotation, recorded for audit.
maxLength1024
##### Returns
id: string
Stable identifier for the current token value. Changes when the token is rotated.
tunnel_token: string
The tunnel's connection token.
type: "tunnel_token"
Object type. Always `tunnel_token` for Tunnel Tokens.
defaulttunnel_token
Rotate Tunnel Token
cURL
```python
curl https://api.anthropic.com/v1/organizations/tunnels/$TUNNEL_ID/rotate_token \
-X POST \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
```
Response 200
```python
{
"id": "ttkn_bb97000eaec162831399ca9b6684a4fdf5be49ace5683057b017aab5c87e19e0",
"tunnel_token": "eyJhIjoiRVhBTVBMRSIsInQiOiJFWEFNUExFIiwicyI6IkVYQU1QTEUifQ==",
"type": "tunnel_token"
}
```
##### Returns Examples
Response 200
```python
{
"id": "ttkn_bb97000eaec162831399ca9b6684a4fdf5be49ace5683057b017aab5c87e19e0",
"tunnel_token": "eyJhIjoiRVhBTVBMRSIsInQiOiJFWEFNUExFIiwicyI6IkVYQU1QTEUifQ==",
---
## Archive Tunnel Certificate - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/mcp_tunnels/tunnel_certificates/archive
Path: 04-API-Reference/Admin/admin-mcp-tunnels-tunnel-certificates-archive.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Fmcp_tunnels%2Ftunnel_certificates%2Farchive)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
API Keys
External Keys
Usage Report
Cost Report
Analytics
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
MCP Tunnels
Get Tunnel
List Tunnels
Reveal Tunnel Token
Rotate Tunnel Token
Archive Tunnel
Tunnel Certificates
Create Tunnel Certificate
Get Tunnel Certificate
List Tunnel Certificates
Archive Tunnel Certificate
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [MCP Tunnels](https://platform.claude.com/docs/en/api/http/admin/mcp_tunnels)
4. [Tunnel Certificates](https://platform.claude.com/docs/en/api/http/admin/mcp_tunnels/tunnel_certificates)
# Archive Tunnel Certificate
Deprecated
POST/v1/organizations/tunnels/{tunnel_id}/certificates/{certificate_id}/archive
**Deprecated.** This Admin API endpoint is superseded by `/v1/tunnels` on the Claude API and will be removed after a migration window. New integrations should use [`/v1/tunnels`](../Endpoints/http-beta-tunnels.md) with the `anthropic-beta: mcp-tunnels-2026-06-22` header and a WIF token carrying the `workspace:manage_tunnels` scope. Existing integrations continue to work with the `mcp-tunnels-2026-05-19` header and `org:manage_tunnels` scope during the migration window.
Archive a certificate, removing it from the set Anthropic trusts for this tunnel.
The certificate record is retained. Archiving the last non-archived certificate is permitted; the tunnel rejects MCP traffic until a new certificate is added.
##### Path parameters
tunnel_id: string
ID of the Tunnel.
certificate_id: string
ID of the Tunnel Certificate.
##### Headers
"anthropic-beta": array of "mcp-tunnels-2026-05-19"
Required for all Tunnel endpoints.
##### Returns
id: string
ID of the Tunnel Certificate.
archived_at: string or null
RFC 3339 datetime string indicating when the certificate was archived, or `null` if it is not archived.
formatdate-time
created_at: string
RFC 3339 datetime string indicating when the certificate was registered.
formatdate-time
expires_at: string or null
RFC 3339 datetime string indicating when the certificate expires, or `null` if it does not expire.
formatdate-time
fingerprint: string
The certificate's SHA-256 fingerprint, as a lowercase hex string.
tunnel_id: string
ID of the Tunnel this certificate is registered against.
type: "tunnel_certificate"
Object type. Always `tunnel_certificate` for Tunnel Certificates.
defaulttunnel_certificate
Archive Tunnel Certificate
cURL
```python
curl https://api.anthropic.com/v1/organizations/tunnels/$TUNNEL_ID/certificates/$CERTIFICATE_ID/archive \
-X POST \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
```
Response 200
```python
{
"id": "tcrt_01JmWq4ZxnBvR7tKpY2sLdH9",
"archived_at": "2024-11-01T23:59:27.427722Z",
"created_at": "2024-10-30T23:58:27.427722Z",
"expires_at": "2024-10-30T23:58:27.427722Z",
"fingerprint": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
"tunnel_id": "tnl_01Hx9Kp2RtQvMn3sWbYdLcF8",
"type": "tunnel_certificate"
}
```
##### Returns Examples
Response 200
```python
{
"id": "tcrt_01JmWq4ZxnBvR7tKpY2sLdH9",
"archived_at": "2024-11-01T23:59:27.427722Z",
"created_at": "2024-10-30T23:58:27.427722Z",
"expires_at": "2024-10-30T23:58:27.427722Z",
"fingerprint": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
"tunnel_id": "tnl_01Hx9Kp2RtQvMn3sWbYdLcF8",
---
## Create Tunnel Certificate - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/mcp_tunnels/tunnel_certificates/create
Path: 04-API-Reference/Admin/admin-mcp-tunnels-tunnel-certificates-create.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Fmcp_tunnels%2Ftunnel_certificates%2Fcreate)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
API Keys
External Keys
Usage Report
Cost Report
Analytics
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
MCP Tunnels
Get Tunnel
List Tunnels
Reveal Tunnel Token
Rotate Tunnel Token
Archive Tunnel
Tunnel Certificates
Create Tunnel Certificate
Get Tunnel Certificate
List Tunnel Certificates
Archive Tunnel Certificate
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [MCP Tunnels](https://platform.claude.com/docs/en/api/http/admin/mcp_tunnels)
4. [Tunnel Certificates](https://platform.claude.com/docs/en/api/http/admin/mcp_tunnels/tunnel_certificates)
# Create Tunnel Certificate
Deprecated
POST/v1/organizations/tunnels/{tunnel_id}/certificates
**Deprecated.** This Admin API endpoint is superseded by `/v1/tunnels` on the Claude API and will be removed after a migration window. New integrations should use [`/v1/tunnels`](../Endpoints/http-beta-tunnels.md) with the `anthropic-beta: mcp-tunnels-2026-06-22` header and a WIF token carrying the `workspace:manage_tunnels` scope. Existing integrations continue to work with the `mcp-tunnels-2026-05-19` header and `org:manage_tunnels` scope during the migration window.
Register a public CA certificate for the tunnel.
Anthropic verifies the gateway's server certificate against this CA when it terminates the inner TLS session. The PEM body must contain exactly one X.509 certificate and no private-key material. A tunnel holds at most two non-archived certificates.
##### Path parameters
tunnel_id: string
ID of the Tunnel.
##### Headers
"anthropic-beta": array of "mcp-tunnels-2026-05-19"
Required for all Tunnel endpoints.
##### Body
ca_certificate_pem: string
PEM-encoded X.509 CA certificate. Must contain exactly one certificate and no private-key material.
maxLength8192
##### Returns
id: string
ID of the Tunnel Certificate.
archived_at: string or null
RFC 3339 datetime string indicating when the certificate was archived, or `null` if it is not archived.
formatdate-time
created_at: string
RFC 3339 datetime string indicating when the certificate was registered.
formatdate-time
expires_at: string or null
RFC 3339 datetime string indicating when the certificate expires, or `null` if it does not expire.
formatdate-time
fingerprint: string
The certificate's SHA-256 fingerprint, as a lowercase hex string.
tunnel_id: string
ID of the Tunnel this certificate is registered against.
type: "tunnel_certificate"
Object type. Always `tunnel_certificate` for Tunnel Certificates.
defaulttunnel_certificate
Create Tunnel Certificate
cURL
```python
curl https://api.anthropic.com/v1/organizations/tunnels/$TUNNEL_ID/certificates \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN" \
-d '{
"ca_certificate_pem": "-----BEGIN CERTIFICATE-----\nMIIBexampleEXAMPLEexampleEXAMPLEexampleEXAMPLEexampleEXAMPLEexa\n...illustrative placeholder, not a real certificate...\n-----END CERTIFICATE-----\n"
}'
```
Response 200
```python
{
"id": "tcrt_01JmWq4ZxnBvR7tKpY2sLdH9",
"archived_at": "2024-11-01T23:59:27.427722Z",
"created_at": "2024-10-30T23:58:27.427722Z",
"expires_at": "2024-10-30T23:58:27.427722Z",
"fingerprint": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
"tunnel_id": "tnl_01Hx9Kp2RtQvMn3sWbYdLcF8",
"type": "tunnel_certificate"
}
```
##### Returns Examples
Response 200
```python
{
"id": "tcrt_01JmWq4ZxnBvR7tKpY2sLdH9",
"archived_at": "2024-11-01T23:59:27.427722Z",
"created_at": "2024-10-30T23:58:27.427722Z",
"expires_at": "2024-10-30T23:58:27.427722Z",
"fingerprint": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
"tunnel_id": "tnl_01Hx9Kp2RtQvMn3sWbYdLcF8",
---
## List Tunnel Certificates - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/mcp_tunnels/tunnel_certificates/list
Path: 04-API-Reference/Admin/admin-mcp-tunnels-tunnel-certificates-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Fmcp_tunnels%2Ftunnel_certificates%2Flist)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
API Keys
External Keys
Usage Report
Cost Report
Analytics
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
MCP Tunnels
Get Tunnel
List Tunnels
Reveal Tunnel Token
Rotate Tunnel Token
Archive Tunnel
Tunnel Certificates
Create Tunnel Certificate
Get Tunnel Certificate
List Tunnel Certificates
Archive Tunnel Certificate
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [MCP Tunnels](https://platform.claude.com/docs/en/api/http/admin/mcp_tunnels)
4. [Tunnel Certificates](https://platform.claude.com/docs/en/api/http/admin/mcp_tunnels/tunnel_certificates)
# List Tunnel Certificates
Deprecated
GET/v1/organizations/tunnels/{tunnel_id}/certificates
**Deprecated.** This Admin API endpoint is superseded by `/v1/tunnels` on the Claude API and will be removed after a migration window. New integrations should use [`/v1/tunnels`](../Endpoints/http-beta-tunnels.md) with the `anthropic-beta: mcp-tunnels-2026-06-22` header and a WIF token carrying the `workspace:manage_tunnels` scope. Existing integrations continue to work with the `mcp-tunnels-2026-05-19` header and `org:manage_tunnels` scope during the migration window.
List the certificates registered on a tunnel.
Archived certificates are excluded unless `include_archived` is set.
##### Path parameters
tunnel_id: string
ID of the Tunnel.
##### Query parameters
include_archived: optional boolean
Include archived certificates in the results. Archived certificates are excluded by default.
defaultfalse
limit: optional number
Maximum number of certificates to return.
default20
maximum1000
minimum1
page: optional string
A tunnel has at most two active certificates, so this list is not paginated.
##### Headers
"anthropic-beta": array of "mcp-tunnels-2026-05-19"
Required for all Tunnel endpoints.
##### Returns
data: array of object{ id, archived_at, created_at, 4 more }
id: string
ID of the Tunnel Certificate.
archived_at: string or null
RFC 3339 datetime string indicating when the certificate was archived, or `null` if it is not archived.
formatdate-time
created_at: string
RFC 3339 datetime string indicating when the certificate was registered.
formatdate-time
expires_at: string or null
RFC 3339 datetime string indicating when the certificate expires, or `null` if it does not expire.
formatdate-time
fingerprint: string
The certificate's SHA-256 fingerprint, as a lowercase hex string.
tunnel_id: string
ID of the Tunnel this certificate is registered against.
type: "tunnel_certificate"
Object type. Always `tunnel_certificate` for Tunnel Certificates.
defaulttunnel_certificate
next_page: string or null
Opaque cursor for the next page, or `null` if there are no more results.
List Tunnel Certificates
cURL
```python
curl https://api.anthropic.com/v1/organizations/tunnels/$TUNNEL_ID/certificates \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
```
Response 200
```python
{
"data": [
{
"id": "tcrt_01JmWq4ZxnBvR7tKpY2sLdH9",
"archived_at": "2024-11-01T23:59:27.427722Z",
"created_at": "2024-10-30T23:58:27.427722Z",
"expires_at": "2024-10-30T23:58:27.427722Z",
"fingerprint": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
"tunnel_id": "tnl_01Hx9Kp2RtQvMn3sWbYdLcF8",
"type": "tunnel_certificate"
}
],
"next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo="
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"id": "tcrt_01JmWq4ZxnBvR7tKpY2sLdH9",
"archived_at": "2024-11-01T23:59:27.427722Z",
"created_at": "2024-10-30T23:58:27.427722Z",
"expires_at": "2024-10-30T23:58:27.427722Z",
"fingerprint": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
"tunnel_id": "tnl_01Hx9Kp2RtQvMn3sWbYdLcF8",
"type": "tunnel_certificate"
}
],
"next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo="
---
## Get Tunnel Certificate - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/mcp_tunnels/tunnel_certificates/retrieve
Path: 04-API-Reference/Admin/admin-mcp-tunnels-tunnel-certificates-retrieve.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Fmcp_tunnels%2Ftunnel_certificates%2Fretrieve)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
API Keys
External Keys
Usage Report
Cost Report
Analytics
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
MCP Tunnels
Get Tunnel
List Tunnels
Reveal Tunnel Token
Rotate Tunnel Token
Archive Tunnel
Tunnel Certificates
Create Tunnel Certificate
Get Tunnel Certificate
List Tunnel Certificates
Archive Tunnel Certificate
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [MCP Tunnels](https://platform.claude.com/docs/en/api/http/admin/mcp_tunnels)
4. [Tunnel Certificates](https://platform.claude.com/docs/en/api/http/admin/mcp_tunnels/tunnel_certificates)
# Get Tunnel Certificate
Deprecated
GET/v1/organizations/tunnels/{tunnel_id}/certificates/{certificate_id}
**Deprecated.** This Admin API endpoint is superseded by `/v1/tunnels` on the Claude API and will be removed after a migration window. New integrations should use [`/v1/tunnels`](../Endpoints/http-beta-tunnels.md) with the `anthropic-beta: mcp-tunnels-2026-06-22` header and a WIF token carrying the `workspace:manage_tunnels` scope. Existing integrations continue to work with the `mcp-tunnels-2026-05-19` header and `org:manage_tunnels` scope during the migration window.
Retrieve a single certificate registered on a tunnel by ID.
##### Path parameters
tunnel_id: string
ID of the Tunnel.
certificate_id: string
ID of the Tunnel Certificate.
##### Headers
"anthropic-beta": array of "mcp-tunnels-2026-05-19"
Required for all Tunnel endpoints.
##### Returns
id: string
ID of the Tunnel Certificate.
archived_at: string or null
RFC 3339 datetime string indicating when the certificate was archived, or `null` if it is not archived.
formatdate-time
created_at: string
RFC 3339 datetime string indicating when the certificate was registered.
formatdate-time
expires_at: string or null
RFC 3339 datetime string indicating when the certificate expires, or `null` if it does not expire.
formatdate-time
fingerprint: string
The certificate's SHA-256 fingerprint, as a lowercase hex string.
tunnel_id: string
ID of the Tunnel this certificate is registered against.
type: "tunnel_certificate"
Object type. Always `tunnel_certificate` for Tunnel Certificates.
defaulttunnel_certificate
Get Tunnel Certificate
cURL
```python
curl https://api.anthropic.com/v1/organizations/tunnels/$TUNNEL_ID/certificates/$CERTIFICATE_ID \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
```
Response 200
```python
{
"id": "tcrt_01JmWq4ZxnBvR7tKpY2sLdH9",
"archived_at": "2024-11-01T23:59:27.427722Z",
"created_at": "2024-10-30T23:58:27.427722Z",
"expires_at": "2024-10-30T23:58:27.427722Z",
"fingerprint": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
"tunnel_id": "tnl_01Hx9Kp2RtQvMn3sWbYdLcF8",
"type": "tunnel_certificate"
}
```
##### Returns Examples
Response 200
```python
{
"id": "tcrt_01JmWq4ZxnBvR7tKpY2sLdH9",
"archived_at": "2024-11-01T23:59:27.427722Z",
"created_at": "2024-10-30T23:58:27.427722Z",
"expires_at": "2024-10-30T23:58:27.427722Z",
"fingerprint": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
"tunnel_id": "tnl_01Hx9Kp2RtQvMn3sWbYdLcF8",
---
## Tunnel Certificates - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/mcp_tunnels/tunnel_certificates
Path: 04-API-Reference/Admin/admin-mcp-tunnels-tunnel-certificates.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Fmcp_tunnels%2Ftunnel_certificates)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
API Keys
External Keys
Usage Report
Cost Report
Analytics
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
MCP Tunnels
Get Tunnel
List Tunnels
Reveal Tunnel Token
Rotate Tunnel Token
Archive Tunnel
Tunnel Certificates
Create Tunnel Certificate
Get Tunnel Certificate
List Tunnel Certificates
Archive Tunnel Certificate
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [MCP Tunnels](https://platform.claude.com/docs/en/api/http/admin/mcp_tunnels)
# Tunnel Certificates
##### [Create Tunnel Certificate](https://platform.claude.com/docs/en/api/http/admin/mcp_tunnels/tunnel_certificates/create)
Deprecated
POST/v1/organizations/tunnels/{tunnel_id}/certificates
##### [Get Tunnel Certificate](https://platform.claude.com/docs/en/api/http/admin/mcp_tunnels/tunnel_certificates/retrieve)
Deprecated
GET/v1/organizations/tunnels/{tunnel_id}/certificates/{certificate_id}
##### [List Tunnel Certificates](https://platform.claude.com/docs/en/api/http/admin/mcp_tunnels/tunnel_certificates/list)
Deprecated
GET/v1/organizations/tunnels/{tunnel_id}/certificates
##### [Archive Tunnel Certificate](https://platform.claude.com/docs/en/api/http/admin/mcp_tunnels/tunnel_certificates/archive)
Deprecated
POST/v1/organizations/tunnels/{tunnel_id}/certificates/{certificate_id}/archive
##### Models
TunnelCertificateCreateResponse object{ id, archived_at, created_at, 4 more }
id: string
ID of the Tunnel Certificate.
archived_at: string or null
RFC 3339 datetime string indicating when the certificate was archived, or `null` if it is not archived.
formatdate-time
created_at: string
RFC 3339 datetime string indicating when the certificate was registered.
formatdate-time
expires_at: string or null
RFC 3339 datetime string indicating when the certificate expires, or `null` if it does not expire.
formatdate-time
fingerprint: string
The certificate's SHA-256 fingerprint, as a lowercase hex string.
tunnel_id: string
ID of the Tunnel this certificate is registered against.
type: "tunnel_certificate"
Object type. Always `tunnel_certificate` for Tunnel Certificates.
defaulttunnel_certificate
TunnelCertificateRetrieveResponse object{ id, archived_at, created_at, 4 more }
id: string
ID of the Tunnel Certificate.
archived_at: string or null
RFC 3339 datetime string indicating when the certificate was archived, or `null` if it is not archived.
formatdate-time
created_at: string
RFC 3339 datetime string indicating when the certificate was registered.
formatdate-time
expires_at: string or null
RFC 3339 datetime string indicating when the certificate expires, or `null` if it does not expire.
formatdate-time
fingerprint: string
The certificate's SHA-256 fingerprint, as a lowercase hex string.
tunnel_id: string
ID of the Tunnel this certificate is registered against.
type: "tunnel_certificate"
Object type. Always `tunnel_certificate` for Tunnel Certificates.
defaulttunnel_certificate
TunnelCertificateListResponse object{ id, archived_at, created_at, 4 more }
id: string
ID of the Tunnel Certificate.
archived_at: string or null
RFC 3339 datetime string indicating when the certificate was archived, or `null` if it is not archived.
formatdate-time
created_at: string
RFC 3339 datetime string indicating when the certificate was registered.
formatdate-time
expires_at: string or null
RFC 3339 datetime string indicating when the certificate expires, or `null` if it does not expire.
formatdate-time
fingerprint: string
The certificate's SHA-256 fingerprint, as a lowercase hex string.
tunnel_id: string
ID of the Tunnel this certificate is registered against.
type: "tunnel_certificate"
Object type. Always `tunnel_certificate` for Tunnel Certificates.
defaulttunnel_certificate
TunnelCertificateArchiveResponse object{ id, archived_at, created_at, 4 more }
id: string
ID of the Tunnel Certificate.
archived_at: string or null
RFC 3339 datetime string indicating when the certificate was archived, or `null` if it is not archived.
formatdate-time
created_at: string
RFC 3339 datetime string indicating when the certificate was registered.
formatdate-time
expires_at: string or null
RFC 3339 datetime string indicating when the certificate expires, or `null` if it does not expire.
formatdate-time
fingerprint: string
The certificate's SHA-256 fingerprint, as a lowercase hex string.
tunnel_id: string
ID of the Tunnel this certificate is registered against.
type: "tunnel_certificate"
Object type. Always `tunnel_certificate` for Tunnel Certificates.
---
## MCP Tunnels - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/mcp_tunnels
Path: 04-API-Reference/Admin/admin-mcp-tunnels.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Fmcp_tunnels)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
API Keys
External Keys
Usage Report
Cost Report
Analytics
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
MCP Tunnels
Get Tunnel
List Tunnels
Reveal Tunnel Token
Rotate Tunnel Token
Archive Tunnel
Tunnel Certificates
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
# MCP Tunnels
##### [Get Tunnel](https://platform.claude.com/docs/en/api/http/admin/mcp_tunnels/retrieve)
Deprecated
GET/v1/organizations/tunnels/{tunnel_id}
##### [List Tunnels](https://platform.claude.com/docs/en/api/http/admin/mcp_tunnels/list)
Deprecated
GET/v1/organizations/tunnels
##### [Reveal Tunnel Token](https://platform.claude.com/docs/en/api/http/admin/mcp_tunnels/reveal_token)
Deprecated
POST/v1/organizations/tunnels/{tunnel_id}/reveal_token
##### [Rotate Tunnel Token](https://platform.claude.com/docs/en/api/http/admin/mcp_tunnels/rotate_token)
Deprecated
POST/v1/organizations/tunnels/{tunnel_id}/rotate_token
##### [Archive Tunnel](https://platform.claude.com/docs/en/api/http/admin/mcp_tunnels/archive)
Deprecated
POST/v1/organizations/tunnels/{tunnel_id}/archive
##### Models
MCPTunnelRetrieveResponse object{ id, archived_at, created_at, 4 more }
id: string
ID of the Tunnel.
archived_at: string or null
RFC 3339 datetime string indicating when the Tunnel was archived, or `null` if it is not archived.
formatdate-time
created_at: string
RFC 3339 datetime string indicating when the Tunnel was created.
formatdate-time
display_name: string or null
Human-readable name for the Tunnel (1–255 characters), or `null` if unset.
domain: string
Anthropic-assigned hostname for the Tunnel. MCP server URLs whose host is a subdomain of this value are routed through the Tunnel. Globally unique and never reused, even after the Tunnel is archived.
type: "tunnel"
Object type. Always `tunnel` for Tunnels.
defaulttunnel
workspace_id: string or null
ID of the Workspace this Tunnel belongs to, or `null` for the default Workspace. Immutable after creation.
MCPTunnelListResponse object{ id, archived_at, created_at, 4 more }
id: string
ID of the Tunnel.
archived_at: string or null
RFC 3339 datetime string indicating when the Tunnel was archived, or `null` if it is not archived.
formatdate-time
created_at: string
RFC 3339 datetime string indicating when the Tunnel was created.
formatdate-time
display_name: string or null
Human-readable name for the Tunnel (1–255 characters), or `null` if unset.
domain: string
Anthropic-assigned hostname for the Tunnel. MCP server URLs whose host is a subdomain of this value are routed through the Tunnel. Globally unique and never reused, even after the Tunnel is archived.
type: "tunnel"
Object type. Always `tunnel` for Tunnels.
defaulttunnel
workspace_id: string or null
ID of the Workspace this Tunnel belongs to, or `null` for the default Workspace. Immutable after creation.
MCPTunnelArchiveResponse object{ id, archived_at, created_at, 4 more }
id: string
ID of the Tunnel.
archived_at: string or null
RFC 3339 datetime string indicating when the Tunnel was archived, or `null` if it is not archived.
formatdate-time
created_at: string
RFC 3339 datetime string indicating when the Tunnel was created.
formatdate-time
display_name: string or null
Human-readable name for the Tunnel (1–255 characters), or `null` if unset.
domain: string
Anthropic-assigned hostname for the Tunnel. MCP server URLs whose host is a subdomain of this value are routed through the Tunnel. Globally unique and never reused, even after the Tunnel is archived.
type: "tunnel"
Object type. Always `tunnel` for Tunnels.
defaulttunnel
workspace_id: string or null
ID of the Workspace this Tunnel belongs to, or `null` for the default Workspace. Immutable after creation.
MCPTunnelRevealTokenResponse object{ id, tunnel_token, type }
id: string
Stable identifier for the current token value. Changes when the token is rotated.
tunnel_token: string
The tunnel's connection token.
type: "tunnel_token"
Object type. Always `tunnel_token` for Tunnel Tokens.
defaulttunnel_token
MCPTunnelRotateTokenResponse object{ id, tunnel_token, type }
id: string
Stable identifier for the current token value. Changes when the token is rotated.
tunnel_token: string
The tunnel's connection token.
type: "tunnel_token"
Object type. Always `tunnel_token` for Tunnel Tokens.
defaulttunnel_token
#### MCP Tunnels[Tunnel Certificates](https://platform.claude.com/docs/en/api/http/admin/mcp_tunnels/tunnel_certificates)
##### [Create Tunnel Certificate](https://platform.claude.com/docs/en/api/http/admin/mcp_tunnels/tunnel_certificates/create)
Deprecated
POST/v1/organizations/tunnels/{tunnel_id}/certificates
##### [Get Tunnel Certificate](https://platform.claude.com/docs/en/api/http/admin/mcp_tunnels/tunnel_certificates/retrieve)
Deprecated
GET/v1/organizations/tunnels/{tunnel_id}/certificates/{certificate_id}
##### [List Tunnel Certificates](https://platform.claude.com/docs/en/api/http/admin/mcp_tunnels/tunnel_certificates/list)
Deprecated
GET/v1/organizations/tunnels/{tunnel_id}/certificates
##### [Archive Tunnel Certificate](https://platform.claude.com/docs/en/api/http/admin/mcp_tunnels/tunnel_certificates/archive)
Deprecated
POST/v1/organizations/tunnels/{tunnel_id}/certificates/{certificate_id}/archive
---
## Get Current Organization - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/organizations/me
Path: 04-API-Reference/Admin/admin-organizations-me.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Forganizations%2Fme)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Get Current Organization
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
API Keys
External Keys
Usage Report
Cost Report
Analytics
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [Organizations](https://platform.claude.com/docs/en/api/http/admin/organizations)
# Get Current Organization
GET/v1/organizations/me
Retrieve information about the organization associated with the authenticated API key.
##### Returns
Organization object{ id, name, type }
id: string
ID of the Organization.
formatuuid
name: string
Name of the Organization.
type: "organization"
Object type.
For Organizations, this is always `"organization"`.
defaultorganization
Get Current Organization
cURL
```python
curl https://api.anthropic.com/v1/organizations/me \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
```
Response 200
```python
{
"id": "12345678-1234-5678-1234-567812345678",
"name": "Organization Name",
"type": "organization"
}
```
##### Returns Examples
Response 200
```python
{
"id": "12345678-1234-5678-1234-567812345678",
---
## Organizations - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/organizations
Path: 04-API-Reference/Admin/admin-organizations.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Forganizations)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Get Current Organization
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
API Keys
External Keys
Usage Report
Cost Report
Analytics
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
# Organizations
##### [Get Current Organization](https://platform.claude.com/docs/en/api/http/admin/organizations/me)
GET/v1/organizations/me
##### Models
Organization object{ id, name, type }
id: string
ID of the Organization.
formatuuid
name: string
Name of the Organization.
type: "organization"
Object type.
For Organizations, this is always `"organization"`.
---
## List Organization Rate Limits - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/rate_limits/list
Path: 04-API-Reference/Admin/admin-rate-limits-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Frate_limits%2Flist)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
API Keys
External Keys
Usage Report
Cost Report
Analytics
Spend Limits
Rate Limits
List Organization Rate Limits
Service Accounts
Federation Issuers
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [Rate Limits](https://platform.claude.com/docs/en/api/http/admin/rate_limits)
# List Organization Rate Limits
GET/v1/organizations/rate_limits
List Messages API rate limits for your organization.
Each entry corresponds to one rate-limit group (either a model family or an API-surface category such as the Files API or Message Batches) and contains the set of limiter values that apply to it.
When `limit` is omitted, every matching entry is returned in a single page; when `limit` truncates the result, follow `next_page` to fetch the remaining entries.
##### Query parameters
group_type: optional "batch" or "files" or "model_group" or 3 more
Filter by group type.
One of the following:
"batch"
"files"
"model_group"
"skills"
"token_count"
"web_search"
limit: optional number
Maximum number of items to return per page. Ranges from `1` to `1000`.
When omitted, every remaining entry is returned in a single page and `next_page` is `null`.
maximum1000
minimum1
model: optional string
Filter to the single entry containing this model. Accepts full model names and aliases. Returns 404 if the model is not found or has no rate limits for this organization.
page: optional string
Opaque cursor from a previous response's `next_page`.
##### Returns
data: array of object{ id, group_type, limits, 2 more }
Rate-limit entries for the organization, one per group.
id: string
Stable identifier for this rate-limit group within the organization.
group_type: "batch" or "files" or "model_group" or 3 more
The kind of rate-limit group this entry represents. `model_group` entries apply to a family of models (listed in `models`); other values apply to an API-surface category and have `models` set to `null`.
One of the following:
"batch"
"files"
"model_group"
"skills"
"token_count"
"web_search"
limits: array of object{ type, value }
The limiter values that apply to this group.
type: string
The limiter type (for example, `requests_per_minute` or `input_tokens_per_minute`).
value: number
The configured limit value for this limiter type.
models: array of string or null
Model names this entry's limits apply to, including aliases. `null` when `group_type` is not `"model_group"`.
type: "rate_limit"
Object type. Always `rate_limit` for organization rate-limit entries.
defaultrate_limit
next_page: string or null
Opaque cursor for the next page of results, or `null` when no entries remain beyond this response.
List Organization Rate Limits
cURL
```python
curl https://api.anthropic.com/v1/organizations/rate_limits \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
---
## Rate Limits - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/rate_limits
Path: 04-API-Reference/Admin/admin-rate-limits.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Frate_limits)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
API Keys
External Keys
Usage Report
Cost Report
Analytics
Spend Limits
Rate Limits
List Organization Rate Limits
Service Accounts
Federation Issuers
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
# Rate Limits
##### [List Organization Rate Limits](https://platform.claude.com/docs/en/api/http/admin/rate_limits/list)
GET/v1/organizations/rate_limits
##### Models
RateLimitListResponse object{ id, group_type, limits, 2 more }
---
## Create RBAC Group - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/rbac_groups/create
Path: 04-API-Reference/Admin/admin-rbac-groups-create.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Frbac_groups%2Fcreate)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
List RBAC Groups
Get RBAC Group
Create RBAC Group
Update RBAC Group
Delete RBAC Group
Members
RBAC Roles
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [RBAC Groups](https://platform.claude.com/docs/en/api/http/beta/organization/rbac_groups)
# Create RBAC Group
POST/v1/organizations/rbac_groups
Create an RBAC Group in the Claude Enterprise tenant. Groups created via the API have source type `"direct"`.
The RBAC Groups API is available to Claude Enterprise organizations only.
##### Body
name: string
Name of the RBAC Group. Not uniqueness-enforced.
maxLength255
minLength1
##### Returns
BetaRBACGroup object{ type: "rbac_group", id, created_at, 4 more }
type: "rbac_group"
Object type.
For RBAC Groups, this is always `"rbac_group"`.
defaultrbac_group
id: string
ID of the RBAC Group.
created_at: string
RFC 3339 timestamp of when the RBAC Group was created.
formatdate-time
name: string
Name of the RBAC Group. Not uniqueness-enforced.
roles: array of string or null
RBAC Role IDs attached to this RBAC Group. Role attachment is managed in the admin settings and is read-only on this API. `null` means role data was temporarily unavailable — retry to distinguish from an empty list.
source_type: "direct" or "scim"
How the RBAC Group was created: `"direct"` for groups created directly (for example, in the organization's admin settings), `"scim"` for groups provisioned by the identity provider.
One of the following:
"direct"
"scim"
updated_at: string
RFC 3339 timestamp of when the RBAC Group was last updated.
formatdate-time
Create RBAC Group
cURL
```python
curl https://api.anthropic.com/v1/organizations/rbac_groups \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY" \
-d '{
"name": "Engineering"
}'
```
Response 200
```python
{
"id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"created_at": "2024-10-30T23:58:27.427722Z",
"name": "Engineering",
"roles": [
"rbac_role_016J8xVtKpDq3Wy9ZmN2hR4s"
],
"source_type": "direct",
"type": "rbac_group",
"updated_at": "2024-10-30T23:58:27.427722Z"
}
```
##### Returns Examples
Response 200
```python
{
"id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"created_at": "2024-10-30T23:58:27.427722Z",
"name": "Engineering",
"roles": [
"rbac_role_016J8xVtKpDq3Wy9ZmN2hR4s"
],
"source_type": "direct",
"type": "rbac_group",
"updated_at": "2024-10-30T23:58:27.427722Z"
---
## Delete RBAC Group - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/rbac_groups/delete
Path: 04-API-Reference/Admin/admin-rbac-groups-delete.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Frbac_groups%2Fdelete)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
List RBAC Groups
Get RBAC Group
Create RBAC Group
Update RBAC Group
Delete RBAC Group
Members
RBAC Roles
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [RBAC Groups](https://platform.claude.com/docs/en/api/http/beta/organization/rbac_groups)
# Delete RBAC Group
DELETE/v1/organizations/rbac_groups/{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.
The RBAC Groups API is available to Claude Enterprise organizations only.
##### Path parameters
group_id: string
ID of the RBAC Group.
##### Returns
BetaRBACGroupDeleted object{ type: "rbac_group_deleted", id }
type: "rbac_group_deleted"
Deleted object type.
For RBAC Groups, this is always `"rbac_group_deleted"`.
defaultrbac_group_deleted
id: string
ID of the RBAC Group.
Delete RBAC Group
cURL
```python
curl https://api.anthropic.com/v1/organizations/rbac_groups/$GROUP_ID \
-X DELETE \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"type": "rbac_group_deleted"
}
```
##### Returns Examples
Response 200
```python
{
"id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
---
## List RBAC Groups - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/rbac_groups/list
Path: 04-API-Reference/Admin/admin-rbac-groups-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Frbac_groups%2Flist)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
List RBAC Groups
Get RBAC Group
Create RBAC Group
Update RBAC Group
Delete RBAC Group
Members
RBAC Roles
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [RBAC Groups](https://platform.claude.com/docs/en/api/http/beta/organization/rbac_groups)
# List RBAC Groups
GET/v1/organizations/rbac_groups
List RBAC Groups in the Claude Enterprise tenant.
The RBAC Groups API is available to Claude Enterprise organizations only.
##### Query parameters
limit: optional number
Number of items to return per page.
Defaults to `20`. Ranges from `1` to `1000`.
default20
maximum1000
minimum1
page: optional string
Optionally set to the `next_page` token from the previous response.
##### Returns
data: array of [BetaRBACGroup](https://platform.claude.com/docs/en/api/http/beta/organization/rbac_groups#beta_rbac_group) { type: "rbac_group", id, created_at, 4 more }
type: "rbac_group"
Object type.
For RBAC Groups, this is always `"rbac_group"`.
defaultrbac_group
id: string
ID of the RBAC Group.
created_at: string
RFC 3339 timestamp of when the RBAC Group was created.
formatdate-time
name: string
Name of the RBAC Group. Not uniqueness-enforced.
roles: array of string or null
RBAC Role IDs attached to this RBAC Group. Role attachment is managed in the admin settings and is read-only on this API. `null` means role data was temporarily unavailable — retry to distinguish from an empty list.
source_type: "direct" or "scim"
How the RBAC Group was created: `"direct"` for groups created directly (for example, in the organization's admin settings), `"scim"` for groups provisioned by the identity provider.
One of the following:
"direct"
"scim"
updated_at: string
RFC 3339 timestamp of when the RBAC Group was last updated.
formatdate-time
has_more: boolean
Indicates if there are more results in the requested page direction.
next_page: string or null
Token to provide in as `page` in the subsequent request to retrieve the next page of data.
List RBAC Groups
cURL
```python
curl https://api.anthropic.com/v1/organizations/rbac_groups \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"data": [
{
"id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"created_at": "2024-10-30T23:58:27.427722Z",
"name": "Engineering",
"roles": [
"rbac_role_016J8xVtKpDq3Wy9ZmN2hR4s"
],
"source_type": "direct",
"type": "rbac_group",
"updated_at": "2024-10-30T23:58:27.427722Z"
}
],
"has_more": false,
"next_page": "eyJjdXJzb3IiOiAicmJhY19ncm91cF8wMSJ9"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"created_at": "2024-10-30T23:58:27.427722Z",
"name": "Engineering",
"roles": [
"rbac_role_016J8xVtKpDq3Wy9ZmN2hR4s"
],
"source_type": "direct",
"type": "rbac_group",
"updated_at": "2024-10-30T23:58:27.427722Z"
}
],
"has_more": false,
"next_page": "eyJjdXJzb3IiOiAicmJhY19ncm91cF8wMSJ9"
---
## Add RBAC Group Member - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/rbac_groups/members/create
Path: 04-API-Reference/Admin/admin-rbac-groups-members-create.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Frbac_groups%2Fmembers%2Fcreate)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
List RBAC Groups
Get RBAC Group
Create RBAC Group
Update RBAC Group
Delete RBAC Group
Members
List RBAC Group Members
Add RBAC Group Member
Remove RBAC Group Member
RBAC Roles
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [RBAC Groups](https://platform.claude.com/docs/en/api/http/beta/organization/rbac_groups)
5. [Members](https://platform.claude.com/docs/en/api/http/beta/organization/rbac_groups/members)
# Add RBAC Group Member
POST/v1/organizations/rbac_groups/{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.
The RBAC Groups API is available to Claude Enterprise organizations only.
##### Path parameters
group_id: string
ID of the RBAC Group.
##### Body
user_id: string
ID of the User.
##### Returns
BetaRBACGroupMember object{ type: "rbac_group_member", created_at, email, 2 more }
type: "rbac_group_member"
Object type.
For RBAC Group Members, this is always `"rbac_group_member"`.
defaultrbac_group_member
created_at: string
RFC 3339 timestamp of when the User was added to the RBAC Group.
formatdate-time
email: string
Email of the User.
group_id: string
ID of the RBAC Group.
user_id: string
ID of the User.
Add RBAC Group Member
cURL
```python
curl https://api.anthropic.com/v1/organizations/rbac_groups/$GROUP_ID/members \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY" \
-d '{
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
}'
```
Response 200
```python
{
"created_at": "2024-10-30T23:58:27.427722Z",
"email": "user@emaildomain.com",
"group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"type": "rbac_group_member",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
}
```
##### Returns Examples
Response 200
```python
{
"created_at": "2024-10-30T23:58:27.427722Z",
"email": "user@emaildomain.com",
"group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"type": "rbac_group_member",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
---
## Remove RBAC Group Member - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/rbac_groups/members/delete
Path: 04-API-Reference/Admin/admin-rbac-groups-members-delete.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Frbac_groups%2Fmembers%2Fdelete)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
List RBAC Groups
Get RBAC Group
Create RBAC Group
Update RBAC Group
Delete RBAC Group
Members
List RBAC Group Members
Add RBAC Group Member
Remove RBAC Group Member
RBAC Roles
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [RBAC Groups](https://platform.claude.com/docs/en/api/http/beta/organization/rbac_groups)
5. [Members](https://platform.claude.com/docs/en/api/http/beta/organization/rbac_groups/members)
# Remove RBAC Group Member
DELETE/v1/organizations/rbac_groups/{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.
The RBAC Groups API is available to Claude Enterprise organizations only.
##### Path parameters
group_id: string
ID of the RBAC Group.
user_id: string
ID of the User.
##### Returns
BetaRBACGroupMemberDeleted object{ type: "rbac_group_member_deleted", group_id, user_id }
type: "rbac_group_member_deleted"
Deleted object type. For RBAC Group Members, this is always `"rbac_group_member_deleted"`.
defaultrbac_group_member_deleted
group_id: string
ID of the RBAC Group.
user_id: string
ID of the User.
Remove RBAC Group Member
cURL
```python
curl https://api.anthropic.com/v1/organizations/rbac_groups/$GROUP_ID/members/$USER_ID \
-X DELETE \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"type": "rbac_group_member_deleted",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
}
```
##### Returns Examples
Response 200
```python
{
"group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"type": "rbac_group_member_deleted",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
---
## List RBAC Group Members - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/rbac_groups/members/list
Path: 04-API-Reference/Admin/admin-rbac-groups-members-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Frbac_groups%2Fmembers%2Flist)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
List RBAC Groups
Get RBAC Group
Create RBAC Group
Update RBAC Group
Delete RBAC Group
Members
List RBAC Group Members
Add RBAC Group Member
Remove RBAC Group Member
RBAC Roles
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [RBAC Groups](https://platform.claude.com/docs/en/api/http/beta/organization/rbac_groups)
5. [Members](https://platform.claude.com/docs/en/api/http/beta/organization/rbac_groups/members)
# List RBAC Group Members
GET/v1/organizations/rbac_groups/{group_id}/members
List members of an RBAC Group.
The RBAC Groups API is available to Claude Enterprise organizations only.
##### Path parameters
group_id: string
ID of the RBAC Group.
##### Query parameters
limit: optional number
Number of items to return per page.
Defaults to `20`. Ranges from `1` to `1000`.
default20
maximum1000
minimum1
page: optional string
Optionally set to the `next_page` token from the previous response.
##### Returns
data: array of [BetaRBACGroupMember](https://platform.claude.com/docs/en/api/http/beta/organization/rbac_groups/members#beta_rbac_group_member) { type: "rbac_group_member", created_at, email, 2 more }
type: "rbac_group_member"
Object type.
For RBAC Group Members, this is always `"rbac_group_member"`.
defaultrbac_group_member
created_at: string
RFC 3339 timestamp of when the User was added to the RBAC Group.
formatdate-time
email: string
Email of the User.
group_id: string
ID of the RBAC Group.
user_id: string
ID of the User.
has_more: boolean
Indicates if there are more results in the requested page direction.
next_page: string or null
Token to provide in as `page` in the subsequent request to retrieve the next page of data.
List RBAC Group Members
cURL
```python
curl https://api.anthropic.com/v1/organizations/rbac_groups/$GROUP_ID/members \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"data": [
{
"created_at": "2024-10-30T23:58:27.427722Z",
"email": "user@emaildomain.com",
"group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"type": "rbac_group_member",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
}
],
"has_more": false,
"next_page": "eyJjdXJzb3IiOiAicmJhY19ncm91cF8wMSJ9"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"created_at": "2024-10-30T23:58:27.427722Z",
"email": "user@emaildomain.com",
"group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"type": "rbac_group_member",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
}
],
"has_more": false,
"next_page": "eyJjdXJzb3IiOiAicmJhY19ncm91cF8wMSJ9"
---
## Members - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/rbac_groups/members
Path: 04-API-Reference/Admin/admin-rbac-groups-members.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Frbac_groups%2Fmembers)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
List RBAC Groups
Get RBAC Group
Create RBAC Group
Update RBAC Group
Delete RBAC Group
Members
List RBAC Group Members
Add RBAC Group Member
Remove RBAC Group Member
RBAC Roles
Workspaces
API Keys
External Keys
Usage Report
Cost Report
Analytics
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [RBAC Groups](https://platform.claude.com/docs/en/api/http/admin/rbac_groups)
# Members
##### [List RBAC Group Members](https://platform.claude.com/docs/en/api/http/admin/rbac_groups/members/list)
GET/v1/organizations/rbac_groups/{group_id}/members
##### [Add RBAC Group Member](https://platform.claude.com/docs/en/api/http/admin/rbac_groups/members/create)
POST/v1/organizations/rbac_groups/{group_id}/members
##### [Remove RBAC Group Member](https://platform.claude.com/docs/en/api/http/admin/rbac_groups/members/delete)
DELETE/v1/organizations/rbac_groups/{group_id}/members/{user_id}
##### Models
RbacGroupMember object{ created_at, email, group_id, 2 more }
created_at: string
RFC 3339 timestamp of when the User was added to the RBAC Group.
formatdate-time
email: string
Email of the User.
group_id: string
ID of the RBAC Group.
type: "rbac_group_member"
Object type.
For RBAC Group Members, this is always `"rbac_group_member"`.
defaultrbac_group_member
user_id: string
ID of the User.
RbacGroupMemberDeleted object{ group_id, type, user_id }
group_id: string
ID of the RBAC Group.
type: "rbac_group_member_deleted"
Deleted object type. For RBAC Group Members, this is always `"rbac_group_member_deleted"`.
defaultrbac_group_member_deleted
user_id: string
ID of the User.
---
## Get RBAC Group - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/rbac_groups/retrieve
Path: 04-API-Reference/Admin/admin-rbac-groups-retrieve.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Frbac_groups%2Fretrieve)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
List RBAC Groups
Get RBAC Group
Create RBAC Group
Update RBAC Group
Delete RBAC Group
Members
RBAC Roles
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [RBAC Groups](https://platform.claude.com/docs/en/api/http/beta/organization/rbac_groups)
# Get RBAC Group
GET/v1/organizations/rbac_groups/{group_id}
Retrieve an RBAC Group by ID.
The RBAC Groups API is available to Claude Enterprise organizations only.
##### Path parameters
group_id: string
ID of the RBAC Group.
##### Returns
BetaRBACGroup object{ type: "rbac_group", id, created_at, 4 more }
type: "rbac_group"
Object type.
For RBAC Groups, this is always `"rbac_group"`.
defaultrbac_group
id: string
ID of the RBAC Group.
created_at: string
RFC 3339 timestamp of when the RBAC Group was created.
formatdate-time
name: string
Name of the RBAC Group. Not uniqueness-enforced.
roles: array of string or null
RBAC Role IDs attached to this RBAC Group. Role attachment is managed in the admin settings and is read-only on this API. `null` means role data was temporarily unavailable — retry to distinguish from an empty list.
source_type: "direct" or "scim"
How the RBAC Group was created: `"direct"` for groups created directly (for example, in the organization's admin settings), `"scim"` for groups provisioned by the identity provider.
One of the following:
"direct"
"scim"
updated_at: string
RFC 3339 timestamp of when the RBAC Group was last updated.
formatdate-time
Get RBAC Group
cURL
```python
curl https://api.anthropic.com/v1/organizations/rbac_groups/$GROUP_ID \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"created_at": "2024-10-30T23:58:27.427722Z",
"name": "Engineering",
"roles": [
"rbac_role_016J8xVtKpDq3Wy9ZmN2hR4s"
],
"source_type": "direct",
"type": "rbac_group",
"updated_at": "2024-10-30T23:58:27.427722Z"
}
```
##### Returns Examples
Response 200
```python
{
"id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"created_at": "2024-10-30T23:58:27.427722Z",
"name": "Engineering",
"roles": [
"rbac_role_016J8xVtKpDq3Wy9ZmN2hR4s"
],
"source_type": "direct",
"type": "rbac_group",
"updated_at": "2024-10-30T23:58:27.427722Z"
---
## Update RBAC Group - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/rbac_groups/update
Path: 04-API-Reference/Admin/admin-rbac-groups-update.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Frbac_groups%2Fupdate)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
List RBAC Groups
Get RBAC Group
Create RBAC Group
Update RBAC Group
Delete RBAC Group
Members
RBAC Roles
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [RBAC Groups](https://platform.claude.com/docs/en/api/http/beta/organization/rbac_groups)
# Update RBAC Group
POST/v1/organizations/rbac_groups/{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.
The RBAC Groups API is available to Claude Enterprise organizations only.
##### Path parameters
group_id: string
ID of the RBAC Group.
##### Body
name: optional string or null
Name of the RBAC Group. Not uniqueness-enforced.
maxLength255
minLength1
##### Returns
BetaRBACGroup object{ type: "rbac_group", id, created_at, 4 more }
type: "rbac_group"
Object type.
For RBAC Groups, this is always `"rbac_group"`.
defaultrbac_group
id: string
ID of the RBAC Group.
created_at: string
RFC 3339 timestamp of when the RBAC Group was created.
formatdate-time
name: string
Name of the RBAC Group. Not uniqueness-enforced.
roles: array of string or null
RBAC Role IDs attached to this RBAC Group. Role attachment is managed in the admin settings and is read-only on this API. `null` means role data was temporarily unavailable — retry to distinguish from an empty list.
source_type: "direct" or "scim"
How the RBAC Group was created: `"direct"` for groups created directly (for example, in the organization's admin settings), `"scim"` for groups provisioned by the identity provider.
One of the following:
"direct"
"scim"
updated_at: string
RFC 3339 timestamp of when the RBAC Group was last updated.
formatdate-time
Update RBAC Group
cURL
```python
curl https://api.anthropic.com/v1/organizations/rbac_groups/$GROUP_ID \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY" \
-d '{
"name": "Engineering"
}'
```
Response 200
```python
{
"id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"created_at": "2024-10-30T23:58:27.427722Z",
"name": "Engineering",
"roles": [
"rbac_role_016J8xVtKpDq3Wy9ZmN2hR4s"
],
"source_type": "direct",
"type": "rbac_group",
"updated_at": "2024-10-30T23:58:27.427722Z"
}
```
##### Returns Examples
Response 200
```python
{
"id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"created_at": "2024-10-30T23:58:27.427722Z",
"name": "Engineering",
"roles": [
"rbac_role_016J8xVtKpDq3Wy9ZmN2hR4s"
],
"source_type": "direct",
"type": "rbac_group",
"updated_at": "2024-10-30T23:58:27.427722Z"
---
## RBAC Groups - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/rbac_groups
Path: 04-API-Reference/Admin/admin-rbac-groups.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Frbac_groups)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
List RBAC Groups
Get RBAC Group
Create RBAC Group
Update RBAC Group
Delete RBAC Group
Members
RBAC Roles
Workspaces
API Keys
External Keys
Usage Report
Cost Report
Analytics
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
# RBAC Groups
##### [List RBAC Groups](https://platform.claude.com/docs/en/api/http/admin/rbac_groups/list)
GET/v1/organizations/rbac_groups
##### [Get RBAC Group](https://platform.claude.com/docs/en/api/http/admin/rbac_groups/retrieve)
GET/v1/organizations/rbac_groups/{group_id}
##### [Create RBAC Group](https://platform.claude.com/docs/en/api/http/admin/rbac_groups/create)
POST/v1/organizations/rbac_groups
##### [Update RBAC Group](https://platform.claude.com/docs/en/api/http/admin/rbac_groups/update)
POST/v1/organizations/rbac_groups/{group_id}
##### [Delete RBAC Group](https://platform.claude.com/docs/en/api/http/admin/rbac_groups/delete)
DELETE/v1/organizations/rbac_groups/{group_id}
##### Models
RbacGroup object{ id, created_at, name, 4 more }
id: string
ID of the RBAC Group.
created_at: string
RFC 3339 timestamp of when the RBAC Group was created.
formatdate-time
name: string
Name of the RBAC Group. Not uniqueness-enforced.
roles: array of string or null
RBAC Role IDs attached to this RBAC Group. Role attachment is managed in the admin settings and is read-only on this API. `null` means role data was temporarily unavailable — retry to distinguish from an empty list.
source_type: "direct" or "scim"
How the RBAC Group was created: `"direct"` for groups created directly (for example, in the organization's admin settings), `"scim"` for groups provisioned by the identity provider.
One of the following:
"direct"
"scim"
type: "rbac_group"
Object type.
For RBAC Groups, this is always `"rbac_group"`.
defaultrbac_group
updated_at: string
RFC 3339 timestamp of when the RBAC Group was last updated.
formatdate-time
RbacGroupDeleted object{ id, type }
id: string
ID of the RBAC Group.
type: "rbac_group_deleted"
Deleted object type.
For RBAC Groups, this is always `"rbac_group_deleted"`.
defaultrbac_group_deleted
#### RBAC Groups[Members](https://platform.claude.com/docs/en/api/http/admin/rbac_groups/members)
##### [List RBAC Group Members](https://platform.claude.com/docs/en/api/http/admin/rbac_groups/members/list)
GET/v1/organizations/rbac_groups/{group_id}/members
##### [Add RBAC Group Member](https://platform.claude.com/docs/en/api/http/admin/rbac_groups/members/create)
POST/v1/organizations/rbac_groups/{group_id}/members
##### [Remove RBAC Group Member](https://platform.claude.com/docs/en/api/http/admin/rbac_groups/members/delete)
DELETE/v1/organizations/rbac_groups/{group_id}/members/{user_id}
---
## List RBAC Roles - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/rbac_roles/list
Path: 04-API-Reference/Admin/admin-rbac-roles-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Frbac_roles%2Flist)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
List RBAC Roles
Get RBAC Role
Permissions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [RBAC Roles](https://platform.claude.com/docs/en/api/http/beta/organization/rbac_roles)
# List RBAC Roles
GET/v1/organizations/rbac_roles
List RBAC Roles in the organization.
The RBAC Roles API is available to Claude Enterprise organizations only.
##### Query parameters
limit: optional number
Number of items to return per page.
Defaults to `20`. Ranges from `1` to `1000`.
default20
maximum1000
minimum1
page: optional string
Optionally set to the `next_page` token from the previous response.
##### Returns
data: array of [BetaRBACRole](https://platform.claude.com/docs/en/api/http/beta/organization/rbac_roles#beta_rbac_role) { type: "rbac_role", id, created_at, 2 more }
type: "rbac_role"
Object type.
For RBAC Roles, this is always `"rbac_role"`.
defaultrbac_role
id: string
ID of the RBAC Role.
created_at: string
RFC 3339 datetime string indicating when the RBAC Role was created.
formatdate-time
name: string
Name of the RBAC Role.
updated_at: string
RFC 3339 datetime string indicating when the RBAC Role was last updated.
formatdate-time
has_more: boolean
Indicates whether there are more results beyond this page.
next_page: string or null
Opaque cursor for the next page. Pass as the `page` parameter on the next request.
List RBAC Roles
cURL
```python
curl https://api.anthropic.com/v1/organizations/rbac_roles \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"data": [
{
"id": "rbac_role_016J8xVtKpDq3Wy9ZmN2hR4s",
"created_at": "2024-10-30T23:58:27.427722Z",
"name": "Project Editor",
"type": "rbac_role",
"updated_at": "2024-10-30T23:58:27.427722Z"
}
],
"has_more": true,
"next_page": "eyJjdXJzb3IiOiAicmJhY19yb2xlXzAxIn0"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"id": "rbac_role_016J8xVtKpDq3Wy9ZmN2hR4s",
"created_at": "2024-10-30T23:58:27.427722Z",
"name": "Project Editor",
"type": "rbac_role",
"updated_at": "2024-10-30T23:58:27.427722Z"
}
],
"has_more": true,
"next_page": "eyJjdXJzb3IiOiAicmJhY19yb2xlXzAxIn0"
---
## List RBAC Role Permissions - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/rbac_roles/permissions/list
Path: 04-API-Reference/Admin/admin-rbac-roles-permissions-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Frbac_roles%2Fpermissions%2Flist)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
List RBAC Roles
Get RBAC Role
Permissions
List RBAC Role Permissions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [RBAC Roles](https://platform.claude.com/docs/en/api/http/beta/organization/rbac_roles)
5. [Permissions](https://platform.claude.com/docs/en/api/http/beta/organization/rbac_roles/permissions)
# List RBAC Role Permissions
GET/v1/organizations/rbac_roles/{role_id}/permissions
List the permissions an RBAC Role grants.
The RBAC Roles API is available to Claude Enterprise organizations only.
##### Path parameters
role_id: string
ID of the RBAC Role.
##### Query parameters
limit: optional number
Number of items to return per page.
Defaults to `20`. Ranges from `1` to `1000`.
default20
maximum1000
minimum1
page: optional string
Optionally set to the `next_page` token from the previous response.
##### Returns
data: array of [BetaRBACRolePermission](https://platform.claude.com/docs/en/api/http/beta/organization/rbac_roles/permissions#beta_rbac_role_permission) { type: "rbac_role_permission", action, resource }
type: "rbac_role_permission"
Object type.
For RBAC Role Permissions, this is always `"rbac_role_permission"`.
defaultrbac_role_permission
action: string
Action the permission grants on the resource.
The vocabulary follows the resource: an `organization` grant carries a product-feature entitlement (for example `chat`), an admin-panel permission entitlement (`permission_*`), or a blanket capability-access mode — `capability_access_all` grants every product-feature entitlement, and `capability_access_all_ga` grants the generally-available subset as it stands at permission-check time; neither mode grants model-access entitlements. A consumer enumerating a role's per-feature grants should treat a blanket row as granting every product-feature entitlement it covers, or it will under-report the role's effective access. A `connector_tool` grant carries a tool-access action (`use` or `always_allow`); a `connector_scope` grant carries the scope action `grant` (the role may receive the named OAuth scope when tokens are minted for the connector); `connector` and `all_connectors` grants carry a tool-access action, the scope action, or an authentication-method action (`interactive` or `managed`).
resource: Organization or ConnectorTool or ConnectorScope or 2 more
What the permission applies to.
A tagged union: `type` names the kind of resource and determines which identifier fields are present.
One of the following:
Organization object{ type: "organization", organization_id }
type: "organization"
Kind of resource the permission applies to.
defaultorganization
organization_id: string
UUID of the organization the permission applies to.
ConnectorTool object{ type: "connector_tool", connector_id, tool_name }
type: "connector_tool"
Kind of resource the permission applies to.
defaultconnector_tool
connector_id: string
ID of the connector the permission applies to.
tool_name: string
Published name of the connector tool the permission applies to.
When the published name contains characters outside `[a-zA-Z0-9_-]` (or collides with a reserved form), it is server-encoded into a stable `{prefix}_{32-hex}` form — a shortened readable prefix of the name plus a hash — from which the published name is not recoverable.
ConnectorScope object{ type: "connector_scope", connector_id, scope }
type: "connector_scope"
Kind of resource the permission applies to.
defaultconnector_scope
connector_id: string
ID of the connector the permission applies to.
scope: string
OAuth scope the permission names — the role may receive this scope when tokens are minted for the connector.
Subject to the same encoding rule as `tool_name`: a scope containing characters outside `[a-zA-Z0-9_-]` (or colliding with a reserved form) appears server-encoded in a stable `{prefix}_{32-hex}` form. OAuth scopes routinely contain `:` and `/`, so most appear encoded.
Connector object{ type: "connector", connector_id }
type: "connector"
Kind of resource the permission applies to.
defaultconnector
connector_id: string
ID of the connector the permission applies to.
AllConnectors object{ type: "all_connectors" }
type: "all_connectors"
Kind of resource the permission applies to.
defaultall_connectors
has_more: boolean
Indicates whether there are more results beyond this page.
next_page: string or null
Opaque cursor for the next page. Pass as the `page` parameter on the next request.
List RBAC Role Permissions
cURL
```python
curl https://api.anthropic.com/v1/organizations/rbac_roles/$ROLE_ID/permissions \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"data": [
{
"action": "use",
"resource": {
"organization_id": "3c4f5e6d-7a8b-49c0-9d1e-2f3a4b5c6d7e",
"type": "organization"
},
"type": "rbac_role_permission"
}
],
"has_more": true,
"next_page": "eyJjdXJzb3IiOiAicmJhY19yb2xlXzAxIn0"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"action": "use",
"resource": {
"organization_id": "3c4f5e6d-7a8b-49c0-9d1e-2f3a4b5c6d7e",
"type": "organization"
},
"type": "rbac_role_permission"
}
],
"has_more": true,
"next_page": "eyJjdXJzb3IiOiAicmJhY19yb2xlXzAxIn0"
---
## Permissions - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/rbac_roles/permissions
Path: 04-API-Reference/Admin/admin-rbac-roles-permissions.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Frbac_roles%2Fpermissions)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
List RBAC Roles
Get RBAC Role
Permissions
List RBAC Role Permissions
Workspaces
API Keys
External Keys
Usage Report
Cost Report
Analytics
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [RBAC Roles](https://platform.claude.com/docs/en/api/http/admin/rbac_roles)
# Permissions
##### [List RBAC Role Permissions](https://platform.claude.com/docs/en/api/http/admin/rbac_roles/permissions/list)
GET/v1/organizations/rbac_roles/{role_id}/permissions
##### Models
RbacRolePermission object{ action, resource, type }
---
## Get RBAC Role - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/rbac_roles/retrieve
Path: 04-API-Reference/Admin/admin-rbac-roles-retrieve.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Frbac_roles%2Fretrieve)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
List RBAC Roles
Get RBAC Role
Permissions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [RBAC Roles](https://platform.claude.com/docs/en/api/http/beta/organization/rbac_roles)
# Get RBAC Role
GET/v1/organizations/rbac_roles/{role_id}
Retrieve an RBAC Role by ID.
The RBAC Roles API is available to Claude Enterprise organizations only.
##### Path parameters
role_id: string
ID of the RBAC Role.
##### Returns
BetaRBACRole object{ type: "rbac_role", id, created_at, 2 more }
type: "rbac_role"
Object type.
For RBAC Roles, this is always `"rbac_role"`.
defaultrbac_role
id: string
ID of the RBAC Role.
created_at: string
RFC 3339 datetime string indicating when the RBAC Role was created.
formatdate-time
name: string
Name of the RBAC Role.
updated_at: string
RFC 3339 datetime string indicating when the RBAC Role was last updated.
formatdate-time
Get RBAC Role
cURL
```python
curl https://api.anthropic.com/v1/organizations/rbac_roles/$ROLE_ID \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"id": "rbac_role_016J8xVtKpDq3Wy9ZmN2hR4s",
"created_at": "2024-10-30T23:58:27.427722Z",
"name": "Project Editor",
"type": "rbac_role",
"updated_at": "2024-10-30T23:58:27.427722Z"
}
```
##### Returns Examples
Response 200
```python
{
"id": "rbac_role_016J8xVtKpDq3Wy9ZmN2hR4s",
"created_at": "2024-10-30T23:58:27.427722Z",
"name": "Project Editor",
"type": "rbac_role",
"updated_at": "2024-10-30T23:58:27.427722Z"
---
## RBAC Roles - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/rbac_roles
Path: 04-API-Reference/Admin/admin-rbac-roles.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Frbac_roles)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
List RBAC Roles
Get RBAC Role
Permissions
Workspaces
API Keys
External Keys
Usage Report
Cost Report
Analytics
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
# RBAC Roles
##### [List RBAC Roles](https://platform.claude.com/docs/en/api/http/admin/rbac_roles/list)
GET/v1/organizations/rbac_roles
##### [Get RBAC Role](https://platform.claude.com/docs/en/api/http/admin/rbac_roles/retrieve)
GET/v1/organizations/rbac_roles/{role_id}
##### Models
RbacRole object{ id, created_at, name, 2 more }
id: string
ID of the RBAC Role.
created_at: string
RFC 3339 datetime string indicating when the RBAC Role was created.
formatdate-time
name: string
Name of the RBAC Role.
type: "rbac_role"
Object type.
For RBAC Roles, this is always `"rbac_role"`.
defaultrbac_role
updated_at: string
RFC 3339 datetime string indicating when the RBAC Role was last updated.
formatdate-time
#### RBAC Roles[Permissions](https://platform.claude.com/docs/en/api/http/admin/rbac_roles/permissions)
##### [List RBAC Role Permissions](https://platform.claude.com/docs/en/api/http/admin/rbac_roles/permissions/list)
GET/v1/organizations/rbac_roles/{role_id}/permissions
---
## Archive Service Account - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/service_accounts/archive
Path: 04-API-Reference/Admin/admin-service-accounts-archive.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Fservice_accounts%2Farchive)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
API Keys
External Keys
Usage Report
Cost Report
Analytics
Spend Limits
Rate Limits
Service Accounts
Create Service Account
Get Service Account
List Service Accounts
Update Service Account
Archive Service Account
Workspaces
Federation Issuers
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [Service Accounts](https://platform.claude.com/docs/en/api/http/admin/service_accounts)
# Archive Service Account
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](../Other/manage-claude-wif-admin-api.md).
Archive a service account.
Idempotent; re-archiving returns the service account with its original `archived_at`. Rejected with 400 if any live (non-archived) federation rule still targets this service account, same as issuer archival; archive those rules first or change their target to another service account.
##### Path parameters
service_account_id: string
ID of the service account to archive.
##### Headers
"anthropic-beta": optional array of string
Optional header to specify the beta version(s) you want to use.
To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta.
##### Returns
ServiceAccount object{ id, archived_at, archived_by_actor_id, 8 more }
Named non-human identity within the caller's organization.
A service account is a pure identity: name + org. Authorization lives on whatever references it (federation rules).
Archive Service Account
cURL
```python
curl https://api.anthropic.com/v1/organizations/service_accounts/$SERVICE_ACCOUNT_ID/archive \
-X POST \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
```
Response 200
```python
{
"id": "svac_01SDCCSbTxrXDpWc1phhtcfK",
"archived_at": "2019-12-27T18:11:19.117Z",
"archived_by_actor_id": "archived_by_actor_id",
"created_at": "2024-10-30T23:58:27.427722Z",
"created_by_actor_id": "created_by_actor_id",
"description": "description",
"name": "ci-deploy-bot",
"organization_role": "admin",
"type": "service_account",
"updated_at": "2024-10-30T23:58:27.427722Z",
"updated_by_actor_id": "updated_by_actor_id"
}
```
##### Returns Examples
Response 200
```python
{
"id": "svac_01SDCCSbTxrXDpWc1phhtcfK",
"archived_at": "2019-12-27T18:11:19.117Z",
"archived_by_actor_id": "archived_by_actor_id",
"created_at": "2024-10-30T23:58:27.427722Z",
"created_by_actor_id": "created_by_actor_id",
"description": "description",
"name": "ci-deploy-bot",
"organization_role": "admin",
"type": "service_account",
"updated_at": "2024-10-30T23:58:27.427722Z",
"updated_by_actor_id": "updated_by_actor_id"
---
## Create Service Account - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/service_accounts/create
Path: 04-API-Reference/Admin/admin-service-accounts-create.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Fservice_accounts%2Fcreate)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
API Keys
External Keys
Usage Report
Cost Report
Analytics
Spend Limits
Rate Limits
Service Accounts
Create Service Account
Get Service Account
List Service Accounts
Update Service Account
Archive Service Account
Workspaces
Federation Issuers
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [Service Accounts](https://platform.claude.com/docs/en/api/http/admin/service_accounts)
# Create Service Account
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](../Other/manage-claude-wif-admin-api.md).
Create a service account.
A service account is a named workload identity that federation rules target. `organization_role` is `developer` (default) or `admin`; a rule may only be created or retargeted to grant `org:admin` scope when the target's `organization_role` is `admin`. Creating an `admin`-role service account requires an interactive credential (a user OAuth token or a Console session) — a workload may only create `developer`-role service accounts.
##### Headers
"anthropic-beta": optional array of string
Optional header to specify the beta version(s) you want to use.
To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta.
##### Body
name: string
Slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409.
maxLength255
minLength1
description: optional string or null
Optional free-text description.
maxLength2000
organization_role: optional "admin" or "developer"
Org-level role. Defaults to `developer`.
One of the following:
"admin"
"developer"
##### Returns
ServiceAccount object{ id, archived_at, archived_by_actor_id, 8 more }
Named non-human identity within the caller's organization.
A service account is a pure identity: name + org. Authorization lives on whatever references it (federation rules).
Create Service Account
cURL
```python
curl https://api.anthropic.com/v1/organizations/service_accounts \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN" \
-d '{
"name": "ci-deploy-bot"
}'
```
Response 200
```python
{
"id": "svac_01SDCCSbTxrXDpWc1phhtcfK",
"archived_at": "2019-12-27T18:11:19.117Z",
"archived_by_actor_id": "archived_by_actor_id",
"created_at": "2024-10-30T23:58:27.427722Z",
"created_by_actor_id": "created_by_actor_id",
"description": "description",
"name": "ci-deploy-bot",
"organization_role": "admin",
"type": "service_account",
"updated_at": "2024-10-30T23:58:27.427722Z",
"updated_by_actor_id": "updated_by_actor_id"
}
```
##### Returns Examples
Response 200
```python
{
"id": "svac_01SDCCSbTxrXDpWc1phhtcfK",
"archived_at": "2019-12-27T18:11:19.117Z",
"archived_by_actor_id": "archived_by_actor_id",
"created_at": "2024-10-30T23:58:27.427722Z",
"created_by_actor_id": "created_by_actor_id",
"description": "description",
"name": "ci-deploy-bot",
"organization_role": "admin",
"type": "service_account",
"updated_at": "2024-10-30T23:58:27.427722Z",
"updated_by_actor_id": "updated_by_actor_id"
---
## List Service Accounts - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/service_accounts/list
Path: 04-API-Reference/Admin/admin-service-accounts-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Fservice_accounts%2Flist)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
API Keys
External Keys
Usage Report
Cost Report
Analytics
Spend Limits
Rate Limits
Service Accounts
Create Service Account
Get Service Account
List Service Accounts
Update Service Account
Archive Service Account
Workspaces
Federation Issuers
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [Service Accounts](https://platform.claude.com/docs/en/api/http/admin/service_accounts)
# List Service Accounts
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](../Other/manage-claude-wif-admin-api.md).
List service accounts in the caller's organization.
Results are ordered by creation time, newest first. Use `limit` and the `next_page` cursor to paginate; set `include_archived=true` to include archived service accounts.
##### Query parameters
include_archived: optional boolean
Include archived resources. Defaults to false.
defaultfalse
limit: optional number
Number of results per page.
default20
maximum100
minimum1
page: optional string
Opaque cursor from a previous response's `next_page`.
##### Headers
"anthropic-beta": optional array of string
Optional header to specify the beta version(s) you want to use.
To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta.
##### Returns
data: array of [ServiceAccount](https://platform.claude.com/docs/en/api/http/admin/service_accounts#service_account) { id, archived_at, archived_by_actor_id, 8 more }
id: string
Tagged ID of the service account.
archived_at: string or null
If set, this service account is archived.
formatdate-time
archived_by_actor_id: string or null
Tagged ID (`user_`/`svac_`) of the actor that archived this service account.
created_at: string
When this service account was created.
formatdate-time
created_by_actor_id: string or null
Tagged ID (`user_`/`svac_`) of the actor that created this service account.
description: string or null
Optional free-text description.
name: string
Admin-chosen slug identifier.
organization_role: "admin" or "developer"
Org-level role. A federation rule may only be created or retargeted to grant `org:admin` scope when this is `admin`. A rule granting `org:admin` whose target is later demoted to `developer` is rejected at token exchange. Rules granting `org:admin` are managed in the Console.
One of the following:
"admin"
"developer"
type: "service_account"
defaultservice_account
updated_at: string
When this service account was last updated.
formatdate-time
updated_by_actor_id: string or null
Tagged ID (`user_`/`svac_`) of the actor that last updated this service account.
next_page: string or null
Opaque cursor for the next page, or null if no more results.
List Service Accounts
cURL
```python
curl https://api.anthropic.com/v1/organizations/service_accounts \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
```
Response 200
```python
{
"data": [
{
"id": "svac_01SDCCSbTxrXDpWc1phhtcfK",
"archived_at": "2019-12-27T18:11:19.117Z",
"archived_by_actor_id": "archived_by_actor_id",
"created_at": "2024-10-30T23:58:27.427722Z",
"created_by_actor_id": "created_by_actor_id",
"description": "description",
"name": "ci-deploy-bot",
"organization_role": "admin",
"type": "service_account",
"updated_at": "2024-10-30T23:58:27.427722Z",
"updated_by_actor_id": "updated_by_actor_id"
}
],
"next_page": "next_page"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"id": "svac_01SDCCSbTxrXDpWc1phhtcfK",
"archived_at": "2019-12-27T18:11:19.117Z",
"archived_by_actor_id": "archived_by_actor_id",
"created_at": "2024-10-30T23:58:27.427722Z",
"created_by_actor_id": "created_by_actor_id",
"description": "description",
"name": "ci-deploy-bot",
"organization_role": "admin",
"type": "service_account",
"updated_at": "2024-10-30T23:58:27.427722Z",
"updated_by_actor_id": "updated_by_actor_id"
---
## Get Service Account - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/service_accounts/retrieve
Path: 04-API-Reference/Admin/admin-service-accounts-retrieve.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Fservice_accounts%2Fretrieve)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
API Keys
External Keys
Usage Report
Cost Report
Analytics
Spend Limits
Rate Limits
Service Accounts
Create Service Account
Get Service Account
List Service Accounts
Update Service Account
Archive Service Account
Workspaces
Federation Issuers
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [Service Accounts](https://platform.claude.com/docs/en/api/http/admin/service_accounts)
# Get Service Account
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](../Other/manage-claude-wif-admin-api.md).
Retrieve a service account by its ID (`svac_...`).
##### Path parameters
service_account_id: string
ID of the service account.
##### Headers
"anthropic-beta": optional array of string
Optional header to specify the beta version(s) you want to use.
To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta.
##### Returns
ServiceAccount object{ id, archived_at, archived_by_actor_id, 8 more }
Named non-human identity within the caller's organization.
A service account is a pure identity: name + org. Authorization lives on whatever references it (federation rules).
Get Service Account
cURL
```python
curl https://api.anthropic.com/v1/organizations/service_accounts/$SERVICE_ACCOUNT_ID \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
```
Response 200
```python
{
"id": "svac_01SDCCSbTxrXDpWc1phhtcfK",
"archived_at": "2019-12-27T18:11:19.117Z",
"archived_by_actor_id": "archived_by_actor_id",
"created_at": "2024-10-30T23:58:27.427722Z",
"created_by_actor_id": "created_by_actor_id",
"description": "description",
"name": "ci-deploy-bot",
"organization_role": "admin",
"type": "service_account",
"updated_at": "2024-10-30T23:58:27.427722Z",
"updated_by_actor_id": "updated_by_actor_id"
}
```
##### Returns Examples
Response 200
```python
{
"id": "svac_01SDCCSbTxrXDpWc1phhtcfK",
"archived_at": "2019-12-27T18:11:19.117Z",
"archived_by_actor_id": "archived_by_actor_id",
"created_at": "2024-10-30T23:58:27.427722Z",
"created_by_actor_id": "created_by_actor_id",
"description": "description",
"name": "ci-deploy-bot",
"organization_role": "admin",
"type": "service_account",
"updated_at": "2024-10-30T23:58:27.427722Z",
"updated_by_actor_id": "updated_by_actor_id"
---
## Update Service Account - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/service_accounts/update
Path: 04-API-Reference/Admin/admin-service-accounts-update.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Fservice_accounts%2Fupdate)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
API Keys
External Keys
Usage Report
Cost Report
Analytics
Spend Limits
Rate Limits
Service Accounts
Create Service Account
Get Service Account
List Service Accounts
Update Service Account
Archive Service Account
Workspaces
Federation Issuers
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [Service Accounts](https://platform.claude.com/docs/en/api/http/admin/service_accounts)
# Update Service Account
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](../Other/manage-claude-wif-admin-api.md).
Update a service account.
Only `description` and `organization_role` are mutable; `name` cannot be changed. Archived service accounts cannot be updated; this returns 400. Setting `organization_role` to `admin` (even when unchanged) requires an interactive credential (a user OAuth token or a Console session).
##### Path parameters
service_account_id: string
ID of the service account to update.
##### Headers
"anthropic-beta": optional array of string
Optional header to specify the beta version(s) you want to use.
To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta.
##### Body
description: optional string or null
Replaces the description. Omit to leave unchanged; send `null` to clear (the field is stored as an empty string).
maxLength2000
organization_role: optional "admin" or "developer" or null
Replaces the org-level role. Omit or send `null` to leave unchanged.
One of the following:
"admin"
"developer"
##### Returns
ServiceAccount object{ id, archived_at, archived_by_actor_id, 8 more }
Named non-human identity within the caller's organization.
A service account is a pure identity: name + org. Authorization lives on whatever references it (federation rules).
Update Service Account
cURL
```python
curl https://api.anthropic.com/v1/organizations/service_accounts/$SERVICE_ACCOUNT_ID \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN" \
-d '{}'
```
Response 200
```python
{
"id": "svac_01SDCCSbTxrXDpWc1phhtcfK",
"archived_at": "2019-12-27T18:11:19.117Z",
"archived_by_actor_id": "archived_by_actor_id",
"created_at": "2024-10-30T23:58:27.427722Z",
"created_by_actor_id": "created_by_actor_id",
"description": "description",
"name": "ci-deploy-bot",
"organization_role": "admin",
"type": "service_account",
"updated_at": "2024-10-30T23:58:27.427722Z",
"updated_by_actor_id": "updated_by_actor_id"
}
```
##### Returns Examples
Response 200
```python
{
"id": "svac_01SDCCSbTxrXDpWc1phhtcfK",
"archived_at": "2019-12-27T18:11:19.117Z",
"archived_by_actor_id": "archived_by_actor_id",
"created_at": "2024-10-30T23:58:27.427722Z",
"created_by_actor_id": "created_by_actor_id",
"description": "description",
"name": "ci-deploy-bot",
"organization_role": "admin",
"type": "service_account",
"updated_at": "2024-10-30T23:58:27.427722Z",
"updated_by_actor_id": "updated_by_actor_id"
---
## Add Workspace To Service Account - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/service_accounts/workspaces/create
Path: 04-API-Reference/Admin/admin-service-accounts-workspaces-create.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Fservice_accounts%2Fworkspaces%2Fcreate)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
API Keys
External Keys
Usage Report
Cost Report
Analytics
Spend Limits
Rate Limits
Service Accounts
Create Service Account
Get Service Account
List Service Accounts
Update Service Account
Archive Service Account
Workspaces
Add Workspace To Service Account
List Workspaces For Service Account
Remove Workspace From Service Account
Federation Issuers
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [Service Accounts](https://platform.claude.com/docs/en/api/http/admin/service_accounts)
4. [Workspaces](https://platform.claude.com/docs/en/api/http/admin/service_accounts/workspaces)
# Add Workspace To Service Account
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](../Other/manage-claude-wif-admin-api.md).
Add a service account to a workspace with the given `workspace_role`.
Mirror of `POST /workspaces/{workspace_id}/service_accounts`, addressed from the service-account side; both create the same membership. If the service account is already an explicit member of the workspace, its `workspace_role` is replaced with the value supplied here. Archived workspaces return 400. Archived service accounts cannot be added and are rejected.
##### Path parameters
service_account_id: string
ID of the service account.
##### Headers
"anthropic-beta": optional array of string
Optional header to specify the beta version(s) you want to use.
To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta.
##### Body
workspace_id: string
Tagged workspace ID to add the service account to.
workspace_role: "workspace_admin" or "workspace_developer" or "workspace_restricted_developer" or "workspace_user"
Role to assign to the service account in this workspace.
One of the following:
"workspace_admin"
"workspace_developer"
"workspace_restricted_developer"
"workspace_user"
##### Returns
created_by_actor_id: string or null
Tagged ID (`user_...`/`svac_...`) of the actor who created this membership.
implicit: boolean or null
True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed.
service_account_id: string
Tagged service account ID (`svac_...`).
type: "service_account_workspace_member"
defaultservice_account_workspace_member
workspace_id: string
Tagged workspace ID (`wrkspc_...`).
workspace_role: "workspace_admin" or "workspace_billing" or "workspace_developer" or 2 more
Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role.
One of the following:
"workspace_admin"
"workspace_billing"
"workspace_developer"
"workspace_restricted_developer"
"workspace_user"
Add Workspace To Service Account
cURL
```python
curl https://api.anthropic.com/v1/organizations/service_accounts/$SERVICE_ACCOUNT_ID/workspaces \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN" \
-d '{
"workspace_id": "workspace_id",
"workspace_role": "workspace_admin"
}'
```
Response 200
```python
{
"created_by_actor_id": "created_by_actor_id",
"implicit": true,
"service_account_id": "service_account_id",
"type": "service_account_workspace_member",
"workspace_id": "workspace_id",
"workspace_role": "workspace_admin"
}
```
##### Returns Examples
Response 200
```python
{
"created_by_actor_id": "created_by_actor_id",
"implicit": true,
"service_account_id": "service_account_id",
"type": "service_account_workspace_member",
"workspace_id": "workspace_id",
"workspace_role": "workspace_admin"
---
## Remove Workspace From Service Account - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/service_accounts/workspaces/delete
Path: 04-API-Reference/Admin/admin-service-accounts-workspaces-delete.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Fservice_accounts%2Fworkspaces%2Fdelete)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
API Keys
External Keys
Usage Report
Cost Report
Analytics
Spend Limits
Rate Limits
Service Accounts
Create Service Account
Get Service Account
List Service Accounts
Update Service Account
Archive Service Account
Workspaces
Add Workspace To Service Account
List Workspaces For Service Account
Remove Workspace From Service Account
Federation Issuers
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [Service Accounts](https://platform.claude.com/docs/en/api/http/admin/service_accounts)
4. [Workspaces](https://platform.claude.com/docs/en/api/http/admin/service_accounts/workspaces)
# Remove Workspace From Service Account
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](../Other/manage-claude-wif-admin-api.md).
Remove a service account from a workspace.
Mirror of `DELETE /workspaces/{workspace_id}/service_accounts/{service_account_id}`, addressed from the service-account side. Removal is idempotent (returns 200 even if the membership was already removed). A DELETE against the implicit default-workspace membership returns 200 but is a no-op and the membership persists; deleting an explicit default-workspace row reverts to the implicit `workspace_user` membership. Archived workspaces return 400.
##### Path parameters
service_account_id: string
ID of the service account.
workspace_id: string
ID of the workspace.
##### Headers
"anthropic-beta": optional array of string
Optional header to specify the beta version(s) you want to use.
To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta.
##### Returns
service_account_id: string
Tagged service account ID (`svac_...`) named in the delete request. Removal is idempotent; see the endpoint description for the implicit-membership no-op.
type: "service_account_workspace_member_deleted"
defaultservice_account_workspace_member_deleted
workspace_id: string
Tagged workspace ID (`wrkspc_...`) named in the delete request.
Remove Workspace From Service Account
cURL
```python
curl https://api.anthropic.com/v1/organizations/service_accounts/$SERVICE_ACCOUNT_ID/workspaces/$WORKSPACE_ID \
-X DELETE \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
```
Response 200
```python
{
"service_account_id": "service_account_id",
"type": "service_account_workspace_member_deleted",
"workspace_id": "workspace_id"
}
```
##### Returns Examples
Response 200
```python
{
"service_account_id": "service_account_id",
"type": "service_account_workspace_member_deleted",
"workspace_id": "workspace_id"
---
## List Workspaces For Service Account - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/service_accounts/workspaces/list
Path: 04-API-Reference/Admin/admin-service-accounts-workspaces-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Fservice_accounts%2Fworkspaces%2Flist)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
API Keys
External Keys
Usage Report
Cost Report
Analytics
Spend Limits
Rate Limits
Service Accounts
Create Service Account
Get Service Account
List Service Accounts
Update Service Account
Archive Service Account
Workspaces
Add Workspace To Service Account
List Workspaces For Service Account
Remove Workspace From Service Account
Federation Issuers
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [Service Accounts](https://platform.claude.com/docs/en/api/http/admin/service_accounts)
4. [Workspaces](https://platform.claude.com/docs/en/api/http/admin/service_accounts/workspaces)
# List Workspaces For Service Account
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](../Other/manage-claude-wif-admin-api.md).
List the workspaces a service account is a member of.
Each entry includes the service account's `workspace_role` in that workspace. Use `limit` and the `next_page` cursor to paginate. When the service account has no explicit default-workspace membership, the implicit (`implicit: true`) membership is returned as the first entry on the first page; with `limit=1` the first page may return up to 2 entries (the implicit entry plus one explicit membership) so a pagination cursor can be derived. Memberships are returned only while the service account is active. Without a `page` cursor, an archived service account returns an empty list. A `page` cursor that does not match an active membership returns a 400 invalid-request error. A cursor stops matching when the membership is removed, the workspace is deleted, or the service account is archived. Restart pagination from the first page to recover.
##### Path parameters
service_account_id: string
ID of the service account.
##### Query parameters
limit: optional number
Number of results per page.
default20
maximum100
minimum1
page: optional string
Opaque cursor from a previous response's `next_page`.
##### Headers
"anthropic-beta": optional array of string
Optional header to specify the beta version(s) you want to use.
To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta.
##### Returns
data: array of object{ created_by_actor_id, implicit, service_account_id, 3 more }
created_by_actor_id: string or null
Tagged ID (`user_...`/`svac_...`) of the actor who created this membership.
implicit: boolean or null
True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed.
service_account_id: string
Tagged service account ID (`svac_...`).
type: "service_account_workspace_member"
defaultservice_account_workspace_member
workspace_id: string
Tagged workspace ID (`wrkspc_...`).
workspace_role: "workspace_admin" or "workspace_billing" or "workspace_developer" or 2 more
Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role.
One of the following:
"workspace_admin"
"workspace_billing"
"workspace_developer"
"workspace_restricted_developer"
"workspace_user"
next_page: string or null
Opaque cursor for the next page, or null if no more results.
List Workspaces For Service Account
cURL
```python
curl https://api.anthropic.com/v1/organizations/service_accounts/$SERVICE_ACCOUNT_ID/workspaces \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
```
Response 200
```python
{
"data": [
{
"created_by_actor_id": "created_by_actor_id",
"implicit": true,
"service_account_id": "service_account_id",
"type": "service_account_workspace_member",
"workspace_id": "workspace_id",
"workspace_role": "workspace_admin"
}
],
"next_page": "next_page"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"created_by_actor_id": "created_by_actor_id",
"implicit": true,
"service_account_id": "service_account_id",
"type": "service_account_workspace_member",
"workspace_id": "workspace_id",
"workspace_role": "workspace_admin"
---
## Workspaces - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/service_accounts/workspaces
Path: 04-API-Reference/Admin/admin-service-accounts-workspaces.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Fservice_accounts%2Fworkspaces)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
API Keys
External Keys
Usage Report
Cost Report
Analytics
Spend Limits
Rate Limits
Service Accounts
Create Service Account
Get Service Account
List Service Accounts
Update Service Account
Archive Service Account
Workspaces
Add Workspace To Service Account
List Workspaces For Service Account
Remove Workspace From Service Account
Federation Issuers
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [Service Accounts](https://platform.claude.com/docs/en/api/http/admin/service_accounts)
# Workspaces
##### [Add Workspace To Service Account](https://platform.claude.com/docs/en/api/http/admin/service_accounts/workspaces/create)
POST/v1/organizations/service_accounts/{service_account_id}/workspaces
##### [List Workspaces For Service Account](https://platform.claude.com/docs/en/api/http/admin/service_accounts/workspaces/list)
GET/v1/organizations/service_accounts/{service_account_id}/workspaces
##### [Remove Workspace From Service Account](https://platform.claude.com/docs/en/api/http/admin/service_accounts/workspaces/delete)
DELETE/v1/organizations/service_accounts/{service_account_id}/workspaces/{workspace_id}
##### Models
WorkspaceCreateResponse object{ created_by_actor_id, implicit, service_account_id, 3 more }
created_by_actor_id: string or null
Tagged ID (`user_...`/`svac_...`) of the actor who created this membership.
implicit: boolean or null
True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed.
service_account_id: string
Tagged service account ID (`svac_...`).
type: "service_account_workspace_member"
defaultservice_account_workspace_member
workspace_id: string
Tagged workspace ID (`wrkspc_...`).
workspace_role: "workspace_admin" or "workspace_billing" or "workspace_developer" or 2 more
Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role.
One of the following:
"workspace_admin"
"workspace_billing"
"workspace_developer"
"workspace_restricted_developer"
"workspace_user"
WorkspaceListResponse object{ created_by_actor_id, implicit, service_account_id, 3 more }
created_by_actor_id: string or null
Tagged ID (`user_...`/`svac_...`) of the actor who created this membership.
implicit: boolean or null
True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed.
service_account_id: string
Tagged service account ID (`svac_...`).
type: "service_account_workspace_member"
defaultservice_account_workspace_member
workspace_id: string
Tagged workspace ID (`wrkspc_...`).
workspace_role: "workspace_admin" or "workspace_billing" or "workspace_developer" or 2 more
Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role.
One of the following:
"workspace_admin"
"workspace_billing"
"workspace_developer"
"workspace_restricted_developer"
"workspace_user"
WorkspaceDeleteResponse object{ service_account_id, type, workspace_id }
service_account_id: string
Tagged service account ID (`svac_...`) named in the delete request. Removal is idempotent; see the endpoint description for the implicit-membership no-op.
type: "service_account_workspace_member_deleted"
defaultservice_account_workspace_member_deleted
workspace_id: string
Tagged workspace ID (`wrkspc_...`) named in the delete request.
---
## Service Accounts - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/service_accounts
Path: 04-API-Reference/Admin/admin-service-accounts.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Fservice_accounts)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
API Keys
External Keys
Usage Report
Cost Report
Analytics
Spend Limits
Rate Limits
Service Accounts
Create Service Account
Get Service Account
List Service Accounts
Update Service Account
Archive Service Account
Workspaces
Federation Issuers
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
# Service Accounts
##### [Create Service Account](https://platform.claude.com/docs/en/api/http/admin/service_accounts/create)
POST/v1/organizations/service_accounts
##### [Get Service Account](https://platform.claude.com/docs/en/api/http/admin/service_accounts/retrieve)
GET/v1/organizations/service_accounts/{service_account_id}
##### [List Service Accounts](https://platform.claude.com/docs/en/api/http/admin/service_accounts/list)
GET/v1/organizations/service_accounts
##### [Update Service Account](https://platform.claude.com/docs/en/api/http/admin/service_accounts/update)
POST/v1/organizations/service_accounts/{service_account_id}
##### [Archive Service Account](https://platform.claude.com/docs/en/api/http/admin/service_accounts/archive)
POST/v1/organizations/service_accounts/{service_account_id}/archive
##### Models
ServiceAccount object{ id, archived_at, archived_by_actor_id, 8 more }
Named non-human identity within the caller's organization.
A service account is a pure identity: name + org. Authorization lives on whatever references it (federation rules).
#### Service Accounts[Workspaces](https://platform.claude.com/docs/en/api/http/admin/service_accounts/workspaces)
##### [Add Workspace To Service Account](https://platform.claude.com/docs/en/api/http/admin/service_accounts/workspaces/create)
POST/v1/organizations/service_accounts/{service_account_id}/workspaces
##### [List Workspaces For Service Account](https://platform.claude.com/docs/en/api/http/admin/service_accounts/workspaces/list)
GET/v1/organizations/service_accounts/{service_account_id}/workspaces
##### [Remove Workspace From Service Account](https://platform.claude.com/docs/en/api/http/admin/service_accounts/workspaces/delete)
DELETE/v1/organizations/service_accounts/{service_account_id}/workspaces/{workspace_id}
---
## Set Spend Limit - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/spend_limits/create
Path: 04-API-Reference/Admin/admin-spend-limits-create.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Fspend_limits%2Fcreate)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
API Keys
External Keys
Usage Report
Cost Report
Analytics
Spend Limits
Set Spend Limit
Get Spend Limit
Delete Spend Limit
List Effective Spend Limits
Increase Requests
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [Spend Limits](https://platform.claude.com/docs/en/api/http/admin/spend_limits)
# Set Spend Limit
POST/v1/organizations/spend_limits
Set a per-user spend limit override.
Upsert keyed on (scope, period): setting a limit that already exists overwrites it in place. Only `scope.type: "user"` is accepted; seat-tier, group, and organization-level defaults are configured in claude.ai.
##### Body
amount: string or null
Limit amount as a non-negative integer decimal string in the minor unit of the organization's billing currency (cents for USD): "50000" is \$500.00. `null` sets an explicit no-limit override for this scope and `period` only — each period resolves independently, so caps for other periods still apply.
scope: object{ type, user_id }
Scope selecting a single member of the organization.
type: "user"
Scope type. Always `user` for this scope.
defaultuser
user_id: string
Tagged ID of the member the spend limit applies to.
period: optional "daily" or "monthly" or "weekly"
One of the following:
"daily"
"monthly"
"weekly"
##### Returns
SpendLimit object{ id, amount, created_at, 5 more }
A configured spend limit: a cap on metered spend for one scope and period.
Set Spend Limit
cURL
```python
curl https://api.anthropic.com/v1/organizations/spend_limits \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN" \
-d '{
"amount": "50000",
"scope": {
"type": "user",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"period": "monthly"
}'
```
Response 200
```python
{
"id": "id",
"amount": "50000",
"created_at": "2019-12-27T18:11:19.117Z",
"currency": "USD",
"period": "monthly",
"scope": {
"type": "user",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"type": "spend_limit",
"updated_at": "2019-12-27T18:11:19.117Z"
}
```
##### Returns Examples
Response 200
```python
{
"id": "id",
"amount": "50000",
"created_at": "2019-12-27T18:11:19.117Z",
"currency": "USD",
"period": "monthly",
"scope": {
"type": "user",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"type": "spend_limit",
"updated_at": "2019-12-27T18:11:19.117Z"
---
## Delete Spend Limit - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/spend_limits/delete
Path: 04-API-Reference/Admin/admin-spend-limits-delete.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Fspend_limits%2Fdelete)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
API Keys
External Keys
Usage Report
Cost Report
Analytics
Spend Limits
Set Spend Limit
Get Spend Limit
Delete Spend Limit
List Effective Spend Limits
Increase Requests
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [Spend Limits](https://platform.claude.com/docs/en/api/http/admin/spend_limits)
# Delete Spend Limit
DELETE/v1/organizations/spend_limits/{spend_limit_id}
Delete a per-user spend limit override.
The member falls back to any inherited spend limit at that period. Seat-tier, group, and organization-level rows cannot be deleted via this endpoint.
##### Path parameters
spend_limit_id: string
ID of the Spend Limit.
##### Returns
id: string
type: "spend_limit_deleted"
defaultspend_limit_deleted
Delete Spend Limit
cURL
```python
curl https://api.anthropic.com/v1/organizations/spend_limits/$SPEND_LIMIT_ID \
-X DELETE \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
---
## Approve Spend Limit Increase Request - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/spend_limits/increase_requests/approve
Path: 04-API-Reference/Admin/admin-spend-limits-increase-requests-approve.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Fspend_limits%2Fincrease_requests%2Fapprove)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
API Keys
External Keys
Usage Report
Cost Report
Analytics
Spend Limits
Set Spend Limit
Get Spend Limit
Delete Spend Limit
List Effective Spend Limits
Increase Requests
List Spend Limit Increase Requests
Get Spend Limit Increase Request
Approve Spend Limit Increase Request
Deny Spend Limit Increase Request
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [Spend Limits](https://platform.claude.com/docs/en/api/http/admin/spend_limits)
4. [Increase Requests](https://platform.claude.com/docs/en/api/http/admin/spend_limits/increase_requests)
# Approve Spend Limit Increase Request
POST/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}/approve
Approve a pending spend limit increase request.
Writes a per-user spend limit at `amount` for the requester and transitions the request to `approved`. `period` defaults to the period the member was blocked on. Anthropic emails the requester unless `suppress_notification` is set.
##### Path parameters
spend_limit_increase_request_id: string
ID of the spend limit increase request.
##### Body
amount: string
New per-user spend limit as a non-negative integer decimal string (minor units).
period: optional "daily" or "monthly" or "weekly" or null
One of the following:
"daily"
"monthly"
"weekly"
suppress_notification: optional boolean
##### Returns
id: string
actor: object{ deleted, email_address, name, 2 more }
A user within the organization. `name` and `email_address` are null when the underlying account is unavailable or has been deleted; `deleted` is true only for deleted accounts.
deleted: boolean
True only when the underlying account has been deleted.
defaultfalse
email_address: string or null
The user's email address. Null when the account is unavailable or has been deleted.
name: string or null
The user's current display name. Null when the account is unavailable, has been deleted, or has no name set.
type: "user_actor"
Actor type. Always `user_actor`.
defaultuser_actor
user_id: string
Tagged ID of the user.
created_at: string
formatdate-time
period: "daily" or "monthly" or "weekly"
One of the following:
"daily"
"monthly"
"weekly"
resolved_at: string or null
formatdate-time
resolved_by: object{ deleted, email_address, name, 2 more } or object{ scoped_api_key_id, type } or null
A user within the organization. `name` and `email_address` are null when the underlying account is unavailable or has been deleted; `deleted` is true only for deleted accounts.
One of the following:
UserActor object{ deleted, email_address, name, 2 more }
A user within the organization. `name` and `email_address` are null when the underlying account is unavailable or has been deleted; `deleted` is true only for deleted accounts.
deleted: boolean
True only when the underlying account has been deleted.
defaultfalse
email_address: string or null
The user's email address. Null when the account is unavailable or has been deleted.
name: string or null
The user's current display name. Null when the account is unavailable, has been deleted, or has no name set.
type: "user_actor"
Actor type. Always `user_actor`.
defaultuser_actor
user_id: string
Tagged ID of the user.
ScopedAPIKeyActor object{ scoped_api_key_id, type }
A scoped Admin API key acting on behalf of the organization.
scoped_api_key_id: string
type: "scoped_api_key_actor"
defaultscoped_api_key_actor
spend_limit: [SpendLimit](https://platform.claude.com/docs/en/api/http/admin/spend_limits#spend_limit) { id, amount, created_at, 5 more }
A configured spend limit: a cap on metered spend for one scope and period.
spend_summary: [SpendSummary](https://platform.claude.com/docs/en/api/http/admin/spend_limits#spend_summary) { actor, amount, currency, 5 more } or null
Per-member effective-limit report row (`GET /spend_limits/effective`).
status: "approved" or "denied" or "pending"
One of the following:
"approved"
"denied"
"pending"
type: "spend_limit_increase_request"
defaultspend_limit_increase_request
Approve Spend Limit Increase Request
cURL
```python
curl https://api.anthropic.com/v1/organizations/spend_limit_increase_requests/$SPEND_LIMIT_INCREASE_REQUEST_ID/approve \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN" \
-d '{
"amount": "50000",
"period": "monthly"
}'
```
Response 200
```python
{
"id": "id",
"actor": {
"deleted": true,
"email_address": "email_address",
"name": "name",
"type": "user_actor",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"created_at": "2019-12-27T18:11:19.117Z",
"period": "monthly",
"resolved_at": "2019-12-27T18:11:19.117Z",
"resolved_by": {
"deleted": true,
"email_address": "email_address",
"name": "name",
"type": "user_actor",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"spend_limit": {
"id": "id",
"amount": "50000",
"created_at": "2019-12-27T18:11:19.117Z",
"currency": "USD",
"period": "monthly",
"scope": {
"type": "user",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"type": "spend_limit",
"updated_at": "2019-12-27T18:11:19.117Z"
},
"spend_summary": {
"actor": {
"deleted": true,
"email_address": "email_address",
"name": "name",
"type": "user_actor",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"amount": "50000",
"currency": "USD",
"period": "monthly",
"period_to_date_spend": "12050.5",
"scope": {
"type": "user",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"source": {
"type": "user",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"spend_limit_id": "spend_limit_id"
},
"status": "approved",
"type": "spend_limit_increase_request"
}
```
##### Returns Examples
Response 200
```python
{
"id": "id",
"actor": {
"deleted": true,
"email_address": "email_address",
"name": "name",
"type": "user_actor",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"created_at": "2019-12-27T18:11:19.117Z",
"period": "monthly",
"resolved_at": "2019-12-27T18:11:19.117Z",
"resolved_by": {
"deleted": true,
"email_address": "email_address",
"name": "name",
"type": "user_actor",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"spend_limit": {
"id": "id",
"amount": "50000",
"created_at": "2019-12-27T18:11:19.117Z",
"currency": "USD",
"period": "monthly",
"scope": {
"type": "user",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"type": "spend_limit",
"updated_at": "2019-12-27T18:11:19.117Z"
},
"spend_summary": {
"actor": {
"deleted": true,
"email_address": "email_address",
"name": "name",
"type": "user_actor",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"amount": "50000",
"currency": "USD",
"period": "monthly",
"period_to_date_spend": "12050.5",
"scope": {
"type": "user",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"source": {
"type": "user",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"spend_limit_id": "spend_limit_id"
},
"status": "approved",
"type": "spend_limit_increase_request"
---
## Deny Spend Limit Increase Request - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/spend_limits/increase_requests/deny
Path: 04-API-Reference/Admin/admin-spend-limits-increase-requests-deny.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Fspend_limits%2Fincrease_requests%2Fdeny)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
API Keys
External Keys
Usage Report
Cost Report
Analytics
Spend Limits
Set Spend Limit
Get Spend Limit
Delete Spend Limit
List Effective Spend Limits
Increase Requests
List Spend Limit Increase Requests
Get Spend Limit Increase Request
Approve Spend Limit Increase Request
Deny Spend Limit Increase Request
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [Spend Limits](https://platform.claude.com/docs/en/api/http/admin/spend_limits)
4. [Increase Requests](https://platform.claude.com/docs/en/api/http/admin/spend_limits/increase_requests)
# Deny Spend Limit Increase Request
POST/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}/deny
Deny a pending spend limit increase request.
Idempotent on `denied`; denying an already-`approved` request returns 400. Anthropic emails the requester unless `suppress_notification` is set.
##### Path parameters
spend_limit_increase_request_id: string
ID of the spend limit increase request.
##### Body
suppress_notification: optional boolean
##### Returns
SpendLimitIncreaseRequest object{ id, actor, created_at, 6 more }
Deny Spend Limit Increase Request
cURL
```python
curl https://api.anthropic.com/v1/organizations/spend_limit_increase_requests/$SPEND_LIMIT_INCREASE_REQUEST_ID/deny \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN" \
-d '{}'
```
Response 200
```python
{
"id": "id",
"actor": {
"deleted": true,
"email_address": "email_address",
"name": "name",
"type": "user_actor",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"created_at": "2019-12-27T18:11:19.117Z",
"period": "monthly",
"resolved_at": "2019-12-27T18:11:19.117Z",
"resolved_by": {
"deleted": true,
"email_address": "email_address",
"name": "name",
"type": "user_actor",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"spend_summary": {
"actor": {
"deleted": true,
"email_address": "email_address",
"name": "name",
"type": "user_actor",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"amount": "50000",
"currency": "USD",
"period": "monthly",
"period_to_date_spend": "12050.5",
"scope": {
"type": "user",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"source": {
"type": "user",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"spend_limit_id": "spend_limit_id"
},
"status": "approved",
"type": "spend_limit_increase_request"
}
```
##### Returns Examples
Response 200
```python
{
"id": "id",
"actor": {
"deleted": true,
"email_address": "email_address",
"name": "name",
"type": "user_actor",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"created_at": "2019-12-27T18:11:19.117Z",
"period": "monthly",
"resolved_at": "2019-12-27T18:11:19.117Z",
"resolved_by": {
"deleted": true,
"email_address": "email_address",
"name": "name",
"type": "user_actor",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"spend_summary": {
"actor": {
"deleted": true,
"email_address": "email_address",
"name": "name",
"type": "user_actor",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"amount": "50000",
"currency": "USD",
"period": "monthly",
"period_to_date_spend": "12050.5",
"scope": {
"type": "user",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"source": {
"type": "user",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"spend_limit_id": "spend_limit_id"
},
"status": "approved",
"type": "spend_limit_increase_request"
---
## List Spend Limit Increase Requests - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/spend_limits/increase_requests/list
Path: 04-API-Reference/Admin/admin-spend-limits-increase-requests-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Fspend_limits%2Fincrease_requests%2Flist)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
API Keys
External Keys
Usage Report
Cost Report
Analytics
Spend Limits
Set Spend Limit
Get Spend Limit
Delete Spend Limit
List Effective Spend Limits
Increase Requests
List Spend Limit Increase Requests
Get Spend Limit Increase Request
Approve Spend Limit Increase Request
Deny Spend Limit Increase Request
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [Spend Limits](https://platform.claude.com/docs/en/api/http/admin/spend_limits)
4. [Increase Requests](https://platform.claude.com/docs/en/api/http/admin/spend_limits/increase_requests)
# List Spend Limit Increase Requests
GET/v1/organizations/spend_limit_increase_requests
List spend limit increase requests, most recent first.
Pending requests include a live `spend_summary` for the requester. Requests whose requester is no longer a member are excluded.
##### Query parameters
actor_ids: optional array of string
Filter by requester, as `user_...` tagged IDs.
limit: optional number
default20
maximum1000
minimum1
page: optional string
Opaque cursor from a previous response's `next_page`.
status: optional array of "approved" or "denied" or "pending"
Filter by status. Omit to return all.
One of the following:
"approved"
"denied"
"pending"
##### Returns
data: array of [SpendLimitIncreaseRequest](https://platform.claude.com/docs/en/api/http/admin/spend_limits/increase_requests#spend_limit_increase_request) { id, actor, created_at, 6 more }
id: string
actor: object{ deleted, email_address, name, 2 more }
A user within the organization. `name` and `email_address` are null when the underlying account is unavailable or has been deleted; `deleted` is true only for deleted accounts.
deleted: boolean
True only when the underlying account has been deleted.
defaultfalse
email_address: string or null
The user's email address. Null when the account is unavailable or has been deleted.
name: string or null
The user's current display name. Null when the account is unavailable, has been deleted, or has no name set.
type: "user_actor"
Actor type. Always `user_actor`.
defaultuser_actor
user_id: string
Tagged ID of the user.
created_at: string
formatdate-time
period: "daily" or "monthly" or "weekly"
One of the following:
"daily"
"monthly"
"weekly"
resolved_at: string or null
formatdate-time
resolved_by: object{ deleted, email_address, name, 2 more } or object{ scoped_api_key_id, type } or null
A user within the organization. `name` and `email_address` are null when the underlying account is unavailable or has been deleted; `deleted` is true only for deleted accounts.
One of the following:
UserActor object{ deleted, email_address, name, 2 more }
A user within the organization. `name` and `email_address` are null when the underlying account is unavailable or has been deleted; `deleted` is true only for deleted accounts.
deleted: boolean
True only when the underlying account has been deleted.
defaultfalse
email_address: string or null
The user's email address. Null when the account is unavailable or has been deleted.
name: string or null
The user's current display name. Null when the account is unavailable, has been deleted, or has no name set.
type: "user_actor"
Actor type. Always `user_actor`.
defaultuser_actor
user_id: string
Tagged ID of the user.
ScopedAPIKeyActor object{ scoped_api_key_id, type }
A scoped Admin API key acting on behalf of the organization.
scoped_api_key_id: string
type: "scoped_api_key_actor"
defaultscoped_api_key_actor
spend_summary: [SpendSummary](https://platform.claude.com/docs/en/api/http/admin/spend_limits#spend_summary) { actor, amount, currency, 5 more } or null
Per-member effective-limit report row (`GET /spend_limits/effective`).
status: "approved" or "denied" or "pending"
One of the following:
"approved"
"denied"
"pending"
type: "spend_limit_increase_request"
defaultspend_limit_increase_request
next_page: string or null
List Spend Limit Increase Requests
cURL
```python
curl https://api.anthropic.com/v1/organizations/spend_limit_increase_requests \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
```
Response 200
```python
{
"data": [
{
"id": "id",
"actor": {
"deleted": true,
"email_address": "email_address",
"name": "name",
"type": "user_actor",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"created_at": "2019-12-27T18:11:19.117Z",
"period": "monthly",
"resolved_at": "2019-12-27T18:11:19.117Z",
"resolved_by": {
"deleted": true,
"email_address": "email_address",
"name": "name",
"type": "user_actor",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"spend_summary": {
"actor": {
"deleted": true,
"email_address": "email_address",
"name": "name",
"type": "user_actor",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"amount": "50000",
"currency": "USD",
"period": "monthly",
"period_to_date_spend": "12050.5",
"scope": {
"type": "user",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"source": {
"type": "user",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"spend_limit_id": "spend_limit_id"
},
"status": "approved",
"type": "spend_limit_increase_request"
}
],
"next_page": "next_page"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"id": "id",
"actor": {
"deleted": true,
"email_address": "email_address",
"name": "name",
"type": "user_actor",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"created_at": "2019-12-27T18:11:19.117Z",
"period": "monthly",
"resolved_at": "2019-12-27T18:11:19.117Z",
"resolved_by": {
"deleted": true,
"email_address": "email_address",
"name": "name",
"type": "user_actor",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"spend_summary": {
"actor": {
"deleted": true,
"email_address": "email_address",
"name": "name",
"type": "user_actor",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"amount": "50000",
"currency": "USD",
"period": "monthly",
"period_to_date_spend": "12050.5",
"scope": {
"type": "user",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"source": {
"type": "user",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"spend_limit_id": "spend_limit_id"
},
"status": "approved",
"type": "spend_limit_increase_request"
---
## Get Spend Limit Increase Request - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/spend_limits/increase_requests/retrieve
Path: 04-API-Reference/Admin/admin-spend-limits-increase-requests-retrieve.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Fspend_limits%2Fincrease_requests%2Fretrieve)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
API Keys
External Keys
Usage Report
Cost Report
Analytics
Spend Limits
Set Spend Limit
Get Spend Limit
Delete Spend Limit
List Effective Spend Limits
Increase Requests
List Spend Limit Increase Requests
Get Spend Limit Increase Request
Approve Spend Limit Increase Request
Deny Spend Limit Increase Request
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [Spend Limits](https://platform.claude.com/docs/en/api/http/admin/spend_limits)
4. [Increase Requests](https://platform.claude.com/docs/en/api/http/admin/spend_limits/increase_requests)
# Get Spend Limit Increase Request
GET/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}
Retrieve a spend limit increase request.
While `pending`, the response includes a live `spend_summary` for the requester at the request's period.
##### Path parameters
spend_limit_increase_request_id: string
ID of the spend limit increase request.
##### Returns
SpendLimitIncreaseRequest object{ id, actor, created_at, 6 more }
Get Spend Limit Increase Request
cURL
```python
curl https://api.anthropic.com/v1/organizations/spend_limit_increase_requests/$SPEND_LIMIT_INCREASE_REQUEST_ID \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
```
Response 200
```python
{
"id": "id",
"actor": {
"deleted": true,
"email_address": "email_address",
"name": "name",
"type": "user_actor",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"created_at": "2019-12-27T18:11:19.117Z",
"period": "monthly",
"resolved_at": "2019-12-27T18:11:19.117Z",
"resolved_by": {
"deleted": true,
"email_address": "email_address",
"name": "name",
"type": "user_actor",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"spend_summary": {
"actor": {
"deleted": true,
"email_address": "email_address",
"name": "name",
"type": "user_actor",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"amount": "50000",
"currency": "USD",
"period": "monthly",
"period_to_date_spend": "12050.5",
"scope": {
"type": "user",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"source": {
"type": "user",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"spend_limit_id": "spend_limit_id"
},
"status": "approved",
"type": "spend_limit_increase_request"
}
```
##### Returns Examples
Response 200
```python
{
"id": "id",
"actor": {
"deleted": true,
"email_address": "email_address",
"name": "name",
"type": "user_actor",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"created_at": "2019-12-27T18:11:19.117Z",
"period": "monthly",
"resolved_at": "2019-12-27T18:11:19.117Z",
"resolved_by": {
"deleted": true,
"email_address": "email_address",
"name": "name",
"type": "user_actor",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"spend_summary": {
"actor": {
"deleted": true,
"email_address": "email_address",
"name": "name",
"type": "user_actor",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"amount": "50000",
"currency": "USD",
"period": "monthly",
"period_to_date_spend": "12050.5",
"scope": {
"type": "user",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"source": {
"type": "user",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"spend_limit_id": "spend_limit_id"
},
"status": "approved",
"type": "spend_limit_increase_request"
---
## Increase Requests - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/spend_limits/increase_requests
Path: 04-API-Reference/Admin/admin-spend-limits-increase-requests.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Fspend_limits%2Fincrease_requests)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
API Keys
External Keys
Usage Report
Cost Report
Analytics
Spend Limits
Set Spend Limit
Get Spend Limit
Delete Spend Limit
List Effective Spend Limits
Increase Requests
List Spend Limit Increase Requests
Get Spend Limit Increase Request
Approve Spend Limit Increase Request
Deny Spend Limit Increase Request
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [Spend Limits](https://platform.claude.com/docs/en/api/http/admin/spend_limits)
# Increase Requests
##### [List Spend Limit Increase Requests](https://platform.claude.com/docs/en/api/http/admin/spend_limits/increase_requests/list)
GET/v1/organizations/spend_limit_increase_requests
##### [Get Spend Limit Increase Request](https://platform.claude.com/docs/en/api/http/admin/spend_limits/increase_requests/retrieve)
GET/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}
##### [Approve Spend Limit Increase Request](https://platform.claude.com/docs/en/api/http/admin/spend_limits/increase_requests/approve)
POST/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}/approve
##### [Deny Spend Limit Increase Request](https://platform.claude.com/docs/en/api/http/admin/spend_limits/increase_requests/deny)
POST/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}/deny
##### Models
SpendLimitIncreaseRequest object{ id, actor, created_at, 6 more }
IncreaseRequestApproveResponse object{ id, actor, created_at, 7 more }
---
## List Effective Spend Limits - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/spend_limits/list_effective
Path: 04-API-Reference/Admin/admin-spend-limits-list-effective.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Fspend_limits%2Flist_effective)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
API Keys
External Keys
Usage Report
Cost Report
Analytics
Spend Limits
Set Spend Limit
Get Spend Limit
Delete Spend Limit
List Effective Spend Limits
Increase Requests
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [Spend Limits](https://platform.claude.com/docs/en/api/http/admin/spend_limits)
# List Effective Spend Limits
GET/v1/organizations/spend_limits/effective
List each member's effective spend limit and period-to-date spend.
Returns one row per (member, period) the member resolves a spend limit for, with the `source` scope the spend limit was inherited from. Paginates by member, so a member's periods never split across pages.
##### Query parameters
limit: optional number
Maximum number of members per page. A member's period rows never split across pages, so a page may carry more rows than this. Defaults to `20`.
default20
maximum1000
minimum1
page: optional string
Opaque cursor from a previous response's `next_page` field.
period: optional array of "daily" or "monthly" or "weekly"
Restrict the report to these limit periods. Omit to return one row per period each member resolves a spend limit for.
maxItems3
One of the following:
"daily"
"monthly"
"weekly"
user_ids: optional array of string
Restrict the report to these members, by tagged user ID (`user_...`). At most 100 entries.
maxItems100
##### Returns
data: array of [SpendSummary](https://platform.claude.com/docs/en/api/http/admin/spend_limits#spend_summary) { actor, amount, currency, 5 more }
actor: object{ deleted, email_address, name, 2 more }
A user within the organization. `name` and `email_address` are null when the underlying account is unavailable or has been deleted; `deleted` is true only for deleted accounts.
deleted: boolean
True only when the underlying account has been deleted.
defaultfalse
email_address: string or null
The user's email address. Null when the account is unavailable or has been deleted.
name: string or null
The user's current display name. Null when the account is unavailable, has been deleted, or has no name set.
type: "user_actor"
Actor type. Always `user_actor`.
defaultuser_actor
user_id: string
Tagged ID of the user.
amount: string or null
Effective limit amount as a non-negative integer decimal string in the minor unit of `currency` (cents for USD). `null` means no limit applies for this row's `period` — each period resolves independently, so another period may still cap this member.
currency: string
ISO 4217 code of the organization's billing currency; the unit for `amount` and `period_to_date_spend`.
period: "daily" or "monthly" or "weekly"
Period this row's effective limit and spend are reported for.
One of the following:
"daily"
"monthly"
"weekly"
period_to_date_spend: string
The member's spend so far in the current period, as a non-negative decimal string in the minor unit of `currency` (cents for USD). May carry fractional minor units up to three decimal places (e.g. `"12050.5"`) — metered usage is not rounded to whole cents. Reads as `"0"` when the spend reading is temporarily unavailable.
scope: object{ type, user_id }
Scope selecting a single member of the organization.
type: "user"
Scope type. Always `user` for this scope.
defaultuser
user_id: string
Tagged ID of the member the spend limit applies to.
source: object{ type, user_id } or object{ seat_tier, type } or object{ rbac_group_id, type } or 2 more
Scope selecting a single member of the organization.
One of the following:
User object{ type, user_id }
Scope selecting a single member of the organization.
type: "user"
Scope type. Always `user` for this scope.
defaultuser
user_id: string
Tagged ID of the member the spend limit applies to.
SeatTier object{ seat_tier, type }
seat_tier: string
type: "seat_tier"
defaultseat_tier
RbacGroup object{ rbac_group_id, type }
rbac_group_id: string
type: "rbac_group"
defaultrbac_group
OrganizationService object{ service, type }
service: string
type: "organization_service"
defaultorganization_service
Organization object{ type }
type: "organization"
defaultorganization
spend_limit_id: string
next_page: string or null
List Effective Spend Limits
cURL
```python
curl https://api.anthropic.com/v1/organizations/spend_limits/effective \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
```
Response 200
```python
{
"data": [
{
"actor": {
"deleted": true,
"email_address": "email_address",
"name": "name",
"type": "user_actor",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"amount": "50000",
"currency": "USD",
"period": "monthly",
"period_to_date_spend": "12050.5",
"scope": {
"type": "user",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"source": {
"type": "user",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"spend_limit_id": "spend_limit_id"
}
],
"next_page": "next_page"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"actor": {
"deleted": true,
"email_address": "email_address",
"name": "name",
"type": "user_actor",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"amount": "50000",
"currency": "USD",
"period": "monthly",
"period_to_date_spend": "12050.5",
"scope": {
"type": "user",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"source": {
"type": "user",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"spend_limit_id": "spend_limit_id"
---
## Get Spend Limit - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/spend_limits/retrieve
Path: 04-API-Reference/Admin/admin-spend-limits-retrieve.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Fspend_limits%2Fretrieve)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
API Keys
External Keys
Usage Report
Cost Report
Analytics
Spend Limits
Set Spend Limit
Get Spend Limit
Delete Spend Limit
List Effective Spend Limits
Increase Requests
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [Spend Limits](https://platform.claude.com/docs/en/api/http/admin/spend_limits)
# Get Spend Limit
GET/v1/organizations/spend_limits/{spend_limit_id}
Retrieve a spend limit by ID.
##### Path parameters
spend_limit_id: string
ID of the Spend Limit.
##### Returns
SpendLimit object{ id, amount, created_at, 5 more }
A configured spend limit: a cap on metered spend for one scope and period.
Get Spend Limit
cURL
```python
curl https://api.anthropic.com/v1/organizations/spend_limits/$SPEND_LIMIT_ID \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
```
Response 200
```python
{
"id": "id",
"amount": "50000",
"created_at": "2019-12-27T18:11:19.117Z",
"currency": "USD",
"period": "monthly",
"scope": {
"type": "user",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"type": "spend_limit",
"updated_at": "2019-12-27T18:11:19.117Z"
}
```
##### Returns Examples
Response 200
```python
{
"id": "id",
"amount": "50000",
"created_at": "2019-12-27T18:11:19.117Z",
"currency": "USD",
"period": "monthly",
"scope": {
"type": "user",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"type": "spend_limit",
"updated_at": "2019-12-27T18:11:19.117Z"
---
## Spend Limits - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/spend_limits
Path: 04-API-Reference/Admin/admin-spend-limits.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Fspend_limits)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
API Keys
External Keys
Usage Report
Cost Report
Analytics
Spend Limits
Set Spend Limit
Get Spend Limit
Delete Spend Limit
List Effective Spend Limits
Increase Requests
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
# Spend Limits
##### [Set Spend Limit](https://platform.claude.com/docs/en/api/http/admin/spend_limits/create)
POST/v1/organizations/spend_limits
##### [Get Spend Limit](https://platform.claude.com/docs/en/api/http/admin/spend_limits/retrieve)
GET/v1/organizations/spend_limits/{spend_limit_id}
##### [Delete Spend Limit](https://platform.claude.com/docs/en/api/http/admin/spend_limits/delete)
DELETE/v1/organizations/spend_limits/{spend_limit_id}
##### [List Effective Spend Limits](https://platform.claude.com/docs/en/api/http/admin/spend_limits/list_effective)
GET/v1/organizations/spend_limits/effective
##### Models
SpendLimit object{ id, amount, created_at, 5 more }
A configured spend limit: a cap on metered spend for one scope and period.
SpendSummary object{ actor, amount, currency, 5 more }
Per-member effective-limit report row (`GET /spend_limits/effective`).
SpendLimitDeleteResponse object{ id, type }
id: string
type: "spend_limit_deleted"
defaultspend_limit_deleted
#### Spend Limits[Increase Requests](https://platform.claude.com/docs/en/api/http/admin/spend_limits/increase_requests)
##### [List Spend Limit Increase Requests](https://platform.claude.com/docs/en/api/http/admin/spend_limits/increase_requests/list)
GET/v1/organizations/spend_limit_increase_requests
##### [Get Spend Limit Increase Request](https://platform.claude.com/docs/en/api/http/admin/spend_limits/increase_requests/retrieve)
GET/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}
##### [Approve Spend Limit Increase Request](https://platform.claude.com/docs/en/api/http/admin/spend_limits/increase_requests/approve)
POST/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}/approve
##### [Deny Spend Limit Increase Request](https://platform.claude.com/docs/en/api/http/admin/spend_limits/increase_requests/deny)
POST/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}/deny
---
## Get Claude Code Usage Report - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/usage_report/retrieve_claude_code
Path: 04-API-Reference/Admin/admin-usage-report-retrieve-claude-code.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fusage_report%2Fretrieve_claude_code)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Get Messages Usage Report
Get Claude Code Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Usage Report](https://platform.claude.com/docs/en/api/http/beta/organization/usage_report)
# Get Claude Code Usage Report
GET/v1/organizations/usage_report/claude_code
Retrieve daily aggregated usage metrics for Claude Code users. Enables organizations to analyze developer productivity and build custom dashboards.
##### Query parameters
starting_at: string
UTC date in YYYY-MM-DD format. Returns metrics for this single day only.
pattern^\d{4}-\d{2}-\d{2}\$
formatdate
limit: optional number
Number of records per page (default: 20, max: 1000).
default20
maximum1000
minimum1
page: optional string
Opaque cursor token from previous response's `next_page` field.
##### Returns
BetaClaudeCodeUsageReport object{ data, has_more, next_page }
Get Claude Code Usage Report
cURL
```python
curl https://api.anthropic.com/v1/organizations/usage_report/claude_code \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"data": [
{
"actor": {
"email_address": "user@emaildomain.com",
"type": "user_actor"
},
"core_metrics": {
"commits_by_claude_code": 8,
"lines_of_code": {
"added": 342,
"removed": 128
},
"num_sessions": 15,
"pull_requests_by_claude_code": 2
},
"customer_type": "api",
"date": "2025-08-08T00:00:00Z",
"is_remote": false,
"model_breakdown": [
{
"estimated_cost": {
"amount": 186,
"currency": "USD"
},
"model": "claude-opus-5",
"tokens": {
"cache_creation": 2340,
"cache_read": 8790,
"input": 45230,
"output": 12450
}
},
{
"estimated_cost": {
"amount": 42,
"currency": "USD"
},
"model": "claude-sonnet-5",
"tokens": {
"cache_creation": 890,
"cache_read": 3420,
"input": 23100,
"output": 5680
}
}
],
"organization_id": "12345678-1234-5678-1234-567812345678",
"terminal_type": "iTerm.app",
"tool_actions": {
"edit_tool": {
"accepted": 25,
"rejected": 3
},
"multi_edit_tool": {
"accepted": 12,
"rejected": 1
},
"notebook_edit_tool": {
"accepted": 5,
"rejected": 2
},
"write_tool": {
"accepted": 8,
"rejected": 0
}
},
"subscription_type": "enterprise"
}
],
"has_more": true,
"next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo="
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"actor": {
"email_address": "user@emaildomain.com",
"type": "user_actor"
},
"core_metrics": {
"commits_by_claude_code": 8,
"lines_of_code": {
"added": 342,
"removed": 128
},
"num_sessions": 15,
"pull_requests_by_claude_code": 2
},
"customer_type": "api",
"date": "2025-08-08T00:00:00Z",
"is_remote": false,
"model_breakdown": [
{
"estimated_cost": {
"amount": 186,
"currency": "USD"
},
"model": "claude-opus-5",
"tokens": {
"cache_creation": 2340,
"cache_read": 8790,
"input": 45230,
"output": 12450
}
},
{
"estimated_cost": {
"amount": 42,
"currency": "USD"
},
"model": "claude-sonnet-5",
"tokens": {
"cache_creation": 890,
"cache_read": 3420,
"input": 23100,
"output": 5680
}
}
],
"organization_id": "12345678-1234-5678-1234-567812345678",
"terminal_type": "iTerm.app",
"tool_actions": {
"edit_tool": {
"accepted": 25,
"rejected": 3
},
"multi_edit_tool": {
"accepted": 12,
"rejected": 1
},
"notebook_edit_tool": {
"accepted": 5,
"rejected": 2
},
"write_tool": {
"accepted": 8,
"rejected": 0
}
},
"subscription_type": "enterprise"
}
],
"has_more": true,
"next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo="
---
## Get Messages Usage Report - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/usage_report/retrieve_messages
Path: 04-API-Reference/Admin/admin-usage-report-retrieve-messages.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Fusage_report%2Fretrieve_messages)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
API Keys
External Keys
Usage Report
Get Messages Usage Report
Get Claude Code Usage Report
Cost Report
Analytics
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [Usage Report](https://platform.claude.com/docs/en/api/http/admin/usage_report)
# Get Messages Usage Report
GET/v1/organizations/usage_report/messages
Get Messages Usage Report
##### Query parameters
starting_at: string
Time buckets that start on or after this RFC 3339 timestamp will be returned. Each time bucket will be snapped to the start of the minute/hour/day in UTC.
formatdate-time
account_ids: optional array of string
Restrict usage returned to the specified user account ID(s).
api_key_ids: optional array of string
Restrict usage returned to the specified API key ID(s).
bucket_width: optional "1d" or "1h" or "1m"
Time granularity of the response data.
default1d
One of the following:
"1d"
"1h"
"1m"
context_window: optional array of "0-200k" or "200k-1M"
Restrict usage returned to the specified context window(s).
One of the following:
"0-200k"
"200k-1M"
ending_at: optional string
Time buckets that end before this RFC 3339 timestamp will be returned.
formatdate-time
group_by: optional array of "account_id" or "api_key_id" or "context_window" or 6 more
Group by any subset of the available options. Grouping by `speed` requires the `fast-mode-2026-02-01` beta header.
One of the following:
"account_id"
"api_key_id"
"context_window"
"inference_geo"
"model"
"service_account_id"
"service_tier"
"speed"
"workspace_id"
inference_geos: optional array of "global" or "not_available" or "us"
Restrict usage returned to the specified inference geo(s). Use `not_available` for models that do not support specifying `inference_geo`.
One of the following:
"global"
"not_available"
"us"
limit: optional number
Maximum number of time buckets to return in the response.
The default and max limits depend on `bucket_width`: • `"1d"`: Default of 7 days, maximum of 31 days • `"1h"`: Default of 24 hours, maximum of 168 hours • `"1m"`: Default of 60 minutes, maximum of 1440 minutes
models: optional array of string
Restrict usage returned to the specified model(s).
page: optional string
Optionally set to the `next_page` token from the previous response.
service_account_ids: optional array of string
Restrict usage returned to the specified service account ID(s).
service_tiers: optional array of "batch" or "flex" or "flex_discount" or 3 more
Restrict usage returned to the specified service tier(s).
One of the following:
"batch"
"flex"
"flex_discount"
"priority"
"priority_on_demand"
"standard"
speeds: optional array of "fast" or "standard"
Restrict usage returned to the specified speed(s) (Claude Code research preview). Requires the `fast-mode-2026-02-01` beta header.
One of the following:
"fast"
"standard"
workspace_ids: optional array of string
Restrict usage returned to the specified workspace ID(s).
##### Headers
"anthropic-beta": optional array of string
Optional header to specify the beta version(s) you want to use.
To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta.
##### Returns
MessagesUsageReport object{ data, has_more, next_page }
Get Messages Usage Report
cURL
```python
curl https://api.anthropic.com/v1/organizations/usage_report/messages \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
```
Response 200
```python
{
"data": [
{
"ending_at": "2025-08-02T00:00:00Z",
"results": [
{
"account_id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"api_key_id": "apikey_01Rj2N8SVvo6BePZj99NhmiT",
"cache_creation": {
"ephemeral_1h_input_tokens": 1000,
"ephemeral_5m_input_tokens": 500
},
"cache_read_input_tokens": 200,
"context_window": "0-200k",
"inference_geo": "global",
"model": "claude-opus-5",
"output_tokens": 500,
"server_tool_use": {
"web_search_requests": 10
},
"service_account_id": "svac_01Hk3R9TWxq7CfQak00OiVw4",
"service_tier": "standard",
"uncached_input_tokens": 1500,
"workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"
}
],
"starting_at": "2025-08-01T00:00:00Z"
}
],
"has_more": true,
"next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo="
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"ending_at": "2025-08-02T00:00:00Z",
"results": [
{
"account_id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"api_key_id": "apikey_01Rj2N8SVvo6BePZj99NhmiT",
"cache_creation": {
"ephemeral_1h_input_tokens": 1000,
"ephemeral_5m_input_tokens": 500
},
"cache_read_input_tokens": 200,
"context_window": "0-200k",
"inference_geo": "global",
"model": "claude-opus-5",
"output_tokens": 500,
"server_tool_use": {
"web_search_requests": 10
},
"service_account_id": "svac_01Hk3R9TWxq7CfQak00OiVw4",
"service_tier": "standard",
"uncached_input_tokens": 1500,
"workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"
}
],
"starting_at": "2025-08-01T00:00:00Z"
}
],
"has_more": true,
"next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo="
---
## Usage Report - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/usage_report
Path: 04-API-Reference/Admin/admin-usage-report.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Fusage_report)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
API Keys
External Keys
Usage Report
Get Messages Usage Report
Get Claude Code Usage Report
Cost Report
Analytics
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
# Usage Report
##### [Get Messages Usage Report](https://platform.claude.com/docs/en/api/http/admin/usage_report/retrieve_messages)
GET/v1/organizations/usage_report/messages
##### [Get Claude Code Usage Report](https://platform.claude.com/docs/en/api/http/admin/usage_report/retrieve_claude_code)
GET/v1/organizations/usage_report/claude_code
##### Models
ClaudeCodeUsageReport object{ data, has_more, next_page }
MessagesUsageReport object{ data, has_more, next_page }
---
## List Users - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/users/list
Path: 04-API-Reference/Admin/admin-users-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fusers%2Flist)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
List Users
Get User
Update User
Remove User
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Users](https://platform.claude.com/docs/en/api/http/beta/organization/users)
# List Users
GET/v1/organizations/users
List the organization's members.
##### Query parameters
after_id: optional string
ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object.
before_id: optional string
ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object.
email: optional string
Filter by user email.
formatemail
limit: optional number
Number of items to return per page.
Defaults to `20`. Ranges from `1` to `1000`.
default20
maximum1000
minimum1
roles: optional array of string
Filter to items whose `role` equals one of the supplied values. Repeatable; values are OR'ed together.
Accepted values depend on the organization type: Console and API organizations accept `user`, `developer`, `billing`, `admin`, and `claude_code_user`; Claude Enterprise organizations accept `user`, `owner`, `primary_owner`, `membership_admin`, and `managed`.
##### Returns
data: array of [BetaOrganizationUser](https://platform.claude.com/docs/en/api/http/beta/organization/users#beta_organization_user) { type: "user", id, added_at, 3 more }
type: "user"
Object type.
For Users, this is always `"user"`.
defaultuser
id: string
ID of the User.
added_at: string
RFC 3339 datetime string indicating when the User joined the Organization.
formatdate-time
email: string
Email of the User.
name: string
Name of the User.
role: [BetaOrganizationRole](platform-claude-com-http-beta-organization.md#beta_organization_role)
Organization role of the User.
One of the following:
"admin"
"billing"
"claude_code_user"
"developer"
"managed"
"membership_admin"
"owner"
"primary_owner"
"user"
first_id: string or null
First ID in the `data` list. Can be used as the `before_id` for the previous page.
has_more: boolean
Indicates if there are more results in the requested page direction.
last_id: string or null
Last ID in the `data` list. Can be used as the `after_id` for the next page.
List Users
cURL
```python
curl https://api.anthropic.com/v1/organizations/users \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"data": [
{
"id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"added_at": "2024-10-30T23:58:27.427722Z",
"email": "user@emaildomain.com",
"name": "Jane Doe",
"role": "admin",
"type": "user"
}
],
"first_id": "first_id",
"has_more": true,
"last_id": "last_id"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"added_at": "2024-10-30T23:58:27.427722Z",
"email": "user@emaildomain.com",
---
## Users - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/users
Path: 04-API-Reference/Admin/admin-users.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Fusers)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
Get User
List Users
Update User
Remove User
RBAC Groups
RBAC Roles
Workspaces
API Keys
External Keys
Usage Report
Cost Report
Analytics
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
# Users
##### [Get User](https://platform.claude.com/docs/en/api/http/admin/users/retrieve)
GET/v1/organizations/users/{user_id}
##### [List Users](https://platform.claude.com/docs/en/api/http/admin/users/list)
GET/v1/organizations/users
##### [Update User](https://platform.claude.com/docs/en/api/http/admin/users/update)
POST/v1/organizations/users/{user_id}
##### [Remove User](https://platform.claude.com/docs/en/api/http/admin/users/delete)
DELETE/v1/organizations/users/{user_id}
##### Models
User object{ id, added_at, email, 3 more }
id: string
ID of the User.
added_at: string
RFC 3339 datetime string indicating when the User joined the Organization.
formatdate-time
email: string
Email of the User.
name: string
Name of the User.
role: "admin" or "billing" or "claude_code_user" or 6 more
Organization role of the User.
One of the following:
"admin"
"billing"
"claude_code_user"
"developer"
"managed"
"membership_admin"
"owner"
"primary_owner"
"user"
type: "user"
Object type.
For Users, this is always `"user"`.
defaultuser
UserDeleteResponse object{ id, type }
id: string
ID of the User.
type: "user_deleted"
Deleted object type.
For Users, this is always `"user_deleted"`.
---
## Archive Workspace - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/workspaces/archive
Path: 04-API-Reference/Admin/admin-workspaces-archive.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Fworkspaces%2Farchive)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
Create Workspace
Get Workspace
List Workspaces
Update Workspace
Archive Workspace
Members
Rate Limits
Service Accounts
API Keys
External Keys
Usage Report
Cost Report
Analytics
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [Workspaces](https://platform.claude.com/docs/en/api/http/admin/workspaces)
# Archive Workspace
POST/v1/organizations/workspaces/{workspace_id}/archive
Archive Workspace
##### Path parameters
workspace_id: string
##### Returns
Workspace object{ id, archived_at, compartment_id, 7 more }
Archive Workspace
cURL
```python
curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/archive \
-X POST \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
```
Response 200
```python
{
"id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ",
"archived_at": "2024-11-01T23:59:27.427722Z",
"compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c",
"created_at": "2024-10-30T23:58:27.427722Z",
"data_residency": {
"allowed_inference_geos": "unrestricted",
"default_inference_geo": "default_inference_geo",
"workspace_geo": "workspace_geo"
},
"display_color": "#6C5BB9",
"external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK",
"name": "Workspace Name",
"tags": {
"env": "prod",
"team": "platform"
},
"type": "workspace"
}
```
##### Returns Examples
Response 200
```python
{
"id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ",
"archived_at": "2024-11-01T23:59:27.427722Z",
"compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c",
"created_at": "2024-10-30T23:58:27.427722Z",
"data_residency": {
"allowed_inference_geos": "unrestricted",
"default_inference_geo": "default_inference_geo",
"workspace_geo": "workspace_geo"
},
"display_color": "#6C5BB9",
"external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK",
---
## Create Workspace - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/workspaces/create
Path: 04-API-Reference/Admin/admin-workspaces-create.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Fworkspaces%2Fcreate)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
Create Workspace
Get Workspace
List Workspaces
Update Workspace
Archive Workspace
Members
Rate Limits
Service Accounts
API Keys
External Keys
Usage Report
Cost Report
Analytics
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [Workspaces](https://platform.claude.com/docs/en/api/http/admin/workspaces)
# Create Workspace
POST/v1/organizations/workspaces
Create Workspace
##### Headers
"anthropic-beta": optional array of string
Optional header to specify the beta version(s) you want to use.
To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta.
##### Body
name: string
Name of the Workspace.
maxLength40
minLength1
data_residency: optional object{ allowed_inference_geos, default_inference_geo, workspace_geo } or null
Data residency configuration for the workspace. If omitted, defaults to `workspace_geo: "us"`, `allowed_inference_geos: "unrestricted"`, and `default_inference_geo: "global"`.
allowed_inference_geos: optional array of "global" or "us" or "unrestricted" or null
Permitted inference geo values. Defaults to 'unrestricted' if omitted, which allows all geos. Use the string 'unrestricted' to allow all geos, or a list of specific geos.
One of the following:
array of "global" or "us"
One of the following:
"global"
"us"
"unrestricted"
default_inference_geo: optional "global" or "us" or null
Default inference geo applied when requests omit the parameter. Defaults to 'global' if omitted. Must be a member of `allowed_inference_geos` unless `allowed_inference_geos` is `"unrestricted"`.
One of the following:
"global"
"us"
workspace_geo: optional "us" or null
Geographic region for workspace data storage. Immutable after creation. Defaults to 'us' if omitted.
display_color: optional string or null
Hex color code representing the Workspace in the Anthropic Console.
maxLength7
pattern^#\[0-9A-Fa-f\]{6}\$
external_key_id: optional string or null
ID of the customer-managed encryption key (CMEK) configuration to use for this Workspace. Setting this field requires CMEK to be enabled for your organization. When set, data stored for this Workspace is encrypted with the referenced key. Create key configurations with the External Keys API. On Claude Platform on AWS the value is the AWS KMS key ARN, and the key must be a single-Region key in the same AWS account and Region as the Workspace. On that platform the key is validated against this Workspace when it is attached, so a key-policy problem is reported as an error on this request. This field is write-once: once a key is attached to a Workspace it cannot be detached or replaced. To rotate key material, rotate the underlying key on your cloud KMS; the `external_key_id` stays the same.
tags: optional map\[string\] or null
User-defined tags as string key-value pairs. Keys may not begin with `anthropic`.
##### Returns
Workspace object{ id, archived_at, compartment_id, 7 more }
Create Workspace
cURL
```python
curl https://api.anthropic.com/v1/organizations/workspaces \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN" \
-d '{
"name": "x",
"display_color": "#6C5BB9",
"external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK",
"tags": {
"env": "prod",
"team": "platform"
}
}'
```
Response 200
```python
{
"id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ",
"archived_at": "2024-11-01T23:59:27.427722Z",
"compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c",
"created_at": "2024-10-30T23:58:27.427722Z",
"data_residency": {
"allowed_inference_geos": "unrestricted",
"default_inference_geo": "default_inference_geo",
"workspace_geo": "workspace_geo"
},
"display_color": "#6C5BB9",
"external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK",
"name": "Workspace Name",
"tags": {
"env": "prod",
"team": "platform"
},
"type": "workspace"
}
```
##### Returns Examples
Response 200
```python
{
"id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ",
"archived_at": "2024-11-01T23:59:27.427722Z",
"compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c",
"created_at": "2024-10-30T23:58:27.427722Z",
"data_residency": {
"allowed_inference_geos": "unrestricted",
"default_inference_geo": "default_inference_geo",
"workspace_geo": "workspace_geo"
},
"display_color": "#6C5BB9",
"external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK",
---
## List Workspaces - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/workspaces/list
Path: 04-API-Reference/Admin/admin-workspaces-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Fworkspaces%2Flist)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
Create Workspace
Get Workspace
List Workspaces
Update Workspace
Archive Workspace
Members
Rate Limits
Service Accounts
API Keys
External Keys
Usage Report
Cost Report
Analytics
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [Workspaces](https://platform.claude.com/docs/en/api/http/admin/workspaces)
# List Workspaces
GET/v1/organizations/workspaces
List Workspaces
##### Query parameters
after_id: optional string
ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object.
before_id: optional string
ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object.
include_archived: optional boolean
Whether to include Workspaces that have been archived in the response
defaultfalse
limit: optional number
Number of items to return per page.
Defaults to `20`. Ranges from `1` to `1000`.
default20
maximum1000
minimum1
##### Returns
data: array of [Workspace](https://platform.claude.com/docs/en/api/http/$shared#workspace) { id, archived_at, compartment_id, 7 more }
id: string
ID of the Workspace.
archived_at: string or null
RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived.
formatdate-time
compartment_id: string
Identifier for this Workspace's encryption compartment. When you configure a customer-managed encryption key (CMEK) on AWS, reference this value in your KMS key-policy condition so the key is scoped to this compartment. On GCP and Azure, Anthropic enforces the compartment binding automatically; you do not need to reference this value in your key configuration. See the CMEK integration guide for the required key configuration; unless your organization is on Claude Platform on AWS, it includes a separate value used during key validation. On Claude Platform on AWS there is no separate validation value: the key is validated against this Workspace's own value when it is attached, so if your key policy uses the compartment condition, add this value to it before attaching the key.
created_at: string
RFC 3339 datetime string indicating when the Workspace was created.
formatdate-time
data_residency: object{ allowed_inference_geos, default_inference_geo, workspace_geo }
Data residency configuration.
allowed_inference_geos: array of string or "unrestricted"
Permitted inference geo values. 'unrestricted' means all geos are allowed.
One of the following:
array of string
"unrestricted"
default_inference_geo: string
Default inference geo applied when requests omit the parameter.
workspace_geo: string
Geographic region for workspace data storage. Immutable after creation.
display_color: string
Hex color code representing the Workspace in the Anthropic Console.
external_key_id: string or null
ID of the customer-managed encryption key (CMEK) configuration to use for this Workspace. Setting this field requires CMEK to be enabled for your organization. When set, data stored for this Workspace is encrypted with the referenced key. Create key configurations with the External Keys API. On Claude Platform on AWS the value is the AWS KMS key ARN, and the key must be a single-Region key in the same AWS account and Region as the Workspace. On that platform the key is validated against this Workspace when it is attached, so a key-policy problem is reported as an error on this request. This field is write-once: once a key is attached to a Workspace it cannot be detached or replaced. To rotate key material, rotate the underlying key on your cloud KMS; the `external_key_id` stays the same.
name: string
Name of the Workspace.
tags: map\[string\]
User-defined tags as string key-value pairs. Keys may not begin with `anthropic`.
type: "workspace"
Object type.
For Workspaces, this is always `"workspace"`.
defaultworkspace
first_id: string or null
First ID in the `data` list. Can be used as the `before_id` for the previous page.
has_more: boolean
Indicates if there are more results in the requested page direction.
last_id: string or null
Last ID in the `data` list. Can be used as the `after_id` for the next page.
List Workspaces
cURL
```python
curl https://api.anthropic.com/v1/organizations/workspaces \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
```
Response 200
```python
{
"data": [
{
"id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ",
"archived_at": "2024-11-01T23:59:27.427722Z",
"compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c",
"created_at": "2024-10-30T23:58:27.427722Z",
"data_residency": {
"allowed_inference_geos": "unrestricted",
"default_inference_geo": "default_inference_geo",
"workspace_geo": "workspace_geo"
},
"display_color": "#6C5BB9",
"external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK",
"name": "Workspace Name",
"tags": {
"env": "prod",
"team": "platform"
},
"type": "workspace"
}
],
"first_id": "first_id",
"has_more": true,
"last_id": "last_id"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ",
"archived_at": "2024-11-01T23:59:27.427722Z",
"compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c",
"created_at": "2024-10-30T23:58:27.427722Z",
"data_residency": {
"allowed_inference_geos": "unrestricted",
"default_inference_geo": "default_inference_geo",
"workspace_geo": "workspace_geo"
},
"display_color": "#6C5BB9",
"external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK",
---
## Create Workspace Member - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/workspaces/members/create
Path: 04-API-Reference/Admin/admin-workspaces-members-create.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Fworkspaces%2Fmembers%2Fcreate)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
Create Workspace
Get Workspace
List Workspaces
Update Workspace
Archive Workspace
Members
Create Workspace Member
Get Workspace Member
List Workspace Members
Update Workspace Member
Delete Workspace Member
Rate Limits
Service Accounts
API Keys
External Keys
Usage Report
Cost Report
Analytics
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [Workspaces](https://platform.claude.com/docs/en/api/http/admin/workspaces)
4. [Members](https://platform.claude.com/docs/en/api/http/admin/workspaces/members)
# Create Workspace Member
POST/v1/organizations/workspaces/{workspace_id}/members
Create Workspace Member
##### Path parameters
workspace_id: string
ID of the Workspace.
##### Body
user_id: string
ID of the User.
workspace_role: "workspace_admin" or "workspace_developer" or "workspace_restricted_developer" or "workspace_user"
Role of the new Workspace Member. Cannot be `workspace_billing`.
One of the following:
"workspace_admin"
"workspace_developer"
"workspace_restricted_developer"
"workspace_user"
##### Returns
WorkspaceMember object{ type, user_id, workspace_id, workspace_role }
type: "workspace_member"
Object type.
For Workspace Members, this is always `"workspace_member"`.
defaultworkspace_member
user_id: string
ID of the User.
workspace_id: string
ID of the Workspace.
workspace_role: "workspace_admin" or "workspace_billing" or "workspace_developer" or 2 more
Role of the Workspace Member.
One of the following:
"workspace_admin"
"workspace_billing"
"workspace_developer"
"workspace_restricted_developer"
"workspace_user"
Create Workspace Member
cURL
```python
curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN" \
-d '{
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"workspace_role": "workspace_admin"
}'
```
Response 200
```python
{
"type": "workspace_member",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ",
"workspace_role": "workspace_user"
}
```
##### Returns Examples
Response 200
```python
{
"type": "workspace_member",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ",
"workspace_role": "workspace_user"
---
## Delete Workspace Member - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/workspaces/members/delete
Path: 04-API-Reference/Admin/admin-workspaces-members-delete.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Fworkspaces%2Fmembers%2Fdelete)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
Create Workspace
Get Workspace
List Workspaces
Update Workspace
Archive Workspace
Members
Create Workspace Member
Get Workspace Member
List Workspace Members
Update Workspace Member
Delete Workspace Member
Rate Limits
Service Accounts
API Keys
External Keys
Usage Report
Cost Report
Analytics
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [Workspaces](https://platform.claude.com/docs/en/api/http/admin/workspaces)
4. [Members](https://platform.claude.com/docs/en/api/http/admin/workspaces/members)
# Delete Workspace Member
DELETE/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Delete Workspace Member
##### Path parameters
workspace_id: string
ID of the Workspace.
user_id: string
ID of the User.
##### Returns
type: "workspace_member_deleted"
Deleted object type.
For Workspace Members, this is always `"workspace_member_deleted"`.
defaultworkspace_member_deleted
user_id: string
ID of the User.
workspace_id: string
ID of the Workspace.
Delete Workspace Member
cURL
```python
curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members/$USER_ID \
-X DELETE \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
```
Response 200
```python
{
"type": "workspace_member_deleted",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"
}
```
##### Returns Examples
Response 200
```python
{
"type": "workspace_member_deleted",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"
---
## List Workspace Members - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/workspaces/members/list
Path: 04-API-Reference/Admin/admin-workspaces-members-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Fworkspaces%2Fmembers%2Flist)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
Create Workspace
Get Workspace
List Workspaces
Update Workspace
Archive Workspace
Members
Create Workspace Member
Get Workspace Member
List Workspace Members
Update Workspace Member
Delete Workspace Member
Rate Limits
Service Accounts
API Keys
External Keys
Usage Report
Cost Report
Analytics
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [Workspaces](https://platform.claude.com/docs/en/api/http/admin/workspaces)
4. [Members](https://platform.claude.com/docs/en/api/http/admin/workspaces/members)
# List Workspace Members
GET/v1/organizations/workspaces/{workspace_id}/members
List Workspace Members
##### Path parameters
workspace_id: string
ID of the Workspace.
##### Query parameters
after_id: optional string
ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object.
before_id: optional string
ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object.
limit: optional number
Number of items to return per page.
Defaults to `20`. Ranges from `1` to `1000`.
default20
maximum1000
minimum1
##### Returns
data: array of [WorkspaceMember](https://platform.claude.com/docs/en/api/http/admin/workspaces/members#workspaceMember) { type, user_id, workspace_id, workspace_role }
type: "workspace_member"
Object type.
For Workspace Members, this is always `"workspace_member"`.
defaultworkspace_member
user_id: string
ID of the User.
workspace_id: string
ID of the Workspace.
workspace_role: "workspace_admin" or "workspace_billing" or "workspace_developer" or 2 more
Role of the Workspace Member.
One of the following:
"workspace_admin"
"workspace_billing"
"workspace_developer"
"workspace_restricted_developer"
"workspace_user"
first_id: string or null
First ID in the `data` list. Can be used as the `before_id` for the previous page.
has_more: boolean
Indicates if there are more results in the requested page direction.
last_id: string or null
Last ID in the `data` list. Can be used as the `after_id` for the next page.
List Workspace Members
cURL
```python
curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
```
Response 200
```python
{
"data": [
{
"type": "workspace_member",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ",
"workspace_role": "workspace_user"
}
],
"first_id": "first_id",
"has_more": true,
"last_id": "last_id"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"type": "workspace_member",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ",
"workspace_role": "workspace_user"
---
## Get Workspace Member - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/workspaces/members/retrieve
Path: 04-API-Reference/Admin/admin-workspaces-members-retrieve.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Fworkspaces%2Fmembers%2Fretrieve)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
Create Workspace
Get Workspace
List Workspaces
Update Workspace
Archive Workspace
Members
Create Workspace Member
Get Workspace Member
List Workspace Members
Update Workspace Member
Delete Workspace Member
Rate Limits
Service Accounts
API Keys
External Keys
Usage Report
Cost Report
Analytics
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [Workspaces](https://platform.claude.com/docs/en/api/http/admin/workspaces)
4. [Members](https://platform.claude.com/docs/en/api/http/admin/workspaces/members)
# Get Workspace Member
GET/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Get Workspace Member
##### Path parameters
workspace_id: string
ID of the Workspace.
user_id: string
ID of the User.
##### Returns
WorkspaceMember object{ type, user_id, workspace_id, workspace_role }
type: "workspace_member"
Object type.
For Workspace Members, this is always `"workspace_member"`.
defaultworkspace_member
user_id: string
ID of the User.
workspace_id: string
ID of the Workspace.
workspace_role: "workspace_admin" or "workspace_billing" or "workspace_developer" or 2 more
Role of the Workspace Member.
One of the following:
"workspace_admin"
"workspace_billing"
"workspace_developer"
"workspace_restricted_developer"
"workspace_user"
Get Workspace Member
cURL
```python
curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members/$USER_ID \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
```
Response 200
```python
{
"type": "workspace_member",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ",
"workspace_role": "workspace_user"
}
```
##### Returns Examples
Response 200
```python
{
"type": "workspace_member",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ",
"workspace_role": "workspace_user"
---
## Update Workspace Member - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/workspaces/members/update
Path: 04-API-Reference/Admin/admin-workspaces-members-update.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Fworkspaces%2Fmembers%2Fupdate)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
Create Workspace
Get Workspace
List Workspaces
Update Workspace
Archive Workspace
Members
Create Workspace Member
Get Workspace Member
List Workspace Members
Update Workspace Member
Delete Workspace Member
Rate Limits
Service Accounts
API Keys
External Keys
Usage Report
Cost Report
Analytics
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [Workspaces](https://platform.claude.com/docs/en/api/http/admin/workspaces)
4. [Members](https://platform.claude.com/docs/en/api/http/admin/workspaces/members)
# Update Workspace Member
POST/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Update Workspace Member
##### Path parameters
workspace_id: string
ID of the Workspace.
user_id: string
ID of the User.
##### Body
workspace_role: "workspace_admin" or "workspace_billing" or "workspace_developer" or 2 more
New workspace role for the User.
One of the following:
"workspace_admin"
"workspace_billing"
"workspace_developer"
"workspace_restricted_developer"
"workspace_user"
##### Returns
WorkspaceMember object{ type, user_id, workspace_id, workspace_role }
type: "workspace_member"
Object type.
For Workspace Members, this is always `"workspace_member"`.
defaultworkspace_member
user_id: string
ID of the User.
workspace_id: string
ID of the Workspace.
workspace_role: "workspace_admin" or "workspace_billing" or "workspace_developer" or 2 more
Role of the Workspace Member.
One of the following:
"workspace_admin"
"workspace_billing"
"workspace_developer"
"workspace_restricted_developer"
"workspace_user"
Update Workspace Member
cURL
```python
curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members/$USER_ID \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN" \
-d '{
"workspace_role": "workspace_admin"
}'
```
Response 200
```python
{
"type": "workspace_member",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ",
"workspace_role": "workspace_user"
}
```
##### Returns Examples
Response 200
```python
{
"type": "workspace_member",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ",
"workspace_role": "workspace_user"
---
## Members - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/workspaces/members
Path: 04-API-Reference/Admin/admin-workspaces-members.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Fworkspaces%2Fmembers)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
Create Workspace
Get Workspace
List Workspaces
Update Workspace
Archive Workspace
Members
Create Workspace Member
Get Workspace Member
List Workspace Members
Update Workspace Member
Delete Workspace Member
Rate Limits
Service Accounts
API Keys
External Keys
Usage Report
Cost Report
Analytics
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [Workspaces](https://platform.claude.com/docs/en/api/http/admin/workspaces)
# Members
##### [Create Workspace Member](https://platform.claude.com/docs/en/api/http/admin/workspaces/members/create)
POST/v1/organizations/workspaces/{workspace_id}/members
##### [Get Workspace Member](https://platform.claude.com/docs/en/api/http/admin/workspaces/members/retrieve)
GET/v1/organizations/workspaces/{workspace_id}/members/{user_id}
##### [List Workspace Members](https://platform.claude.com/docs/en/api/http/admin/workspaces/members/list)
GET/v1/organizations/workspaces/{workspace_id}/members
##### [Update Workspace Member](https://platform.claude.com/docs/en/api/http/admin/workspaces/members/update)
POST/v1/organizations/workspaces/{workspace_id}/members/{user_id}
##### [Delete Workspace Member](https://platform.claude.com/docs/en/api/http/admin/workspaces/members/delete)
DELETE/v1/organizations/workspaces/{workspace_id}/members/{user_id}
##### Models
WorkspaceMember object{ type, user_id, workspace_id, workspace_role }
type: "workspace_member"
Object type.
For Workspace Members, this is always `"workspace_member"`.
defaultworkspace_member
user_id: string
ID of the User.
workspace_id: string
ID of the Workspace.
workspace_role: "workspace_admin" or "workspace_billing" or "workspace_developer" or 2 more
Role of the Workspace Member.
One of the following:
"workspace_admin"
"workspace_billing"
"workspace_developer"
"workspace_restricted_developer"
"workspace_user"
MemberDeleteResponse object{ type, user_id, workspace_id }
type: "workspace_member_deleted"
Deleted object type.
For Workspace Members, this is always `"workspace_member_deleted"`.
defaultworkspace_member_deleted
user_id: string
ID of the User.
workspace_id: string
ID of the Workspace.
---
## List Workspace Rate Limits - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/workspaces/rate_limits/list
Path: 04-API-Reference/Admin/admin-workspaces-rate-limits-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Fworkspaces%2Frate_limits%2Flist)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
Create Workspace
Get Workspace
List Workspaces
Update Workspace
Archive Workspace
Members
Rate Limits
List Workspace Rate Limits
Service Accounts
API Keys
External Keys
Usage Report
Cost Report
Analytics
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [Workspaces](https://platform.claude.com/docs/en/api/http/admin/workspaces)
4. [Rate Limits](https://platform.claude.com/docs/en/api/http/admin/workspaces/rate_limits)
# List Workspace Rate Limits
GET/v1/organizations/workspaces/{workspace_id}/rate_limits
List rate-limit overrides configured for a workspace.
Returns only the groups and limiter types that have a workspace-level override. Groups without overrides inherit the organization limits and are not listed; use `GET /v1/organizations/rate_limits` to see those.
When `limit` is omitted, every matching entry is returned in a single page; when `limit` truncates the result, follow `next_page` to fetch the remaining entries.
##### Path parameters
workspace_id: string
The ID of the workspace.
##### Query parameters
group_type: optional "batch" or "files" or "model_group" or 3 more
Filter by group type.
One of the following:
"batch"
"files"
"model_group"
"skills"
"token_count"
"web_search"
limit: optional number
Maximum number of items to return per page. Ranges from `1` to `1000`.
When omitted, every remaining entry is returned in a single page and `next_page` is `null`.
maximum1000
minimum1
page: optional string
Opaque cursor from a previous response's `next_page`.
##### Returns
data: array of object{ group_type, limits, models, 3 more }
Rate-limit entries for the workspace, one per group that has at least one override.
group_type: "batch" or "files" or "model_group" or 3 more
The kind of rate-limit group this entry represents. `model_group` entries apply to a family of models (listed in `models`); other values apply to an API-surface category and have `models` set to `null`.
One of the following:
"batch"
"files"
"model_group"
"skills"
"token_count"
"web_search"
limits: array of object{ org_limit, type, value }
The limiter values overridden for this group in this workspace. Limiter types without a workspace override are omitted and inherit the organization value.
org_limit: number or null
The organization-level value for the same limiter type, for reference. `null` when the organization has no limit configured for this limiter type.
type: string
The limiter type (for example, `requests_per_minute` or `input_tokens_per_minute`).
value: number
The workspace-level override value for this limiter type.
models: array of string or null
Model names this entry's limits apply to, including aliases. `null` when `group_type` is not `"model_group"`.
rate_limit_id: string
The `id` of the RateLimit group this override applies to.
type: "workspace_rate_limit"
Object type. Always `workspace_rate_limit` for workspace rate-limit entries.
defaultworkspace_rate_limit
workspace_id: string
ID of the Workspace this override applies to.
next_page: string or null
Opaque cursor for the next page of results, or `null` when no entries remain beyond this response.
List Workspace Rate Limits
cURL
```python
curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/rate_limits \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
```
Response 200
```python
{
"data": [
{
"group_type": "batch",
"limits": [
{
"org_limit": 0,
"type": "type",
"value": 0
}
],
"models": [
"string"
],
"rate_limit_id": "rate_limit_id",
"type": "workspace_rate_limit",
"workspace_id": "workspace_id"
}
],
"next_page": "next_page"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"group_type": "batch",
"limits": [
{
"org_limit": 0,
"type": "type",
"value": 0
}
],
"models": [
"string"
],
"rate_limit_id": "rate_limit_id",
"type": "workspace_rate_limit",
"workspace_id": "workspace_id"
---
## Rate Limits - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/workspaces/rate_limits
Path: 04-API-Reference/Admin/admin-workspaces-rate-limits.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Fworkspaces%2Frate_limits)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
Create Workspace
Get Workspace
List Workspaces
Update Workspace
Archive Workspace
Members
Rate Limits
List Workspace Rate Limits
Service Accounts
API Keys
External Keys
Usage Report
Cost Report
Analytics
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [Workspaces](https://platform.claude.com/docs/en/api/http/admin/workspaces)
# Rate Limits
##### [List Workspace Rate Limits](https://platform.claude.com/docs/en/api/http/admin/workspaces/rate_limits/list)
GET/v1/organizations/workspaces/{workspace_id}/rate_limits
##### Models
RateLimitListResponse object{ group_type, limits, models, 3 more }
---
## Get Workspace - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/workspaces/retrieve
Path: 04-API-Reference/Admin/admin-workspaces-retrieve.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Fworkspaces%2Fretrieve)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
Create Workspace
Get Workspace
List Workspaces
Update Workspace
Archive Workspace
Members
Rate Limits
Service Accounts
API Keys
External Keys
Usage Report
Cost Report
Analytics
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [Workspaces](https://platform.claude.com/docs/en/api/http/admin/workspaces)
# Get Workspace
GET/v1/organizations/workspaces/{workspace_id}
Get Workspace
##### Path parameters
workspace_id: string
ID of the Workspace.
##### Returns
Workspace object{ id, archived_at, compartment_id, 7 more }
Get Workspace
cURL
```python
curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
```
Response 200
```python
{
"id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ",
"archived_at": "2024-11-01T23:59:27.427722Z",
"compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c",
"created_at": "2024-10-30T23:58:27.427722Z",
"data_residency": {
"allowed_inference_geos": "unrestricted",
"default_inference_geo": "default_inference_geo",
"workspace_geo": "workspace_geo"
},
"display_color": "#6C5BB9",
"external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK",
"name": "Workspace Name",
"tags": {
"env": "prod",
"team": "platform"
},
"type": "workspace"
}
```
##### Returns Examples
Response 200
```python
{
"id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ",
"archived_at": "2024-11-01T23:59:27.427722Z",
"compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c",
"created_at": "2024-10-30T23:58:27.427722Z",
"data_residency": {
"allowed_inference_geos": "unrestricted",
"default_inference_geo": "default_inference_geo",
"workspace_geo": "workspace_geo"
},
"display_color": "#6C5BB9",
"external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK",
---
## Create Service Account Workspace Member - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/workspaces/service_accounts/create
Path: 04-API-Reference/Admin/admin-workspaces-service-accounts-create.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Fworkspaces%2Fservice_accounts%2Fcreate)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
Create Workspace
Get Workspace
List Workspaces
Update Workspace
Archive Workspace
Members
Rate Limits
Service Accounts
Create Service Account Workspace Member
Get Service Account Workspace Member
List Service Account Workspace Members
Update Service Account Workspace Member
Delete Service Account Workspace Member
API Keys
External Keys
Usage Report
Cost Report
Analytics
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [Workspaces](https://platform.claude.com/docs/en/api/http/admin/workspaces)
4. [Service Accounts](https://platform.claude.com/docs/en/api/http/admin/workspaces/service_accounts)
# Create Service Account Workspace Member
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](../Other/manage-claude-wif-admin-api.md).
Add a service account to a workspace with the given `workspace_role`.
The role determines what the service account can do in the workspace and which workspace-scoped permissions it can be granted when authenticating through federation. Every service account is already an implicit `workspace_user` member of the default workspace; adding it explicitly assigns a chosen role. If the service account is already an explicit member of the workspace, its `workspace_role` is replaced with the value supplied here. Archived workspaces return 400. Archived service accounts cannot be added and are rejected.
##### Path parameters
workspace_id: string
ID of the workspace.
##### Headers
"anthropic-beta": optional array of string
Optional header to specify the beta version(s) you want to use.
To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta.
##### Body
service_account_id: string
Tagged service account ID to add.
workspace_role: "workspace_admin" or "workspace_developer" or "workspace_restricted_developer" or "workspace_user"
Role to assign to the service account in this workspace.
One of the following:
"workspace_admin"
"workspace_developer"
"workspace_restricted_developer"
"workspace_user"
##### Returns
created_by_actor_id: string or null
Tagged ID (`user_...`/`svac_...`) of the actor who created this membership.
implicit: boolean or null
True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed.
service_account_id: string
Tagged service account ID (`svac_...`).
type: "service_account_workspace_member"
defaultservice_account_workspace_member
workspace_id: string
Tagged workspace ID (`wrkspc_...`).
workspace_role: "workspace_admin" or "workspace_billing" or "workspace_developer" or 2 more
Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role.
One of the following:
"workspace_admin"
"workspace_billing"
"workspace_developer"
"workspace_restricted_developer"
"workspace_user"
Create Service Account Workspace Member
cURL
```python
curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/service_accounts \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN" \
-d '{
"service_account_id": "service_account_id",
"workspace_role": "workspace_admin"
}'
```
Response 200
```python
{
"created_by_actor_id": "created_by_actor_id",
"implicit": true,
"service_account_id": "service_account_id",
"type": "service_account_workspace_member",
"workspace_id": "workspace_id",
"workspace_role": "workspace_admin"
}
```
##### Returns Examples
Response 200
```python
{
"created_by_actor_id": "created_by_actor_id",
"implicit": true,
"service_account_id": "service_account_id",
"type": "service_account_workspace_member",
"workspace_id": "workspace_id",
"workspace_role": "workspace_admin"
---
## Delete Service Account Workspace Member - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/workspaces/service_accounts/delete
Path: 04-API-Reference/Admin/admin-workspaces-service-accounts-delete.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Fworkspaces%2Fservice_accounts%2Fdelete)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
Create Workspace
Get Workspace
List Workspaces
Update Workspace
Archive Workspace
Members
Rate Limits
Service Accounts
Create Service Account Workspace Member
Get Service Account Workspace Member
List Service Account Workspace Members
Update Service Account Workspace Member
Delete Service Account Workspace Member
API Keys
External Keys
Usage Report
Cost Report
Analytics
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [Workspaces](https://platform.claude.com/docs/en/api/http/admin/workspaces)
4. [Service Accounts](https://platform.claude.com/docs/en/api/http/admin/workspaces/service_accounts)
# Delete Service Account Workspace Member
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](../Other/manage-claude-wif-admin-api.md).
Remove a service account from a workspace.
Removal is idempotent (returns 200 even if the membership was already removed). A DELETE against the implicit default-workspace membership returns 200 but is a no-op and the membership persists; deleting an explicit default-workspace row reverts to the implicit `workspace_user` membership. Archived workspaces return 400.
##### Path parameters
workspace_id: string
ID of the workspace.
service_account_id: string
ID of the service account.
##### Headers
"anthropic-beta": optional array of string
Optional header to specify the beta version(s) you want to use.
To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta.
##### Returns
service_account_id: string
Tagged service account ID (`svac_...`) named in the delete request. Removal is idempotent; see the endpoint description for the implicit-membership no-op.
type: "service_account_workspace_member_deleted"
defaultservice_account_workspace_member_deleted
workspace_id: string
Tagged workspace ID (`wrkspc_...`) named in the delete request.
Delete Service Account Workspace Member
cURL
```python
curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/service_accounts/$SERVICE_ACCOUNT_ID \
-X DELETE \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
```
Response 200
```python
{
"service_account_id": "service_account_id",
"type": "service_account_workspace_member_deleted",
"workspace_id": "workspace_id"
}
```
##### Returns Examples
Response 200
```python
{
"service_account_id": "service_account_id",
"type": "service_account_workspace_member_deleted",
"workspace_id": "workspace_id"
---
## List Service Account Workspace Members - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/workspaces/service_accounts/list
Path: 04-API-Reference/Admin/admin-workspaces-service-accounts-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Fworkspaces%2Fservice_accounts%2Flist)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
Create Workspace
Get Workspace
List Workspaces
Update Workspace
Archive Workspace
Members
Rate Limits
Service Accounts
Create Service Account Workspace Member
Get Service Account Workspace Member
List Service Account Workspace Members
Update Service Account Workspace Member
Delete Service Account Workspace Member
API Keys
External Keys
Usage Report
Cost Report
Analytics
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [Workspaces](https://platform.claude.com/docs/en/api/http/admin/workspaces)
4. [Service Accounts](https://platform.claude.com/docs/en/api/http/admin/workspaces/service_accounts)
# List Service Account Workspace Members
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](../Other/manage-claude-wif-admin-api.md).
List the service accounts that are members of a workspace.
Each entry includes the service account's `workspace_role`. Use `limit` and the `next_page` cursor to paginate. Archived workspaces return 400; use `GET /service_accounts/{id}/workspaces` to audit memberships of an archived workspace. The implicit default-workspace membership is not included in this list. Memberships of archived service accounts are omitted from the results.
##### Path parameters
workspace_id: string
ID of the workspace.
##### Query parameters
limit: optional number
Number of results per page.
default20
maximum100
minimum1
page: optional string
Opaque cursor from a previous response's `next_page`.
##### Headers
"anthropic-beta": optional array of string
Optional header to specify the beta version(s) you want to use.
To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta.
##### Returns
data: array of object{ created_by_actor_id, implicit, service_account_id, 3 more }
created_by_actor_id: string or null
Tagged ID (`user_...`/`svac_...`) of the actor who created this membership.
implicit: boolean or null
True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed.
service_account_id: string
Tagged service account ID (`svac_...`).
type: "service_account_workspace_member"
defaultservice_account_workspace_member
workspace_id: string
Tagged workspace ID (`wrkspc_...`).
workspace_role: "workspace_admin" or "workspace_billing" or "workspace_developer" or 2 more
Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role.
One of the following:
"workspace_admin"
"workspace_billing"
"workspace_developer"
"workspace_restricted_developer"
"workspace_user"
next_page: string or null
Opaque cursor for the next page, or null if no more results.
List Service Account Workspace Members
cURL
```python
curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/service_accounts \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
```
Response 200
```python
{
"data": [
{
"created_by_actor_id": "created_by_actor_id",
"implicit": true,
"service_account_id": "service_account_id",
"type": "service_account_workspace_member",
"workspace_id": "workspace_id",
"workspace_role": "workspace_admin"
}
],
"next_page": "next_page"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"created_by_actor_id": "created_by_actor_id",
"implicit": true,
"service_account_id": "service_account_id",
"type": "service_account_workspace_member",
"workspace_id": "workspace_id",
"workspace_role": "workspace_admin"
---
## Get Service Account Workspace Member - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/workspaces/service_accounts/retrieve
Path: 04-API-Reference/Admin/admin-workspaces-service-accounts-retrieve.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Fworkspaces%2Fservice_accounts%2Fretrieve)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
Create Workspace
Get Workspace
List Workspaces
Update Workspace
Archive Workspace
Members
Rate Limits
Service Accounts
Create Service Account Workspace Member
Get Service Account Workspace Member
List Service Account Workspace Members
Update Service Account Workspace Member
Delete Service Account Workspace Member
API Keys
External Keys
Usage Report
Cost Report
Analytics
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [Workspaces](https://platform.claude.com/docs/en/api/http/admin/workspaces)
4. [Service Accounts](https://platform.claude.com/docs/en/api/http/admin/workspaces/service_accounts)
# Get Service Account Workspace Member
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](../Other/manage-claude-wif-admin-api.md).
Retrieve a service account's membership in a workspace.
Returns the membership record, including the service account's `workspace_role` in this workspace. Archived workspaces return 400. For the default workspace, returns the implicit (`implicit: true`) membership when no explicit membership exists; an explicitly added membership is returned with its assigned role. An archived service account returns 404.
##### Path parameters
workspace_id: string
ID of the workspace.
service_account_id: string
ID of the service account.
##### Headers
"anthropic-beta": optional array of string
Optional header to specify the beta version(s) you want to use.
To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta.
##### Returns
created_by_actor_id: string or null
Tagged ID (`user_...`/`svac_...`) of the actor who created this membership.
implicit: boolean or null
True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed.
service_account_id: string
Tagged service account ID (`svac_...`).
type: "service_account_workspace_member"
defaultservice_account_workspace_member
workspace_id: string
Tagged workspace ID (`wrkspc_...`).
workspace_role: "workspace_admin" or "workspace_billing" or "workspace_developer" or 2 more
Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role.
One of the following:
"workspace_admin"
"workspace_billing"
"workspace_developer"
"workspace_restricted_developer"
"workspace_user"
Get Service Account Workspace Member
cURL
```python
curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/service_accounts/$SERVICE_ACCOUNT_ID \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
```
Response 200
```python
{
"created_by_actor_id": "created_by_actor_id",
"implicit": true,
"service_account_id": "service_account_id",
"type": "service_account_workspace_member",
"workspace_id": "workspace_id",
"workspace_role": "workspace_admin"
}
```
##### Returns Examples
Response 200
```python
{
"created_by_actor_id": "created_by_actor_id",
"implicit": true,
"service_account_id": "service_account_id",
"type": "service_account_workspace_member",
"workspace_id": "workspace_id",
"workspace_role": "workspace_admin"
---
## Update Service Account Workspace Member - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/workspaces/service_accounts/update
Path: 04-API-Reference/Admin/admin-workspaces-service-accounts-update.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Fworkspaces%2Fservice_accounts%2Fupdate)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
Create Workspace
Get Workspace
List Workspaces
Update Workspace
Archive Workspace
Members
Rate Limits
Service Accounts
Create Service Account Workspace Member
Get Service Account Workspace Member
List Service Account Workspace Members
Update Service Account Workspace Member
Delete Service Account Workspace Member
API Keys
External Keys
Usage Report
Cost Report
Analytics
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [Workspaces](https://platform.claude.com/docs/en/api/http/admin/workspaces)
4. [Service Accounts](https://platform.claude.com/docs/en/api/http/admin/workspaces/service_accounts)
# Update Service Account Workspace Member
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](../Other/manage-claude-wif-admin-api.md).
Change a service account's role in a workspace.
The new `workspace_role` replaces the current one. Only explicit memberships can be updated; to set a role on the implicit default-workspace membership, add the service account explicitly with `POST /workspaces/{workspace_id}/service_accounts`. Archived workspaces return 400. Archived service accounts cannot be updated and are rejected.
##### Path parameters
workspace_id: string
ID of the workspace.
service_account_id: string
ID of the service account.
##### Headers
"anthropic-beta": optional array of string
Optional header to specify the beta version(s) you want to use.
To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta.
##### Body
workspace_role: "workspace_admin" or "workspace_developer" or "workspace_restricted_developer" or "workspace_user"
New role for the service account in this workspace.
One of the following:
"workspace_admin"
"workspace_developer"
"workspace_restricted_developer"
"workspace_user"
##### Returns
created_by_actor_id: string or null
Tagged ID (`user_...`/`svac_...`) of the actor who created this membership.
implicit: boolean or null
True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed.
service_account_id: string
Tagged service account ID (`svac_...`).
type: "service_account_workspace_member"
defaultservice_account_workspace_member
workspace_id: string
Tagged workspace ID (`wrkspc_...`).
workspace_role: "workspace_admin" or "workspace_billing" or "workspace_developer" or 2 more
Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role.
One of the following:
"workspace_admin"
"workspace_billing"
"workspace_developer"
"workspace_restricted_developer"
"workspace_user"
Update Service Account Workspace Member
cURL
```python
curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/service_accounts/$SERVICE_ACCOUNT_ID \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN" \
-d '{
"workspace_role": "workspace_admin"
}'
```
Response 200
```python
{
"created_by_actor_id": "created_by_actor_id",
"implicit": true,
"service_account_id": "service_account_id",
"type": "service_account_workspace_member",
"workspace_id": "workspace_id",
"workspace_role": "workspace_admin"
}
```
##### Returns Examples
Response 200
```python
{
"created_by_actor_id": "created_by_actor_id",
"implicit": true,
"service_account_id": "service_account_id",
"type": "service_account_workspace_member",
"workspace_id": "workspace_id",
"workspace_role": "workspace_admin"
---
## Service Accounts - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/workspaces/service_accounts
Path: 04-API-Reference/Admin/admin-workspaces-service-accounts.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Fworkspaces%2Fservice_accounts)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
Create Workspace
Get Workspace
List Workspaces
Update Workspace
Archive Workspace
Members
Rate Limits
Service Accounts
Create Service Account Workspace Member
Get Service Account Workspace Member
List Service Account Workspace Members
Update Service Account Workspace Member
Delete Service Account Workspace Member
API Keys
External Keys
Usage Report
Cost Report
Analytics
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [Workspaces](https://platform.claude.com/docs/en/api/http/admin/workspaces)
# Service Accounts
##### [Create Service Account Workspace Member](https://platform.claude.com/docs/en/api/http/admin/workspaces/service_accounts/create)
POST/v1/organizations/workspaces/{workspace_id}/service_accounts
##### [Get Service Account Workspace Member](https://platform.claude.com/docs/en/api/http/admin/workspaces/service_accounts/retrieve)
GET/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}
##### [List Service Account Workspace Members](https://platform.claude.com/docs/en/api/http/admin/workspaces/service_accounts/list)
GET/v1/organizations/workspaces/{workspace_id}/service_accounts
##### [Update Service Account Workspace Member](https://platform.claude.com/docs/en/api/http/admin/workspaces/service_accounts/update)
POST/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}
##### [Delete Service Account Workspace Member](https://platform.claude.com/docs/en/api/http/admin/workspaces/service_accounts/delete)
DELETE/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}
##### Models
ServiceAccountCreateResponse object{ created_by_actor_id, implicit, service_account_id, 3 more }
created_by_actor_id: string or null
Tagged ID (`user_...`/`svac_...`) of the actor who created this membership.
implicit: boolean or null
True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed.
service_account_id: string
Tagged service account ID (`svac_...`).
type: "service_account_workspace_member"
defaultservice_account_workspace_member
workspace_id: string
Tagged workspace ID (`wrkspc_...`).
workspace_role: "workspace_admin" or "workspace_billing" or "workspace_developer" or 2 more
Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role.
One of the following:
"workspace_admin"
"workspace_billing"
"workspace_developer"
"workspace_restricted_developer"
"workspace_user"
ServiceAccountRetrieveResponse object{ created_by_actor_id, implicit, service_account_id, 3 more }
ServiceAccountUpdateResponse object{ created_by_actor_id, implicit, service_account_id, 3 more }
created_by_actor_id: string or null
Tagged ID (`user_...`/`svac_...`) of the actor who created this membership.
implicit: boolean or null
True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed.
service_account_id: string
Tagged service account ID (`svac_...`).
type: "service_account_workspace_member"
defaultservice_account_workspace_member
workspace_id: string
Tagged workspace ID (`wrkspc_...`).
workspace_role: "workspace_admin" or "workspace_billing" or "workspace_developer" or 2 more
Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role.
One of the following:
"workspace_admin"
"workspace_billing"
"workspace_developer"
"workspace_restricted_developer"
"workspace_user"
ServiceAccountListResponse object{ created_by_actor_id, implicit, service_account_id, 3 more }
created_by_actor_id: string or null
Tagged ID (`user_...`/`svac_...`) of the actor who created this membership.
implicit: boolean or null
True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed.
service_account_id: string
Tagged service account ID (`svac_...`).
type: "service_account_workspace_member"
defaultservice_account_workspace_member
workspace_id: string
Tagged workspace ID (`wrkspc_...`).
workspace_role: "workspace_admin" or "workspace_billing" or "workspace_developer" or 2 more
Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role.
One of the following:
"workspace_admin"
"workspace_billing"
"workspace_developer"
"workspace_restricted_developer"
"workspace_user"
ServiceAccountDeleteResponse object{ service_account_id, type, workspace_id }
service_account_id: string
Tagged service account ID (`svac_...`) named in the delete request. Removal is idempotent; see the endpoint description for the implicit-membership no-op.
type: "service_account_workspace_member_deleted"
defaultservice_account_workspace_member_deleted
workspace_id: string
Tagged workspace ID (`wrkspc_...`) named in the delete request.
---
## Update Workspace - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/workspaces/update
Path: 04-API-Reference/Admin/admin-workspaces-update.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Fworkspaces%2Fupdate)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
Create Workspace
Get Workspace
List Workspaces
Update Workspace
Archive Workspace
Members
Rate Limits
Service Accounts
API Keys
External Keys
Usage Report
Cost Report
Analytics
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [Workspaces](https://platform.claude.com/docs/en/api/http/admin/workspaces)
# Update Workspace
POST/v1/organizations/workspaces/{workspace_id}
Update Workspace
##### Path parameters
workspace_id: string
##### Body
data_residency: optional object{ allowed_inference_geos, default_inference_geo } or null
Data residency configuration for the workspace.
allowed_inference_geos: optional array of "global" or "us" or "unrestricted" or null
Permitted inference geo values. Use 'unrestricted' to allow all geos, or a list of specific geos.
One of the following:
array of "global" or "us"
One of the following:
"global"
"us"
"unrestricted"
default_inference_geo: optional "global" or "us" or null
Default inference geo applied when requests omit the parameter. Must be a member of `allowed_inference_geos` unless `allowed_inference_geos` is `"unrestricted"`.
One of the following:
"global"
"us"
display_color: optional string
Hex color code representing the Workspace in the Anthropic Console.
maxLength7
pattern^#\[0-9A-Fa-f\]{6}\$
external_key_id: optional string
ID of the customer-managed encryption key (CMEK) configuration to use for this Workspace. Setting this field requires CMEK to be enabled for your organization. When set, data stored for this Workspace is encrypted with the referenced key. Create key configurations with the External Keys API. On Claude Platform on AWS the value is the AWS KMS key ARN, and the key must be a single-Region key in the same AWS account and Region as the Workspace. On that platform the key is validated against this Workspace when it is attached, so a key-policy problem is reported as an error on this request. This field is write-once: once a key is attached to a Workspace it cannot be detached or replaced. To rotate key material, rotate the underlying key on your cloud KMS; the `external_key_id` stays the same.
name: optional string
Name of the Workspace.
maxLength40
minLength1
tags: optional map\[string\] or null
User-defined tags as string key-value pairs. Keys may not begin with `anthropic`.
##### Returns
Workspace object{ id, archived_at, compartment_id, 7 more }
Update Workspace
cURL
```python
curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN" \
-d '{
"display_color": "#6C5BB9",
"external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK",
"tags": {
"env": "prod",
"team": "platform"
}
}'
```
Response 200
```python
{
"id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ",
"archived_at": "2024-11-01T23:59:27.427722Z",
"compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c",
"created_at": "2024-10-30T23:58:27.427722Z",
"data_residency": {
"allowed_inference_geos": "unrestricted",
"default_inference_geo": "default_inference_geo",
"workspace_geo": "workspace_geo"
},
"display_color": "#6C5BB9",
"external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK",
"name": "Workspace Name",
"tags": {
"env": "prod",
"team": "platform"
},
"type": "workspace"
}
```
##### Returns Examples
Response 200
```python
{
"id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ",
"archived_at": "2024-11-01T23:59:27.427722Z",
"compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c",
"created_at": "2024-10-30T23:58:27.427722Z",
"data_residency": {
"allowed_inference_geos": "unrestricted",
"default_inference_geo": "default_inference_geo",
"workspace_geo": "workspace_geo"
},
"display_color": "#6C5BB9",
"external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK",
---
## Workspaces - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/workspaces
Path: 04-API-Reference/Admin/admin-workspaces.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fadmin%2Fworkspaces)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
Create Workspace
Get Workspace
List Workspaces
Update Workspace
Archive Workspace
Members
Rate Limits
Service Accounts
API Keys
External Keys
Usage Report
Cost Report
Analytics
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
# Workspaces
##### [Create Workspace](https://platform.claude.com/docs/en/api/http/admin/workspaces/create)
POST/v1/organizations/workspaces
##### [Get Workspace](https://platform.claude.com/docs/en/api/http/admin/workspaces/retrieve)
GET/v1/organizations/workspaces/{workspace_id}
##### [List Workspaces](https://platform.claude.com/docs/en/api/http/admin/workspaces/list)
GET/v1/organizations/workspaces
##### [Update Workspace](https://platform.claude.com/docs/en/api/http/admin/workspaces/update)
POST/v1/organizations/workspaces/{workspace_id}
##### [Archive Workspace](https://platform.claude.com/docs/en/api/http/admin/workspaces/archive)
POST/v1/organizations/workspaces/{workspace_id}/archive
#### Workspaces[Members](https://platform.claude.com/docs/en/api/http/admin/workspaces/members)
##### [Create Workspace Member](https://platform.claude.com/docs/en/api/http/admin/workspaces/members/create)
POST/v1/organizations/workspaces/{workspace_id}/members
##### [Get Workspace Member](https://platform.claude.com/docs/en/api/http/admin/workspaces/members/retrieve)
GET/v1/organizations/workspaces/{workspace_id}/members/{user_id}
##### [List Workspace Members](https://platform.claude.com/docs/en/api/http/admin/workspaces/members/list)
GET/v1/organizations/workspaces/{workspace_id}/members
##### [Update Workspace Member](https://platform.claude.com/docs/en/api/http/admin/workspaces/members/update)
POST/v1/organizations/workspaces/{workspace_id}/members/{user_id}
##### [Delete Workspace Member](https://platform.claude.com/docs/en/api/http/admin/workspaces/members/delete)
DELETE/v1/organizations/workspaces/{workspace_id}/members/{user_id}
#### Workspaces[Rate Limits](https://platform.claude.com/docs/en/api/http/admin/workspaces/rate_limits)
##### [List Workspace Rate Limits](https://platform.claude.com/docs/en/api/http/admin/workspaces/rate_limits/list)
GET/v1/organizations/workspaces/{workspace_id}/rate_limits
#### Workspaces[Service Accounts](https://platform.claude.com/docs/en/api/http/admin/workspaces/service_accounts)
##### [Create Service Account Workspace Member](https://platform.claude.com/docs/en/api/http/admin/workspaces/service_accounts/create)
POST/v1/organizations/workspaces/{workspace_id}/service_accounts
##### [Get Service Account Workspace Member](https://platform.claude.com/docs/en/api/http/admin/workspaces/service_accounts/retrieve)
GET/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}
##### [List Service Account Workspace Members](https://platform.claude.com/docs/en/api/http/admin/workspaces/service_accounts/list)
GET/v1/organizations/workspaces/{workspace_id}/service_accounts
##### [Update Service Account Workspace Member](https://platform.claude.com/docs/en/api/http/admin/workspaces/service_accounts/update)
POST/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}
##### [Delete Service Account Workspace Member](https://platform.claude.com/docs/en/api/http/admin/workspaces/service_accounts/delete)
DELETE/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}
---
## Organization - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin
Path: 04-API-Reference/Admin/admin.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
# Organization
##### [Get Current Organization](http-beta-organization-retrieve.md)
GET/v1/organizations/me
Retrieve information about the organization associated with the authenticated API key.
##### Models
BetaOrganization object{ type: "organization", id, name }
type: "organization"
Object type.
For Organizations, this is always `"organization"`.
defaultorganization
id: string
ID of the Organization.
formatuuid
name: string
Name of the Organization.
BetaOrganizationRole = "admin" or "billing" or "claude_code_user" or 6 more
One of the following:
"admin"
"billing"
"claude_code_user"
"developer"
"managed"
"membership_admin"
"owner"
"primary_owner"
"user"
#### Organization[API Keys](https://platform.claude.com/docs/en/api/http/beta/organization/api_keys)
##### [List API Keys](https://platform.claude.com/docs/en/api/http/beta/organization/api_keys/list)
GET/v1/organizations/api_keys
##### [Retrieve API Key (Admin API)](https://platform.claude.com/docs/en/api/http/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](../Other/playground.md) in the Claude Console.
##### [Update API Key](https://platform.claude.com/docs/en/api/http/beta/organization/api_keys/update)
POST/v1/organizations/api_keys/{api_key_id}
#### Organization[External Keys](https://platform.claude.com/docs/en/api/http/beta/organization/external_keys)
##### [Create External Key](https://platform.claude.com/docs/en/api/http/beta/organization/external_keys/create)
POST/v1/organizations/external_keys
Create an external key config owned by the caller's organization.
##### [List External Keys](https://platform.claude.com/docs/en/api/http/beta/organization/external_keys/list)
GET/v1/organizations/external_keys
List external key configs in the caller's organization.
##### [Get External Key](https://platform.claude.com/docs/en/api/http/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](https://platform.claude.com/docs/en/api/http/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](https://platform.claude.com/docs/en/api/http/beta/organization/external_keys/delete)
DELETE/v1/organizations/external_keys/{external_key_id}
Delete an external key config.
##### [Validate External Key](https://platform.claude.com/docs/en/api/http/beta/organization/external_keys/validate)
POST/v1/organizations/external_keys/{external_key_id}/validate
Validate an external key config against the customer's KMS.
#### OrganizationFederation[Issuers](https://platform.claude.com/docs/en/api/http/beta/organization/federation/issuers)
##### [Create Federation Issuer](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [List Federation Issuers](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [Get Federation Issuer](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [Update Federation Issuer](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [Archive Federation Issuer](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
#### OrganizationFederation[Rules](https://platform.claude.com/docs/en/api/http/beta/organization/federation/rules)
##### [Create Federation Rule](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [List Federation Rules](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [Get Federation Rule](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [Update Federation Rule](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [Archive Federation Rule](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
#### OrganizationFederationRules[Workspaces](https://platform.claude.com/docs/en/api/http/beta/organization/federation/rules/workspaces)
##### [Add Federation Rule Workspace](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [List Federation Rule Workspaces](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [Remove Federation Rule Workspace](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
#### Organization[Invites](https://platform.claude.com/docs/en/api/http/beta/organization/invites)
##### [Create Invite](https://platform.claude.com/docs/en/api/http/beta/organization/invites/create)
POST/v1/organizations/invites
Invite a user to join the organization by email.
##### [List Invites](https://platform.claude.com/docs/en/api/http/beta/organization/invites/list)
GET/v1/organizations/invites
List the organization's invites.
##### [Get Invite](https://platform.claude.com/docs/en/api/http/beta/organization/invites/retrieve)
GET/v1/organizations/invites/{invite_id}
Retrieve an invite by ID.
##### [Delete Invite](https://platform.claude.com/docs/en/api/http/beta/organization/invites/delete)
DELETE/v1/organizations/invites/{invite_id}
Delete a pending invite.
#### Organization[Service Accounts](https://platform.claude.com/docs/en/api/http/beta/organization/service_accounts)
##### [Create Service Account](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [List Service Accounts](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [Get Service Account](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [Update Service Account](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [Archive Service Account](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
#### OrganizationService Accounts[Workspaces](https://platform.claude.com/docs/en/api/http/beta/organization/service_accounts/workspaces)
##### [Add Workspace To Service Account](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [List Workspaces For Service Account](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [Remove Workspace From Service Account](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
#### Organization[Users](https://platform.claude.com/docs/en/api/http/beta/organization/users)
##### [List Users](https://platform.claude.com/docs/en/api/http/beta/organization/users/list)
GET/v1/organizations/users
List the organization's members.
##### [Get User](https://platform.claude.com/docs/en/api/http/beta/organization/users/retrieve)
GET/v1/organizations/users/{user_id}
Retrieve a member of the organization by user ID.
##### [Update User](https://platform.claude.com/docs/en/api/http/beta/organization/users/update)
POST/v1/organizations/users/{user_id}
Update a member's organization role.
##### [Remove User](https://platform.claude.com/docs/en/api/http/beta/organization/users/remove)
DELETE/v1/organizations/users/{user_id}
Remove a member from the organization.
#### Organization[Workspaces](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces)
##### [List Workspaces](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces/list)
GET/v1/organizations/workspaces
##### [Create Workspace](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces/create)
POST/v1/organizations/workspaces
##### [Get Workspace](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces/retrieve)
GET/v1/organizations/workspaces/{workspace_id}
##### [Update Workspace](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces/update)
POST/v1/organizations/workspaces/{workspace_id}
##### [Archive Workspace](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces/archive)
POST/v1/organizations/workspaces/{workspace_id}/archive
#### OrganizationWorkspaces[Rate Limits](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces/rate_limits)
##### [List Workspace Rate Limits](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces/rate_limits/list)
GET/v1/organizations/workspaces/{workspace_id}/rate_limits
List rate-limit overrides configured for a workspace.
#### OrganizationWorkspaces[Members](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces/members)
##### [List Workspace Members](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces/members/list)
GET/v1/organizations/workspaces/{workspace_id}/members
##### [Create Workspace Member](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces/members/add)
POST/v1/organizations/workspaces/{workspace_id}/members
##### [Get Workspace Member](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces/members/retrieve)
GET/v1/organizations/workspaces/{workspace_id}/members/{user_id}
##### [Update Workspace Member](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces/members/update)
POST/v1/organizations/workspaces/{workspace_id}/members/{user_id}
##### [Delete Workspace Member](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces/members/remove)
DELETE/v1/organizations/workspaces/{workspace_id}/members/{user_id}
#### OrganizationWorkspaces[Service Accounts](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces/service_accounts)
##### [List Service Account Workspace Members](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [Create Service Account Workspace Member](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [Get Service Account Workspace Member](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [Update Service Account Workspace Member](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [Delete Service Account Workspace Member](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
#### Organization[Rate Limits](https://platform.claude.com/docs/en/api/http/beta/organization/rate_limits)
##### [List Organization Rate Limits](https://platform.claude.com/docs/en/api/http/beta/organization/rate_limits/list)
GET/v1/organizations/rate_limits
List Messages API rate limits for your organization.
#### Organization[Compliance Settings](https://platform.claude.com/docs/en/api/http/beta/organization/compliance_settings)
##### [Get Compliance Settings](https://platform.claude.com/docs/en/api/http/beta/organization/compliance_settings/retrieve)
GET/v1/organizations/compliance_settings
Retrieve your organization's Compliance Settings.
##### [Update Compliance Settings](https://platform.claude.com/docs/en/api/http/beta/organization/compliance_settings/update)
POST/v1/organizations/compliance_settings
Update your organization's Compliance Settings.
#### Organization[Usage Report](https://platform.claude.com/docs/en/api/http/beta/organization/usage_report)
##### [Get Messages Usage Report](https://platform.claude.com/docs/en/api/http/beta/organization/usage_report/retrieve_messages)
GET/v1/organizations/usage_report/messages
##### [Get Claude Code Usage Report](https://platform.claude.com/docs/en/api/http/beta/organization/usage_report/retrieve_claude_code)
GET/v1/organizations/usage_report/claude_code
Retrieve daily aggregated usage metrics for Claude Code users. Enables organizations to analyze developer productivity and build custom dashboards.
#### Organization[Cost Report](https://platform.claude.com/docs/en/api/http/beta/organization/cost_report)
##### [Get Cost Report](https://platform.claude.com/docs/en/api/http/beta/organization/cost_report/retrieve)
GET/v1/organizations/cost_report
#### Organization[MCP Tunnels](https://platform.claude.com/docs/en/api/http/beta/organization/mcp_tunnels)
##### [List Tunnels](https://platform.claude.com/docs/en/api/http/beta/organization/mcp_tunnels/list)
Deprecated
GET/v1/organizations/tunnels
**Deprecated.** This Admin API endpoint is superseded by `/v1/tunnels` on the Claude API and will be removed after a migration window. New integrations should use [`/v1/tunnels`](../Endpoints/http-beta-tunnels.md) with the `anthropic-beta: mcp-tunnels-2026-06-22` header and a WIF token carrying the `workspace:manage_tunnels` scope. Existing integrations continue to work with the `mcp-tunnels-2026-05-19` header and `org:manage_tunnels` scope during the migration window.
##### [Get Tunnel](https://platform.claude.com/docs/en/api/http/beta/organization/mcp_tunnels/retrieve)
Deprecated
GET/v1/organizations/tunnels/{tunnel_id}
**Deprecated.** This Admin API endpoint is superseded by `/v1/tunnels` on the Claude API and will be removed after a migration window. New integrations should use [`/v1/tunnels`](../Endpoints/http-beta-tunnels.md) with the `anthropic-beta: mcp-tunnels-2026-06-22` header and a WIF token carrying the `workspace:manage_tunnels` scope. Existing integrations continue to work with the `mcp-tunnels-2026-05-19` header and `org:manage_tunnels` scope during the migration window.
##### [Archive Tunnel](https://platform.claude.com/docs/en/api/http/beta/organization/mcp_tunnels/archive)
Deprecated
POST/v1/organizations/tunnels/{tunnel_id}/archive
**Deprecated.** This Admin API endpoint is superseded by `/v1/tunnels` on the Claude API and will be removed after a migration window. New integrations should use [`/v1/tunnels`](../Endpoints/http-beta-tunnels.md) with the `anthropic-beta: mcp-tunnels-2026-06-22` header and a WIF token carrying the `workspace:manage_tunnels` scope. Existing integrations continue to work with the `mcp-tunnels-2026-05-19` header and `org:manage_tunnels` scope during the migration window.
##### [Reveal Tunnel Token](https://platform.claude.com/docs/en/api/http/beta/organization/mcp_tunnels/reveal_token)
Deprecated
POST/v1/organizations/tunnels/{tunnel_id}/reveal_token
**Deprecated.** This Admin API endpoint is superseded by `/v1/tunnels` on the Claude API and will be removed after a migration window. New integrations should use [`/v1/tunnels`](../Endpoints/http-beta-tunnels.md) with the `anthropic-beta: mcp-tunnels-2026-06-22` header and a WIF token carrying the `workspace:manage_tunnels` scope. Existing integrations continue to work with the `mcp-tunnels-2026-05-19` header and `org:manage_tunnels` scope during the migration window.
##### [Rotate Tunnel Token](https://platform.claude.com/docs/en/api/http/beta/organization/mcp_tunnels/rotate_token)
Deprecated
POST/v1/organizations/tunnels/{tunnel_id}/rotate_token
**Deprecated.** This Admin API endpoint is superseded by `/v1/tunnels` on the Claude API and will be removed after a migration window. New integrations should use [`/v1/tunnels`](../Endpoints/http-beta-tunnels.md) with the `anthropic-beta: mcp-tunnels-2026-06-22` header and a WIF token carrying the `workspace:manage_tunnels` scope. Existing integrations continue to work with the `mcp-tunnels-2026-05-19` header and `org:manage_tunnels` scope during the migration window.
#### OrganizationMCP Tunnels[Tunnel Certificates](https://platform.claude.com/docs/en/api/http/beta/organization/mcp_tunnels/tunnel_certificates)
##### [Create Tunnel Certificate](https://platform.claude.com/docs/en/api/http/beta/organization/mcp_tunnels/tunnel_certificates/create)
Deprecated
POST/v1/organizations/tunnels/{tunnel_id}/certificates
**Deprecated.** This Admin API endpoint is superseded by `/v1/tunnels` on the Claude API and will be removed after a migration window. New integrations should use [`/v1/tunnels`](../Endpoints/http-beta-tunnels.md) with the `anthropic-beta: mcp-tunnels-2026-06-22` header and a WIF token carrying the `workspace:manage_tunnels` scope. Existing integrations continue to work with the `mcp-tunnels-2026-05-19` header and `org:manage_tunnels` scope during the migration window.
##### [List Tunnel Certificates](https://platform.claude.com/docs/en/api/http/beta/organization/mcp_tunnels/tunnel_certificates/list)
Deprecated
GET/v1/organizations/tunnels/{tunnel_id}/certificates
**Deprecated.** This Admin API endpoint is superseded by `/v1/tunnels` on the Claude API and will be removed after a migration window. New integrations should use [`/v1/tunnels`](../Endpoints/http-beta-tunnels.md) with the `anthropic-beta: mcp-tunnels-2026-06-22` header and a WIF token carrying the `workspace:manage_tunnels` scope. Existing integrations continue to work with the `mcp-tunnels-2026-05-19` header and `org:manage_tunnels` scope during the migration window.
##### [Get Tunnel Certificate](https://platform.claude.com/docs/en/api/http/beta/organization/mcp_tunnels/tunnel_certificates/retrieve)
Deprecated
GET/v1/organizations/tunnels/{tunnel_id}/certificates/{certificate_id}
**Deprecated.** This Admin API endpoint is superseded by `/v1/tunnels` on the Claude API and will be removed after a migration window. New integrations should use [`/v1/tunnels`](../Endpoints/http-beta-tunnels.md) with the `anthropic-beta: mcp-tunnels-2026-06-22` header and a WIF token carrying the `workspace:manage_tunnels` scope. Existing integrations continue to work with the `mcp-tunnels-2026-05-19` header and `org:manage_tunnels` scope during the migration window.
##### [Archive Tunnel Certificate](https://platform.claude.com/docs/en/api/http/beta/organization/mcp_tunnels/tunnel_certificates/archive)
Deprecated
POST/v1/organizations/tunnels/{tunnel_id}/certificates/{certificate_id}/archive
**Deprecated.** This Admin API endpoint is superseded by `/v1/tunnels` on the Claude API and will be removed after a migration window. New integrations should use [`/v1/tunnels`](../Endpoints/http-beta-tunnels.md) with the `anthropic-beta: mcp-tunnels-2026-06-22` header and a WIF token carrying the `workspace:manage_tunnels` scope. Existing integrations continue to work with the `mcp-tunnels-2026-05-19` header and `org:manage_tunnels` scope during the migration window.
#### Organization[Analytics](platform-claude-com-http-beta-organization-analytics.md)
##### [Get Activity Summaries](http-beta-organization-analytics-retrieve-summaries.md)
GET/v1/organizations/analytics/summaries
Get organization-wide activity summaries for a date range.
#### OrganizationAnalytics[Usage](http-beta-organization-analytics-usage.md)
##### [Get Token Usage Over Time](http-beta-organization-analytics-usage-list.md)
GET/v1/organizations/analytics/usage_report
Get token usage over time across a date range.
##### [Get Per-User Token Usage](beta-organization-analytics-usage-list-by-user.md)
GET/v1/organizations/analytics/user_usage_report
Get per-user token usage across a date range.
#### OrganizationAnalytics[Cost](http-beta-organization-analytics-cost.md)
##### [Get Cost Over Time](http-beta-organization-analytics-cost-list.md)
GET/v1/organizations/analytics/cost_report
Get cost in USD over time across a date range.
##### [Get Per-User Cost](beta-organization-analytics-cost-list-by-user.md)
GET/v1/organizations/analytics/user_cost_report
Get per-user cost in USD across a date range.
#### OrganizationAnalytics[Users](platform-claude-com-http-beta-organization-analytics-users.md)
##### [List User Activity](platform-claude-com-http-beta-organization-analytics-users-list.md)
GET/v1/organizations/analytics/users
Get per-user activity for a given day, with cursor-based pagination.
#### OrganizationAnalytics[Skills](http-beta-organization-analytics-skills.md)
##### [Get Skill Usage](platform-claude-com-http-beta-organization-analytics-skills-list.md)
GET/v1/organizations/analytics/skills
Get per-skill usage for a given day, with cursor-based pagination.
#### OrganizationAnalytics[Connectors](http-beta-organization-analytics-connectors.md)
##### [Get Connector Usage](platform-claude-com-http-beta-organization-analytics-connectors-list.md)
GET/v1/organizations/analytics/connectors
Get per-connector usage for a given day, with cursor-based pagination.
#### OrganizationAnalytics[Chat Projects](http-beta-organization-analytics-chat-projects.md)
##### [Get Chat Project Usage](http-beta-organization-analytics-chat-projects-list.md)
GET/v1/organizations/analytics/apps/chat/projects
Get per-project activity for a given day, with cursor-based pagination.
#### OrganizationAnalytics[Plugins](platform-claude-com-http-beta-organization-analytics-plugins.md)
##### [Get Plugin Usage](platform-claude-com-http-beta-organization-analytics-plugins-list.md)
GET/v1/organizations/analytics/plugins
Get per-plugin install + invocation usage for a given day, with pagination.
#### OrganizationAnalytics[Artifacts](http-beta-organization-analytics-artifacts.md)
##### [Get Artifact Activity](platform-claude-com-http-beta-organization-analytics-artifacts-list.md)
GET/v1/organizations/analytics/artifacts
Get artifact-creation activity for a given day, broken out by MIME type.
#### Organization[Spend Limits](https://platform.claude.com/docs/en/api/http/beta/organization/spend_limits)
##### [Set Spend Limit](https://platform.claude.com/docs/en/api/http/beta/organization/spend_limits/create)
POST/v1/organizations/spend_limits
Set a per-user spend limit override.
##### [Get Spend Limit](https://platform.claude.com/docs/en/api/http/beta/organization/spend_limits/retrieve)
GET/v1/organizations/spend_limits/{spend_limit_id}
Retrieve a spend limit by ID.
##### [Delete Spend Limit](https://platform.claude.com/docs/en/api/http/beta/organization/spend_limits/delete)
DELETE/v1/organizations/spend_limits/{spend_limit_id}
Delete a per-user spend limit override.
##### [List Effective Spend Limits](https://platform.claude.com/docs/en/api/http/beta/organization/spend_limits/list_effective)
GET/v1/organizations/spend_limits/effective
List each member's effective spend limit and period-to-date spend.
#### OrganizationSpend Limits[Increase Requests](https://platform.claude.com/docs/en/api/http/beta/organization/spend_limits/increase_requests)
##### [List Spend Limit Increase Requests](https://platform.claude.com/docs/en/api/http/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](https://platform.claude.com/docs/en/api/http/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](https://platform.claude.com/docs/en/api/http/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](https://platform.claude.com/docs/en/api/http/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.
#### Organization[RBAC Groups](https://platform.claude.com/docs/en/api/http/beta/organization/rbac_groups)
##### [List RBAC Groups](https://platform.claude.com/docs/en/api/http/beta/organization/rbac_groups/list)
GET/v1/organizations/rbac_groups
List RBAC Groups in the Claude Enterprise tenant.
##### [Get RBAC Group](https://platform.claude.com/docs/en/api/http/beta/organization/rbac_groups/retrieve)
GET/v1/organizations/rbac_groups/{group_id}
Retrieve an RBAC Group by ID.
##### [Create RBAC Group](https://platform.claude.com/docs/en/api/http/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"`.
##### [Update RBAC Group](https://platform.claude.com/docs/en/api/http/beta/organization/rbac_groups/update)
POST/v1/organizations/rbac_groups/{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](https://platform.claude.com/docs/en/api/http/beta/organization/rbac_groups/delete)
DELETE/v1/organizations/rbac_groups/{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 Groups[Members](https://platform.claude.com/docs/en/api/http/beta/organization/rbac_groups/members)
##### [List RBAC Group Members](https://platform.claude.com/docs/en/api/http/beta/organization/rbac_groups/members/list)
GET/v1/organizations/rbac_groups/{group_id}/members
List members of an RBAC Group.
##### [Add RBAC Group Member](https://platform.claude.com/docs/en/api/http/beta/organization/rbac_groups/members/create)
POST/v1/organizations/rbac_groups/{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](https://platform.claude.com/docs/en/api/http/beta/organization/rbac_groups/members/delete)
DELETE/v1/organizations/rbac_groups/{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.
#### Organization[RBAC Roles](https://platform.claude.com/docs/en/api/http/beta/organization/rbac_roles)
##### [List RBAC Roles](https://platform.claude.com/docs/en/api/http/beta/organization/rbac_roles/list)
GET/v1/organizations/rbac_roles
List RBAC Roles in the organization.
##### [Get RBAC Role](https://platform.claude.com/docs/en/api/http/beta/organization/rbac_roles/retrieve)
GET/v1/organizations/rbac_roles/{role_id}
Retrieve an RBAC Role by ID.
#### OrganizationRBAC Roles[Permissions](https://platform.claude.com/docs/en/api/http/beta/organization/rbac_roles/permissions)
##### [List RBAC Role Permissions](https://platform.claude.com/docs/en/api/http/beta/organization/rbac_roles/permissions/list)
GET/v1/organizations/rbac_roles/{role_id}/permissions
List the permissions an RBAC Role grants.
---
## Get Chat Project Usage - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/analytics/apps/chat/projects/list
Path: 04-API-Reference/Admin/beta-organization-analytics-apps-chat-projects-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fanalytics%2Fapps%2Fchat%2Fprojects%2Flist)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Summaries
Users
Apps
Chat
Projects
Get Chat Project Usage
Connectors
Plugins
Skills
Artifacts
Usage Report
User Usage Report
Cost Report
User Cost Report
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Analytics](platform-claude-com-http-beta-organization-analytics.md)
5. [Apps](https://platform.claude.com/docs/en/api/http/beta/organization/analytics/apps)
6. [Chat](https://platform.claude.com/docs/en/api/http/beta/organization/analytics/apps/chat)
7. [Projects](http-beta-organization-analytics-apps-chat-projects.md)
# Get Chat Project Usage
Copy page
cURL
GET/v1/organizations/analytics/apps/chat/projects
Get per-project activity for a given day, with cursor-based pagination.
Returns activity metrics for each project in the organization, sorted by project ID. Use `group_by[]` to break projects out per member or per RBAC group, and `filter[]` to scope results; the parameter descriptions list the supported dimensions. Available to organizations on a Claude Enterprise plan. Requires an API key with the `read:analytics` scope.
##### Query parameters
date: optional string
UTC date in YYYY-MM-DD format. The day to get project activity for. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day) and may be revised by a few percent over the following days. No earlier than 2026-01-01.
formatdate
ending_date: optional string
UTC date in YYYY-MM-DD format. End of the date range (exclusive); only valid with `starting_date`. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day), so this can be at most today — which is also the default when omitted, resolved once when the first page is served and reused for the rest of the pagination sequence. At most 366 days after `starting_date`.
formatdate
filter: optional array of string
Filters as `dimension:value`, e.g. `filter[]=rbac_group_id:{id}`. Repeat the param for OR within a dimension and across dimensions for AND. Supported dimensions on this endpoint: `project_id`, `rbac_group_id`, `user_id`. Value forms: `project_id` takes a tagged project id (`claude_proj_...`); `rbac_group_id` takes the tagged id (`rbac_group_...`, as emitted in responses and by the spend-limits API) or a bare group UUID, and matches users who held the group at any point during each covered UTC day (time-of-usage attribution); `user_id` takes a tagged user id (`user_...`), as emitted in responses. An unsupported dimension returns 400. At most 100 entries.
maxItems100
group_by: optional array of "rbac_group_id" or "user_id"
Dimensions to break results out by (e.g. `group_by[]=user_id`). Supported on this endpoint: `rbac_group_id`, `user_id`. Grouped rows carry the requested dimension values as additional fields and paginate like ungrouped responses via `next_page`; an unsupported dimension returns 400. `rbac_group_id` attributes a user to every group they held at any point during each covered UTC day, so grouped rows are not an exclusive partition and can sum above org-level totals. At most 100 entries.
maxItems100
One of the following:
"rbac_group_id"
"user_id"
limit: optional number
Number of results per page (1-1000, default 100).
minimum1
maximum1000
order: optional "asc" or "desc"
Sort direction: `asc` or `desc`. Defaults to `asc` for the endpoint's sort column and to `desc` when `order_by` names a metric (a top-N ranking). Applies to `order_by`, or to the endpoint's default sort field when `order_by` is omitted.
One of the following:
"asc"
"desc"
order_by: optional string
Sort field. Restricted to the endpoint's sort column plus its rankable metrics (metrics default to descending; a few metrics rank in date-range mode only, per the endpoint's documented orderable set).
page: optional string
Opaque cursor from a previous response's `next_page` field.
starting_date: optional string
UTC date in YYYY-MM-DD format. Start of a date range (inclusive). Enables rollup mode: one row per entity aggregated over the whole range — addable counters are summed across days, and a distinct count is never summed where summing could double-count (a field's range value is recomputed exactly over the window, approximate via HLL with typical error under 2%, null, or — for the creation-event counts, whose per-day values cannot overlap — a per-day sum that is itself exact; each field's own description says which). Use either `date` or `starting_date`, not both. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day) and may be revised by a few percent over the following days. No earlier than 2026-01-01.
formatdate
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
##### Returns
data: array of [BetaAnalyticsProjectActivity](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_project_activity) { distinct_user_count, message_count, project_id, 8 more }
distinct_user_count: number
Number of distinct users who used the project on the requested day, or, in date-range mode, over the requested window — recomputed as an exact distinct count over the window's per-member daily rows, never a sum of per-day values.
message_count: number
Number of messages sent in the project on the requested day
project_id: string
Tagged project identifier (e.g. `claude_proj_...`)
project_name: string
Name of the project
created_at: optional string or null
Project creation timestamp in RFC 3339 format. Null if the project was deleted before attribution was recorded.
formatdate-time
created_by: optional [BetaAnalyticsUser](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_user) { type: "user", id, email_address } or null
User who created the project. Null if the project was deleted before attribution was recorded, or if the creator's account no longer exists.
type: "user"
Object type. Always `user`.
defaultuser
id: string
Tagged user identifier (e.g. `user_...`)
email_address: string
Email address of the user
distinct_conversation_count: optional number or null
Number of distinct conversations in the project. Null on aggregated rows where a distinct count cannot be computed.
product: optional string or null
Product that produced this row's activity: one of `chat`, `claude_code`, `cowork`, `office_agent`, or `chat_cowork_unified` (Chat and Cowork unified). These are the canonical Cost & Usage product names; an `office_agent` row's per-surface breakdown is in its `office_metrics`. On `/plugins` only `cowork`, `claude_code` and `chat_cowork_unified` occur (the only surfaces with plugin attribution); on `/artifacts` only `chat`, `claude_code`, `cowork` and `chat_cowork_unified` occur (the surfaces that create artifacts); `/apps/chat/projects` does not support the product dimension (a `product` entry in `group_by[]` or `filter[]` there is rejected). Present only when the request grouped by `product`.
rbac_group_id: optional string or null
Tagged RBAC group identifier (`rbac_group_...`), matching the spend-limits API spelling. Present only when the request grouped by `rbac_group_id`.
rbac_group_name: optional string or null
Resolved RBAC group display name, alongside `rbac_group_id` when name resolution is available. Null if the group has been deleted or its name could not be resolved; `rbac_group_id` remains the stable key.
user_id: optional string or null
Tagged user identifier (e.g. `user_...`). Present only when the request grouped by `user_id`.
next_page: string or null
Opaque cursor for the next page, or null if no more results
Get Chat Project Usage
cURL
```python
curl https://api.anthropic.com/v1/organizations/analytics/apps/chat/projects \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"data": [
{
"distinct_user_count": 0,
"message_count": 0,
"project_id": "project_id",
"project_name": "project_name",
"created_at": "2019-12-27T18:11:19.117Z",
"created_by": {
"id": "id",
"email_address": "email_address",
"type": "user"
},
"distinct_conversation_count": 0,
"product": "product",
"rbac_group_id": "rbac_group_id",
"rbac_group_name": "rbac_group_name",
"user_id": "user_id"
}
],
"next_page": "next_page"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"distinct_user_count": 0,
"message_count": 0,
"project_id": "project_id",
"project_name": "project_name",
"created_at": "2019-12-27T18:11:19.117Z",
"created_by": {
"id": "id",
"email_address": "email_address",
"type": "user"
},
"distinct_conversation_count": 0,
"product": "product",
"rbac_group_id": "rbac_group_id",
"rbac_group_name": "rbac_group_name",
---
## Projects - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/analytics/apps/chat/projects
Path: 04-API-Reference/Admin/beta-organization-analytics-apps-chat-projects.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fanalytics%2Fapps%2Fchat%2Fprojects)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Summaries
Users
Apps
Chat
Projects
Get Chat Project Usage
Connectors
Plugins
Skills
Artifacts
Usage Report
User Usage Report
Cost Report
User Cost Report
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Analytics](platform-claude-com-http-beta-organization-analytics.md)
5. [Apps](https://platform.claude.com/docs/en/api/http/beta/organization/analytics/apps)
6. [Chat](https://platform.claude.com/docs/en/api/http/beta/organization/analytics/apps/chat)
# Projects
Copy page
cURL
##### [Get Chat Project Usage](http-beta-organization-analytics-apps-chat-projects-list.md)
GET/v1/organizations/analytics/apps/chat/projects
Get per-project activity for a given day, with cursor-based pagination.
---
## Chat - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/analytics/apps/chat
Path: 04-API-Reference/Admin/beta-organization-analytics-apps-chat.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fanalytics%2Fapps%2Fchat)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Summaries
Users
Apps
Chat
Projects
Connectors
Plugins
Skills
Artifacts
Usage Report
User Usage Report
Cost Report
User Cost Report
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Analytics](platform-claude-com-http-beta-organization-analytics.md)
5. [Apps](https://platform.claude.com/docs/en/api/http/beta/organization/analytics/apps)
# Chat
Copy page
cURL
#### Chat[Projects](http-beta-organization-analytics-apps-chat-projects.md)
##### [Get Chat Project Usage](http-beta-organization-analytics-apps-chat-projects-list.md)
GET/v1/organizations/analytics/apps/chat/projects
Get per-project activity for a given day, with cursor-based pagination.
---
## Apps - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/analytics/apps
Path: 04-API-Reference/Admin/beta-organization-analytics-apps.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fanalytics%2Fapps)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Summaries
Users
Apps
Chat
Connectors
Plugins
Skills
Artifacts
Usage Report
User Usage Report
Cost Report
User Cost Report
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Analytics](platform-claude-com-http-beta-organization-analytics.md)
# Apps
Copy page
cURL
#### AppsChat[Projects](http-beta-organization-analytics-apps-chat-projects.md)
##### [Get Chat Project Usage](http-beta-organization-analytics-apps-chat-projects-list.md)
GET/v1/organizations/analytics/apps/chat/projects
Get per-project activity for a given day, with cursor-based pagination.
---
## Artifacts - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/analytics/artifacts
Path: 04-API-Reference/Admin/beta-organization-analytics-artifacts.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fanalytics%2Fartifacts)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Summaries
Users
Apps
Connectors
Plugins
Skills
Artifacts
Get Artifact Activity
Usage Report
User Usage Report
Cost Report
User Cost Report
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Analytics](platform-claude-com-http-beta-organization-analytics.md)
# Artifacts
Copy page
cURL
##### [Get Artifact Activity](platform-claude-com-http-beta-organization-analytics-artifacts-list.md)
GET/v1/organizations/analytics/artifacts
Get artifact-creation activity for a given day, broken out by MIME type.
---
## Connectors - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/analytics/connectors
Path: 04-API-Reference/Admin/beta-organization-analytics-connectors.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fanalytics%2Fconnectors)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Summaries
Users
Apps
Connectors
Get Connector Usage
Plugins
Skills
Artifacts
Usage Report
User Usage Report
Cost Report
User Cost Report
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Analytics](platform-claude-com-http-beta-organization-analytics.md)
# Connectors
Copy page
cURL
##### [Get Connector Usage](platform-claude-com-http-beta-organization-analytics-connectors-list.md)
GET/v1/organizations/analytics/connectors
Get per-connector usage for a given day, with cursor-based pagination.
---
## Get Per-User Cost - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/analytics/cost/list_by_user
Path: 04-API-Reference/Admin/beta-organization-analytics-cost-list-by-user.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fanalytics%2Fcost%2Flist_by_user)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Get Activity Summaries
Usage
Cost
Get Cost Over Time
Get Per-User Cost
Users
Skills
Connectors
Chat Projects
Plugins
Artifacts
Spend Limits
RBAC Groups
RBAC Roles
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Analytics](platform-claude-com-http-beta-organization-analytics.md)
5. [Cost](http-beta-organization-analytics-cost.md)
# Get Per-User Cost
GET/v1/organizations/analytics/user_cost_report
Get per-user cost in USD across a date range.
Returns one row per user, ranked by spend. Use this to see which users account for the most cost. Only cost attributable to a seat user is included; for organization-wide totals including direct API-key and automation traffic, use the bucketed `/v1/organizations/analytics/cost_report` endpoint. Available to organizations on a Claude Enterprise plan. Requires an API key with the `read:analytics` scope.
##### Query parameters
starting_at: string
Start of range, inclusive. RFC 3339 tz-aware. Must be within the last 365 days and no earlier than 2026-01-01T00:00:00Z.
formatdate-time
bucket_width: optional "1d" or "1h" or "1m"
Time-bucket granularity. When set, each row's `starting_at` and `ending_at` are populated and one actor may span several rows (one per time bucket with usage). The time bucket counts toward `limit`, so one page can return multiple rows for the same actor. `ending_at` is required when `bucket_width` is set, and with `bucket_width="1m"` the range may span at most 24 hours. When omitted, each row aggregates the full `[starting_at, ending_at)` range.
One of the following:
"1d"
"1h"
"1m"
claude_tag_categories: optional array of "dm" or "engaged" or "monitoring" or 2 more
Filter to Claude Tag (Claude in Slack) usage in specific spend categories. Usage with no category never matches. `dm` usage is reported under the user's product rather than `claude-tag`, so combining this filter with `products[]=claude-tag` excludes it. Use `group_by[]=claude_tag_category` to break out per-category values.
maxItems100
One of the following:
"dm"
"engaged"
"monitoring"
"proactive"
"scheduled"
claude_tag_user_ids: optional array of string
Filter to Claude Tag (Claude in Slack) usage attributed to specific Slack users, by Slack user ID (for example `U0123ABCDEF`), not claude.ai user ID. Usage that is not Claude Tag, and Claude Tag usage not attributed to a single user, never matches. Use `group_by[]=claude_tag_user_id` to break out per-user values.
maxItems100
context_windows: optional array of "0-200k" or "200k-1M"
Filter to specific context-window pricing tiers. Use `group_by[]=context_window` to break out per-tier values.
maxItems100
One of the following:
"0-200k"
"200k-1M"
ending_at: optional string
End of range, exclusive. When omitted, defaults to the earlier of now and `starting_at` + 31 days. The range may span at most 31 days.
formatdate-time
exclude_deleted_users: optional boolean
If true, omit rows for users who are deleted (`deleted: true`). A page may contain fewer than `limit` rows; use `has_more` and `next_page` to paginate as usual.
defaultfalse
group_by: optional array of "claude_tag_category" or "claude_tag_user_id" or "context_window" or 8 more
Break each actor's row out by the given dimensions. Accepts the same values as the bucketed `/cost_report` endpoint. The `product`, `model`, `context_window`, `inference_geo`, and `speed` dimensions — and the time bucket, when `bucket_width` is set — count toward `limit`. `cost_type` and `token_type` do not: `cost_type` returns one row per cost component (tokens, web search, code execution); `token_type` returns one row per token type, each with `cost_type: "tokens"`; combining both returns the per-token-type rows plus the web-search and code-execution rows. A page can therefore contain more rows than `limit` when `cost_type` or `token_type` is requested.
maxItems100
One of the following:
"claude_tag_category"
"claude_tag_user_id"
"context_window"
"cost_type"
"inference_geo"
"model"
"product"
"rbac_group_id"
"slack_channel_id"
"speed"
"token_type"
inference_geos: optional array of "global" or "not_available" or "us"
Filter to specific inference regions. `not_available` matches rows where the region is unset. Use `group_by[]=inference_geo` to break out per-region values.
maxItems100
One of the following:
"global"
"not_available"
"us"
limit: optional number
Number of rows per page (1-1000, default 20). One row per actor unless `group_by[]` or `bucket_width` splits an actor across rows; `cost_type`/`token_type` fan-out rows (cost endpoint only) are the exception — they do not count toward this limit, so `data` can exceed it.
default20
minimum1
maximum1000
models: optional array of string
Models to include. Defaults to all models. Use `group_by[]=model` to break out per-model values.
maxItems100
order: optional "asc" or "desc"
Sort direction. Defaults to `desc`.
defaultdesc
One of the following:
"asc"
"desc"
order_by: optional "amount" or "list_amount"
Metric to rank actors by. Defaults to `amount`.
defaultamount
One of the following:
"amount"
"list_amount"
page: optional string
Opaque cursor from a previous response's `next_page` field.
products: optional array of "chat" or "claude-tag" or "claude_code" or 4 more
Product surfaces to include. Defaults to all products.
maxItems100
One of the following:
"chat"
"claude-tag"
"claude_code"
"claude_design"
"claude_in_chrome"
"cowork"
"office_agent"
rbac_group_ids: optional array of string
Filter to usage attributed to specific RBAC groups. Accepts tagged RBAC group IDs (`rbac_group_...`) or bare group UUIDs. A row matches when the user belonged to any of the listed groups on the (UTC) day the usage occurred; usage with no group attribution never matches.
maxItems100
slack_channel_ids: optional array of string
Filter to usage originating from specific Slack channels. Use `group_by[]=slack_channel_id` to break out per-channel values.
maxItems100
speeds: optional array of "fast" or "standard"
Filter to fast or standard inference mode. Use `group_by[]=speed` to break out per-mode values.
maxItems100
One of the following:
"fast"
"standard"
user_ids: optional array of string
Filter to specific users by tagged user ID.
maxItems100
##### Returns
BetaUserCost object{ data, data_refreshed_at, has_more, 2 more }
Get Per-User Cost
cURL
```python
curl https://api.anthropic.com/v1/organizations/analytics/user_cost_report \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"data": [
{
"actor": {
"deleted": true,
"email": "jane@example.com",
"name": "Jane Smith",
"type": "user_actor",
"user_id": "user_01AbCdEfGhIjKlMnOpQrSt"
},
"amount": "41280.000000",
"claude_tag_category": "dm",
"claude_tag_user_id": "U0123ABCDEF",
"context_window": "0-200k",
"cost_type": "code_execution",
"currency": "USD",
"ending_at": "2019-12-27T18:11:19.117Z",
"inference_geo": "global",
"list_amount": "51600.000000",
"model": "claude-opus-5",
"product": "chat",
"rbac_group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"requests": 128,
"slack_channel_id": "C0123ABCDEF",
"speed": "fast",
"starting_at": "2019-12-27T18:11:19.117Z",
"token_type": "cache_creation.ephemeral_1h_input_tokens"
}
],
"data_refreshed_at": "2019-12-27T18:11:19.117Z",
"has_more": true,
"next_page": "next_page",
"organization_id": "org_013FP9SaFPBg7Kw7fetjn6cF"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"actor": {
"deleted": true,
"email": "jane@example.com",
"name": "Jane Smith",
"type": "user_actor",
"user_id": "user_01AbCdEfGhIjKlMnOpQrSt"
},
"amount": "41280.000000",
"claude_tag_category": "dm",
"claude_tag_user_id": "U0123ABCDEF",
"context_window": "0-200k",
"cost_type": "code_execution",
"currency": "USD",
"ending_at": "2019-12-27T18:11:19.117Z",
"inference_geo": "global",
"list_amount": "51600.000000",
"model": "claude-opus-5",
"product": "chat",
"rbac_group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"requests": 128,
"slack_channel_id": "C0123ABCDEF",
"speed": "fast",
"starting_at": "2019-12-27T18:11:19.117Z",
"token_type": "cache_creation.ephemeral_1h_input_tokens"
}
],
"data_refreshed_at": "2019-12-27T18:11:19.117Z",
"has_more": true,
"next_page": "next_page",
"organization_id": "org_013FP9SaFPBg7Kw7fetjn6cF"
---
## Get Cost Over Time - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/analytics/cost_report/list
Path: 04-API-Reference/Admin/beta-organization-analytics-cost-report-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fanalytics%2Fcost_report%2Flist)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Summaries
Users
Apps
Connectors
Plugins
Skills
Artifacts
Usage Report
User Usage Report
Cost Report
Get Cost Over Time
User Cost Report
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Analytics](platform-claude-com-http-beta-organization-analytics.md)
5. [Cost Report](http-beta-organization-analytics-cost-report.md)
# Get Cost Over Time
Copy page
cURL
GET/v1/organizations/analytics/cost_report
Get cost in USD over time across a date range.
Returns cost bucketed by minute, hour, or day, optionally broken down by product, model, context window, inference region, speed, cost type, or token type. Available to organizations on a Claude Enterprise plan. Requires an API key with the `read:analytics` scope.
##### Query parameters
starting_at: string
Start of range, inclusive. RFC 3339 tz-aware. Must be within the last 365 days and no earlier than 2026-01-01T00:00:00Z.
formatdate-time
bucket_width: optional "1d" or "1h" or "1m"
Time bucket granularity.
default1d
One of the following:
"1d"
"1h"
"1m"
claude_tag_categories: optional array of [BetaAnalyticsClaudeTagCategory](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_claude_tag_category)
Filter to Claude Tag (Claude in Slack) usage in specific spend categories. Usage with no category never matches. `dm` usage is reported under the user's product rather than `claude-tag`, so combining this filter with `products[]=claude-tag` excludes it. Use `group_by[]=claude_tag_category` to break out per-category values.
maxItems100
One of the following:
"dm"
"engaged"
"monitoring"
"proactive"
"scheduled"
claude_tag_user_ids: optional array of string
Filter to Claude Tag (Claude in Slack) usage attributed to specific Slack users, by Slack user ID (for example `U0123ABCDEF`), not claude.ai user ID. Usage that is not Claude Tag, and Claude Tag usage not attributed to a single user, never matches. Use `group_by[]=claude_tag_user_id` to break out per-user values.
maxItems100
context_windows: optional array of [BetaAnalyticsContextWindow](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_context_window)
Filter to specific context-window pricing tiers. Use `group_by[]=context_window` to break out per-tier values.
maxItems100
One of the following:
"0-200k"
"200k-1M"
ending_at: optional string
End of range, exclusive. When omitted, defaults to the earlier of now and `starting_at` + 31 days. The range may span at most 31 days.
formatdate-time
group_by: optional array of "claude_tag_category" or "claude_tag_user_id" or "context_window" or 8 more
Dimensions to break each time bucket out by. Defaults to no grouping (one total per bucket). Each bucket reports at most its top 100 groups; a group beyond that cap has no row in that bucket (there is no remainder row), so grouped buckets are not exhaustive when a dimension has more than 100 distinct values.
maxItems100
One of the following:
"claude_tag_category"
"claude_tag_user_id"
"context_window"
"cost_type"
"inference_geo"
"model"
"product"
"rbac_group_id"
"slack_channel_id"
"speed"
"token_type"
inference_geos: optional array of [BetaAnalyticsInferenceGeoFilter](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_inference_geo_filter)
Filter to specific inference regions. `not_available` matches rows where the region is unset. Use `group_by[]=inference_geo` to break out per-region values.
maxItems100
One of the following:
"global"
"not_available"
"us"
limit: optional number
Maximum number of time buckets per page. Defaults and caps vary by `bucket_width` (`1d`: default 7, max 31; `1h`: default 24, max 168; `1m`: default 60, max 256).
minimum1
models: optional array of string
Models to include. Defaults to all models. Use `group_by[]=model` to break out per-model values.
maxItems100
page: optional string
Opaque cursor from a previous response's `next_page` field.
products: optional array of [BetaAnalyticsProductFilter](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_product_filter)
Product surfaces to include. Defaults to all products. Use `group_by[]=product` to break out per-product values.
maxItems100
One of the following:
"chat"
"chat_cowork_unified"
"claude-tag"
"claude_code"
"claude_design"
"claude_in_chrome"
"cowork"
"office_agent"
rbac_group_ids: optional array of string
Filter to usage attributed to specific RBAC groups. Accepts tagged RBAC group IDs (`rbac_group_...`) or bare group UUIDs. A row matches when the user belonged to any of the listed groups on the (UTC) day the usage occurred; usage with no group attribution never matches.
maxItems100
slack_channel_ids: optional array of string
Filter to usage originating from specific Slack channels. Use `group_by[]=slack_channel_id` to break out per-channel values.
maxItems100
speeds: optional array of "fast" or "standard"
Filter to fast or standard inference mode. Use `group_by[]=speed` to break out per-mode values.
maxItems100
One of the following:
"fast"
"standard"
user_ids: optional array of string
Filter to specific users by tagged user ID.
maxItems100
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
##### Returns
data: array of [BetaAnalyticsCostReportTimeBucket](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_cost_report_time_bucket) { ending_at, results, starting_at }
Time buckets for this page, oldest first: one per `bucket_width` interval, including intervals with no data (their `results` list is empty). A page holds at most `limit` buckets.
ending_at: string
End of the time bucket (exclusive) in RFC 3339 format.
formatdate-time
results: array of [BetaAnalyticsCostBucketedResult](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_cost_bucketed_result) { amount, claude_tag_category, claude_tag_user_id, 12 more }
Rows for this time bucket. Empty when the bucket has no data; otherwise a single combined row when `group_by[]` is omitted, or one row per group (subject to the per-bucket group cap described on the `group_by[]` parameter).
amount: string
Amount (post-discount, pre-credit) in fractional cents.
claude_tag_category: [BetaAnalyticsClaudeTagCategory](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_claude_tag_category) or null
Claude Tag (Claude in Slack) spend category: `engaged` (a person addressed Claude in a channel or thread), `proactive` (Claude responded without being addressed), `scheduled` (a scheduled routine ran), `monitoring` (Claude watching a channel it was asked to monitor), or `dm` (direct messages with Claude). Populated only when `claude_tag_category` is in `group_by[]`; null for usage that is not Claude Tag. Direct-message usage is billed to the individual user and is reported under that user's product, not under `claude-tag`. New categories may be added over time.
One of the following:
"dm"
"engaged"
"monitoring"
"proactive"
"scheduled"
claude_tag_user_id: string or null
Slack user ID (for example `U0123ABCDEF`) of the member the Claude Tag (Claude in Slack) usage is attributed to, not a claude.ai user ID. Populated only when `claude_tag_user_id` is in `group_by[]`; null for usage that is not Claude Tag and for Claude Tag usage that is not attributed to a single user (for example `monitoring`, and `proactive` usage Claude initiated), so per-user rows can sum to less than the Claude Tag total. Cannot be combined with `group_by[]=rbac_group_id` or the `rbac_group_ids[]` filter.
context_window: [BetaAnalyticsContextWindow](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_context_window) or null
Context-window pricing tier of the usage or cost. Null unless `context_window` is in `group_by[]`; it can also be null on grouped rows with no context-window tier, such as code execution.
One of the following:
"0-200k"
"200k-1M"
cost_type: [BetaAnalyticsCostType](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_cost_type) or null
Cost component when `group_by[]=cost_type`; null otherwise (amount is the combined total).
One of the following:
"code_execution"
"tokens"
"web_search"
currency: string
Currency code for the cost amount. Currently always `"USD"`.
defaultUSD
inference_geo: "global" or "us" or null
Inference region of the usage or cost. Null unless `inference_geo` is in `group_by[]`; it can also be null on grouped rows where the region is not set (the rows that `inference_geos[]=not_available` matches).
One of the following:
"global"
"us"
list_amount: string
List-price amount (pre-discount) in fractional cents.
model: string or null
Model that produced the usage or cost, as a model name in the form the `models[]` filter accepts (for example, `claude-opus-5-5`). Null unless `model` is in `group_by[]`; it can also be null on grouped rows whose usage or cost is not attributed to a specific model, such as code execution.
product: string or null
Product surface that produced the usage or cost. Null unless product is in `group_by[]`; it can also be null on grouped rows whose usage cannot be attributed to a known surface. Values include `chat`, `claude_code`, `cowork`, `office_agent`, `claude_in_chrome`, `claude_design`, `claude-tag`, and `chat_cowork_unified`. `claude-tag` is Claude Tag, the Claude product in Slack. `chat_cowork_unified` is Chat and Cowork unified, Cowork's features inside claude.ai chat: chat and Cowork usage by a member who has it turned on is reported under this value instead of `chat` or `cowork`. It is accepted as a filter only on deployments that offer Chat and Cowork unified. Some unattributed usage is reported as "other".
rbac_group_id: string or null
RBAC group (team) the usage is attributed to, in the public tagged `rbac_group_...` spelling — the same spelling the activity resources use for this key, so the same team has one id across resources and it round-trips as an `rbac_group_ids[]` filter value. Populated only when `rbac_group_id` is in `group_by[]`. Any-membership semantics: a user in several groups contributes their full usage to each of those groups' rows, so the named-group rows overlap and their sum can exceed the org total. A null value is the single unassigned row: users in no group on that (UTC) day. For the true org total, run the same query without `group_by[]`.
requests: number or null
Number of API requests in this row's scope. Null when `group_by` includes `cost_type` or `token_type` (the count has no per-component attribution; read it from the ungrouped response). For sandbox / code-execution events, this counts execution spans rather than HTTP requests (these rows surface with `product: null`).
slack_channel_id: string or null
Slack channel the usage originated from. Populated only when `slack_channel_id` is in `group_by[]`; null for usage outside Slack (and for rows recorded before channel attribution was enabled).
speed: "fast" or "standard" or null
Inference speed mode of the usage or cost: `fast` or `standard`. Null unless `speed` is in `group_by[]`.
One of the following:
"fast"
"standard"
token_type: [BetaAnalyticsTokenType](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_token_type) or null
Token type when `group_by[]=token_type` and `cost_type=tokens`; null otherwise.
One of the following:
"cache_creation.ephemeral_1h_input_tokens"
"cache_creation.ephemeral_5m_input_tokens"
"cache_read_input_tokens"
"output_tokens"
"uncached_input_tokens"
starting_at: string
Start of the time bucket (inclusive) in RFC 3339 format.
formatdate-time
data_refreshed_at: string or null
RFC 3339 timestamp of the export this response was served from. Null when no export yet covers any part of the requested range, in which case every bucket's `results` list is empty. Buckets beyond this watermark are incomplete; for stable results, set `ending_at` to this value or earlier. Data is typically refreshed every 4 hours. Values can be revised as late events arrive and reconciliation runs, until about 7 days after the end of the calendar month the usage falls in; for example, values for October 1 can change until about November 7.
formatdate-time
has_more: boolean
Whether another page is available. When true, pass `next_page` as the `page` parameter to fetch it.
next_page: string or null
Opaque cursor for the next page, or null when `has_more` is false. Pass it as the `page` parameter, keeping the other parameters unchanged. A cursor can expire after the underlying data refreshes; the request then returns HTTP 410 and pagination must restart from the first page.
organization_id: string
ID of the Organization.
Get Cost Over Time
cURL
```python
curl https://api.anthropic.com/v1/organizations/analytics/cost_report \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"data": [
{
"ending_at": "2019-12-27T18:11:19.117Z",
"results": [
{
"amount": "amount",
"claude_tag_category": "dm",
"claude_tag_user_id": "U0123ABCDEF",
"context_window": "0-200k",
"cost_type": "code_execution",
"currency": "USD",
"inference_geo": "global",
"list_amount": "list_amount",
"model": "claude-opus-5-5",
"product": "chat",
"rbac_group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"requests": 0,
"slack_channel_id": "C0123ABCDEF",
"speed": "fast",
"token_type": "cache_creation.ephemeral_1h_input_tokens"
}
],
"starting_at": "2019-12-27T18:11:19.117Z"
}
],
"data_refreshed_at": "2019-12-27T18:11:19.117Z",
"has_more": true,
"next_page": "next_page",
"organization_id": "org_013FP9SaFPBg7Kw7fetjn6cF"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"ending_at": "2019-12-27T18:11:19.117Z",
"results": [
{
"amount": "amount",
"claude_tag_category": "dm",
"claude_tag_user_id": "U0123ABCDEF",
"context_window": "0-200k",
"cost_type": "code_execution",
"currency": "USD",
"inference_geo": "global",
"list_amount": "list_amount",
"model": "claude-opus-5-5",
"product": "chat",
"rbac_group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"requests": 0,
"slack_channel_id": "C0123ABCDEF",
"speed": "fast",
"token_type": "cache_creation.ephemeral_1h_input_tokens"
}
],
"starting_at": "2019-12-27T18:11:19.117Z"
}
],
"data_refreshed_at": "2019-12-27T18:11:19.117Z",
"has_more": true,
"next_page": "next_page",
"organization_id": "org_013FP9SaFPBg7Kw7fetjn6cF"
---
## Cost Report - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/analytics/cost_report
Path: 04-API-Reference/Admin/beta-organization-analytics-cost-report.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fanalytics%2Fcost_report)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Summaries
Users
Apps
Connectors
Plugins
Skills
Artifacts
Usage Report
User Usage Report
Cost Report
Get Cost Over Time
User Cost Report
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Analytics](platform-claude-com-http-beta-organization-analytics.md)
# Cost Report
Copy page
cURL
##### [Get Cost Over Time](http-beta-organization-analytics-cost-report-list.md)
GET/v1/organizations/analytics/cost_report
Get cost in USD over time across a date range.
---
## Skills - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/analytics/skills
Path: 04-API-Reference/Admin/beta-organization-analytics-skills.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fanalytics%2Fskills)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Summaries
Users
Apps
Connectors
Plugins
Skills
Get Skill Usage
Artifacts
Usage Report
User Usage Report
Cost Report
User Cost Report
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Analytics](platform-claude-com-http-beta-organization-analytics.md)
# Skills
Copy page
cURL
##### [Get Skill Usage](platform-claude-com-http-beta-organization-analytics-skills-list.md)
GET/v1/organizations/analytics/skills
Get per-skill usage for a given day, with cursor-based pagination.
---
## Get Activity Summaries - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/analytics/summaries/list
Path: 04-API-Reference/Admin/beta-organization-analytics-summaries-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fanalytics%2Fsummaries%2Flist)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Summaries
Get Activity Summaries
Users
Apps
Connectors
Plugins
Skills
Artifacts
Usage Report
User Usage Report
Cost Report
User Cost Report
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Analytics](platform-claude-com-http-beta-organization-analytics.md)
5. [Summaries](http-beta-organization-analytics-summaries.md)
# Get Activity Summaries
Copy page
cURL
GET/v1/organizations/analytics/summaries
Get organization-wide activity summaries for a date range.
Returns one entry per day from `starting_date` (inclusive) to `ending_date` (exclusive) in `data`, the same `data` / `next_page` envelope as the other analytics list endpoints; the series is currently returned in full, so `next_page` is always null. Data is typically available with a 1-day lag and may be revised by a few percent over the following days: when `ending_date` is omitted it defaults to the most recent available day + 1, so the last entry covers the most recent available day. The series can be scoped to an RBAC group via `filter[]=rbac_group_id:{id}`. Available to organizations on a Claude Enterprise plan. Requires an API key with the `read:analytics` scope.
##### Query parameters
starting_date: string
UTC date in YYYY-MM-DD format. Start of the date range (inclusive). Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day) and may be revised by a few percent over the following days. No earlier than 2026-01-01.
formatdate
ending_date: optional string
UTC date in YYYY-MM-DD format. End of the date range (exclusive). Data is typically available with a 1-day lag, so this can be at most today — which is also the default when omitted, making the last entry cover the most recent available day. Data may be revised by a few percent over the following days. The range may span at most 366 days.
formatdate
filter: optional array of string
Filters as `dimension:value`. Only `rbac_group_id` is supported (e.g. `filter[]=rbac_group_id:{id}`); repeat the param to OR across groups. Scopes the whole day series to members of the matching group(s), re-aggregated from member-level activity — org-wide seat/invite fields and the adoption rates derived from them are null on scoped rows. `rbac_group_id` accepts the tagged id (`rbac_group_...`, as emitted in responses and by the spend-limits API) or a bare group UUID, and matches users who held the group at any point during each UTC day (time-of-usage attribution). At most 100 entries.
maxItems100
limit: optional number
Number of results per page (1-1000, default 100). The day series (at most 366 entries) is currently returned in full in a single page, so `limit` does not yet shorten it.
minimum1
maximum1000
page: optional string
Opaque cursor from a previous response's `next_page` field. `next_page` is currently always null, so there is never a cursor to send.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
##### Returns
data: array of [BetaAnalyticsSingleDayActivitySummary](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_single_day_activity_summary) { assigned_seat_count, cowork_daily_active_user_count, cowork_monthly_active_user_count, 29 more }
One entry per day in the requested range, ascending by date.
assigned_seat_count: number or null
Number of seats currently assigned to members. Null when the response is scoped to an RBAC group — seat assignment is org-wide and has no per-group analogue.
cowork_daily_active_user_count: number
Number of users with Cowork activity on the requested day
cowork_monthly_active_user_count: number
Number of users with Cowork activity in the 30-day rolling window
cowork_weekly_active_user_count: number
Number of users with Cowork activity in the 7-day rolling window
daily_active_user_count: number
Number of users with token consumption on the requested day
daily_adoption_rate: number or null
Percentage of assigned seats with activity on the requested day (`DAU / assigned_seat_count * 100`). Null when the response is scoped to an RBAC group.
ending_at: string
End of the aggregation period (exclusive), UTC midnight in RFC 3339 format (e.g. `2026-01-16T00:00:00Z`).
formatdate-time
monthly_active_user_count: number
Number of users with token consumption in the 30-day rolling window
monthly_adoption_rate: number or null
Percentage of assigned seats with activity in the 30-day rolling window (`MAU / assigned_seat_count * 100`). Null when the response is scoped to an RBAC group.
pending_invite_count: number or null
Number of pending invitations to join the organization. Null when the response is scoped to an RBAC group.
starting_at: string
Start of the aggregation period (inclusive), UTC midnight in RFC 3339 format (e.g. `2026-01-15T00:00:00Z`).
formatdate-time
weekly_active_user_count: number
Number of users with token consumption in the 7-day rolling window
weekly_adoption_rate: number or null
Percentage of assigned seats with activity in the 7-day rolling window (`WAU / assigned_seat_count * 100`). Null when the response is scoped to an RBAC group.
chat_cowork_unified_daily_active_user_count: optional number or null
Number of users with activity in Chat and Cowork unified on the requested day. Omitted from the response on deployments that do not offer Chat and Cowork unified.
chat_cowork_unified_monthly_active_user_count: optional number or null
Number of users with activity in Chat and Cowork unified in the 28-day rolling window (30 days when the request filters by `rbac_group_id`). Omitted from the response on deployments that do not offer Chat and Cowork unified.
chat_cowork_unified_weekly_active_user_count: optional number or null
Number of users with activity in Chat and Cowork unified in the 7-day rolling window. Omitted from the response on deployments that do not offer Chat and Cowork unified.
chat_daily_active_user_count: optional number or null
Number of users with claude.ai (chat) activity on the requested day. Omitted from the response while the per-product breakdown is not enabled for this organization.
chat_monthly_active_user_count: optional number or null
Number of users with claude.ai (chat) activity in the 30-day rolling window. Omitted from the response while the per-product breakdown is not enabled for this organization.
chat_weekly_active_user_count: optional number or null
Number of users with claude.ai (chat) activity in the 7-day rolling window. Omitted from the response while the per-product breakdown is not enabled for this organization.
claude_code_daily_active_user_count: optional number or null
Number of users with Claude Code activity on the requested day. Omitted from the response while the per-product breakdown is not enabled for this organization.
claude_code_monthly_active_user_count: optional number or null
Number of users with Claude Code activity in the 30-day rolling window. Omitted from the response while the per-product breakdown is not enabled for this organization.
claude_code_weekly_active_user_count: optional number or null
Number of users with Claude Code activity in the 7-day rolling window. Omitted from the response while the per-product breakdown is not enabled for this organization.
claude_design_daily_active_user_count: optional number or null
Number of users with Claude Design activity on the requested day. Omitted from the response while the per-product breakdown is not enabled for this organization.
claude_design_monthly_active_user_count: optional number or null
Number of users with Claude Design activity in the 30-day rolling window. Omitted from the response while the per-product breakdown is not enabled for this organization.
claude_design_weekly_active_user_count: optional number or null
Number of users with Claude Design activity in the 7-day rolling window. Omitted from the response while the per-product breakdown is not enabled for this organization.
office_agent_daily_active_user_count: optional number or null
Number of users with Claude in Office activity on the requested day. Omitted from the response while the per-product breakdown is not enabled for this organization.
office_agent_monthly_active_user_count: optional number or null
Number of users with Claude in Office activity in the 30-day rolling window. Omitted from the response while the per-product breakdown is not enabled for this organization.
office_agent_weekly_active_user_count: optional number or null
Number of users with Claude in Office activity in the 7-day rolling window. Omitted from the response while the per-product breakdown is not enabled for this organization.
science_daily_active_user_count: optional number or null
Number of users with Claude Science activity on the requested day. Omitted from the response while the per-product breakdown is not enabled for this organization.
science_entitled_user_count: optional number or null
Number of users with a Claude Science seat entitlement (per-seat RBAC) at the time of the daily snapshot. The funnel top; independent of the org-level Claude Science toggle. Null when the response is scoped to an RBAC group — entitlement is org-wide and has no per-group analogue. Omitted from the response while the per-product breakdown is not enabled for this organization.
science_monthly_active_user_count: optional number or null
Number of users with Claude Science activity in the 30-day rolling window. Omitted from the response while the per-product breakdown is not enabled for this organization.
science_weekly_active_user_count: optional number or null
Number of users with Claude Science activity in the 7-day rolling window. Omitted from the response while the per-product breakdown is not enabled for this organization.
next_page: string or null
Opaque cursor for the next page, or null if no more results. Currently always null: the day series is returned in full.
summaries: array of [BetaAnalyticsSingleDayActivitySummary](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_single_day_activity_summary) { assigned_seat_count, cowork_daily_active_user_count, cowork_monthly_active_user_count, 29 more }Deprecated
Deprecated: use `data`, which carries the same entries.
assigned_seat_count: number or null
Number of seats currently assigned to members. Null when the response is scoped to an RBAC group — seat assignment is org-wide and has no per-group analogue.
cowork_daily_active_user_count: number
Number of users with Cowork activity on the requested day
cowork_monthly_active_user_count: number
Number of users with Cowork activity in the 30-day rolling window
cowork_weekly_active_user_count: number
Number of users with Cowork activity in the 7-day rolling window
daily_active_user_count: number
Number of users with token consumption on the requested day
daily_adoption_rate: number or null
Percentage of assigned seats with activity on the requested day (`DAU / assigned_seat_count * 100`). Null when the response is scoped to an RBAC group.
ending_at: string
End of the aggregation period (exclusive), UTC midnight in RFC 3339 format (e.g. `2026-01-16T00:00:00Z`).
formatdate-time
monthly_active_user_count: number
Number of users with token consumption in the 30-day rolling window
monthly_adoption_rate: number or null
Percentage of assigned seats with activity in the 30-day rolling window (`MAU / assigned_seat_count * 100`). Null when the response is scoped to an RBAC group.
pending_invite_count: number or null
Number of pending invitations to join the organization. Null when the response is scoped to an RBAC group.
starting_at: string
Start of the aggregation period (inclusive), UTC midnight in RFC 3339 format (e.g. `2026-01-15T00:00:00Z`).
formatdate-time
weekly_active_user_count: number
Number of users with token consumption in the 7-day rolling window
weekly_adoption_rate: number or null
Percentage of assigned seats with activity in the 7-day rolling window (`WAU / assigned_seat_count * 100`). Null when the response is scoped to an RBAC group.
chat_cowork_unified_daily_active_user_count: optional number or null
Number of users with activity in Chat and Cowork unified on the requested day. Omitted from the response on deployments that do not offer Chat and Cowork unified.
chat_cowork_unified_monthly_active_user_count: optional number or null
Number of users with activity in Chat and Cowork unified in the 28-day rolling window (30 days when the request filters by `rbac_group_id`). Omitted from the response on deployments that do not offer Chat and Cowork unified.
chat_cowork_unified_weekly_active_user_count: optional number or null
Number of users with activity in Chat and Cowork unified in the 7-day rolling window. Omitted from the response on deployments that do not offer Chat and Cowork unified.
chat_daily_active_user_count: optional number or null
Number of users with claude.ai (chat) activity on the requested day. Omitted from the response while the per-product breakdown is not enabled for this organization.
chat_monthly_active_user_count: optional number or null
Number of users with claude.ai (chat) activity in the 30-day rolling window. Omitted from the response while the per-product breakdown is not enabled for this organization.
chat_weekly_active_user_count: optional number or null
Number of users with claude.ai (chat) activity in the 7-day rolling window. Omitted from the response while the per-product breakdown is not enabled for this organization.
claude_code_daily_active_user_count: optional number or null
Number of users with Claude Code activity on the requested day. Omitted from the response while the per-product breakdown is not enabled for this organization.
claude_code_monthly_active_user_count: optional number or null
Number of users with Claude Code activity in the 30-day rolling window. Omitted from the response while the per-product breakdown is not enabled for this organization.
claude_code_weekly_active_user_count: optional number or null
Number of users with Claude Code activity in the 7-day rolling window. Omitted from the response while the per-product breakdown is not enabled for this organization.
claude_design_daily_active_user_count: optional number or null
Number of users with Claude Design activity on the requested day. Omitted from the response while the per-product breakdown is not enabled for this organization.
claude_design_monthly_active_user_count: optional number or null
Number of users with Claude Design activity in the 30-day rolling window. Omitted from the response while the per-product breakdown is not enabled for this organization.
claude_design_weekly_active_user_count: optional number or null
Number of users with Claude Design activity in the 7-day rolling window. Omitted from the response while the per-product breakdown is not enabled for this organization.
office_agent_daily_active_user_count: optional number or null
Number of users with Claude in Office activity on the requested day. Omitted from the response while the per-product breakdown is not enabled for this organization.
office_agent_monthly_active_user_count: optional number or null
Number of users with Claude in Office activity in the 30-day rolling window. Omitted from the response while the per-product breakdown is not enabled for this organization.
office_agent_weekly_active_user_count: optional number or null
Number of users with Claude in Office activity in the 7-day rolling window. Omitted from the response while the per-product breakdown is not enabled for this organization.
science_daily_active_user_count: optional number or null
Number of users with Claude Science activity on the requested day. Omitted from the response while the per-product breakdown is not enabled for this organization.
science_entitled_user_count: optional number or null
Number of users with a Claude Science seat entitlement (per-seat RBAC) at the time of the daily snapshot. The funnel top; independent of the org-level Claude Science toggle. Null when the response is scoped to an RBAC group — entitlement is org-wide and has no per-group analogue. Omitted from the response while the per-product breakdown is not enabled for this organization.
science_monthly_active_user_count: optional number or null
Number of users with Claude Science activity in the 30-day rolling window. Omitted from the response while the per-product breakdown is not enabled for this organization.
science_weekly_active_user_count: optional number or null
Number of users with Claude Science activity in the 7-day rolling window. Omitted from the response while the per-product breakdown is not enabled for this organization.
Get Activity Summaries
cURL
```python
curl https://api.anthropic.com/v1/organizations/analytics/summaries \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"data": [
{
"assigned_seat_count": 0,
"cowork_daily_active_user_count": 0,
"cowork_monthly_active_user_count": 0,
"cowork_weekly_active_user_count": 0,
"daily_active_user_count": 0,
"daily_adoption_rate": 0,
"ending_at": "2019-12-27T18:11:19.117Z",
"monthly_active_user_count": 0,
"monthly_adoption_rate": 0,
"pending_invite_count": 0,
"starting_at": "2019-12-27T18:11:19.117Z",
"weekly_active_user_count": 0,
"weekly_adoption_rate": 0,
"chat_cowork_unified_daily_active_user_count": 0,
"chat_cowork_unified_monthly_active_user_count": 0,
"chat_cowork_unified_weekly_active_user_count": 0,
"chat_daily_active_user_count": 0,
"chat_monthly_active_user_count": 0,
"chat_weekly_active_user_count": 0,
"claude_code_daily_active_user_count": 0,
"claude_code_monthly_active_user_count": 0,
"claude_code_weekly_active_user_count": 0,
"claude_design_daily_active_user_count": 0,
"claude_design_monthly_active_user_count": 0,
"claude_design_weekly_active_user_count": 0,
"office_agent_daily_active_user_count": 0,
"office_agent_monthly_active_user_count": 0,
"office_agent_weekly_active_user_count": 0,
"science_daily_active_user_count": 0,
"science_entitled_user_count": 0,
"science_monthly_active_user_count": 0,
"science_weekly_active_user_count": 0
}
],
"next_page": "next_page",
"summaries": [
{
"assigned_seat_count": 0,
"cowork_daily_active_user_count": 0,
"cowork_monthly_active_user_count": 0,
"cowork_weekly_active_user_count": 0,
"daily_active_user_count": 0,
"daily_adoption_rate": 0,
"ending_at": "2019-12-27T18:11:19.117Z",
"monthly_active_user_count": 0,
"monthly_adoption_rate": 0,
"pending_invite_count": 0,
"starting_at": "2019-12-27T18:11:19.117Z",
"weekly_active_user_count": 0,
"weekly_adoption_rate": 0,
"chat_cowork_unified_daily_active_user_count": 0,
"chat_cowork_unified_monthly_active_user_count": 0,
"chat_cowork_unified_weekly_active_user_count": 0,
"chat_daily_active_user_count": 0,
"chat_monthly_active_user_count": 0,
"chat_weekly_active_user_count": 0,
"claude_code_daily_active_user_count": 0,
"claude_code_monthly_active_user_count": 0,
"claude_code_weekly_active_user_count": 0,
"claude_design_daily_active_user_count": 0,
"claude_design_monthly_active_user_count": 0,
"claude_design_weekly_active_user_count": 0,
"office_agent_daily_active_user_count": 0,
"office_agent_monthly_active_user_count": 0,
"office_agent_weekly_active_user_count": 0,
"science_daily_active_user_count": 0,
"science_entitled_user_count": 0,
"science_monthly_active_user_count": 0,
"science_weekly_active_user_count": 0
}
]
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"assigned_seat_count": 0,
"cowork_daily_active_user_count": 0,
"cowork_monthly_active_user_count": 0,
"cowork_weekly_active_user_count": 0,
"daily_active_user_count": 0,
"daily_adoption_rate": 0,
"ending_at": "2019-12-27T18:11:19.117Z",
"monthly_active_user_count": 0,
"monthly_adoption_rate": 0,
"pending_invite_count": 0,
"starting_at": "2019-12-27T18:11:19.117Z",
"weekly_active_user_count": 0,
"weekly_adoption_rate": 0,
"chat_cowork_unified_daily_active_user_count": 0,
"chat_cowork_unified_monthly_active_user_count": 0,
"chat_cowork_unified_weekly_active_user_count": 0,
"chat_daily_active_user_count": 0,
"chat_monthly_active_user_count": 0,
"chat_weekly_active_user_count": 0,
"claude_code_daily_active_user_count": 0,
"claude_code_monthly_active_user_count": 0,
"claude_code_weekly_active_user_count": 0,
"claude_design_daily_active_user_count": 0,
"claude_design_monthly_active_user_count": 0,
"claude_design_weekly_active_user_count": 0,
"office_agent_daily_active_user_count": 0,
"office_agent_monthly_active_user_count": 0,
"office_agent_weekly_active_user_count": 0,
"science_daily_active_user_count": 0,
"science_entitled_user_count": 0,
"science_monthly_active_user_count": 0,
"science_weekly_active_user_count": 0
}
],
"next_page": "next_page",
"summaries": [
{
"assigned_seat_count": 0,
"cowork_daily_active_user_count": 0,
"cowork_monthly_active_user_count": 0,
"cowork_weekly_active_user_count": 0,
"daily_active_user_count": 0,
"daily_adoption_rate": 0,
"ending_at": "2019-12-27T18:11:19.117Z",
"monthly_active_user_count": 0,
"monthly_adoption_rate": 0,
"pending_invite_count": 0,
"starting_at": "2019-12-27T18:11:19.117Z",
"weekly_active_user_count": 0,
"weekly_adoption_rate": 0,
"chat_cowork_unified_daily_active_user_count": 0,
"chat_cowork_unified_monthly_active_user_count": 0,
"chat_cowork_unified_weekly_active_user_count": 0,
"chat_daily_active_user_count": 0,
"chat_monthly_active_user_count": 0,
"chat_weekly_active_user_count": 0,
"claude_code_daily_active_user_count": 0,
"claude_code_monthly_active_user_count": 0,
"claude_code_weekly_active_user_count": 0,
"claude_design_daily_active_user_count": 0,
"claude_design_monthly_active_user_count": 0,
"claude_design_weekly_active_user_count": 0,
"office_agent_daily_active_user_count": 0,
"office_agent_monthly_active_user_count": 0,
"office_agent_weekly_active_user_count": 0,
"science_daily_active_user_count": 0,
"science_entitled_user_count": 0,
"science_monthly_active_user_count": 0,
"science_weekly_active_user_count": 0
---
## Summaries - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/analytics/summaries
Path: 04-API-Reference/Admin/beta-organization-analytics-summaries.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fanalytics%2Fsummaries)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Summaries
Get Activity Summaries
Users
Apps
Connectors
Plugins
Skills
Artifacts
Usage Report
User Usage Report
Cost Report
User Cost Report
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Analytics](platform-claude-com-http-beta-organization-analytics.md)
# Summaries
Copy page
cURL
##### [Get Activity Summaries](http-beta-organization-analytics-summaries-list.md)
GET/v1/organizations/analytics/summaries
Get organization-wide activity summaries for a date range.
---
## Get Per-User Token Usage - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/analytics/usage/list_by_user
Path: 04-API-Reference/Admin/beta-organization-analytics-usage-list-by-user.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fanalytics%2Fusage%2Flist_by_user)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Get Activity Summaries
Usage
Get Token Usage Over Time
Get Per-User Token Usage
Cost
Users
Skills
Connectors
Chat Projects
Plugins
Artifacts
Spend Limits
RBAC Groups
RBAC Roles
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Analytics](platform-claude-com-http-beta-organization-analytics.md)
5. [Usage](http-beta-organization-analytics-usage.md)
# Get Per-User Token Usage
GET/v1/organizations/analytics/user_usage_report
Get per-user token usage across a date range.
Returns one row per user, ranked by the chosen token metric. Use this to see which users consume the most tokens. Only usage attributable to a seat user is included; for organization-wide totals including direct API-key and automation traffic, use the bucketed `/v1/organizations/analytics/usage_report` endpoint. Available to organizations on a Claude Enterprise plan. Requires an API key with the `read:analytics` scope.
##### Query parameters
starting_at: string
Start of range, inclusive. RFC 3339 tz-aware. Must be within the last 365 days and no earlier than 2026-01-01T00:00:00Z.
formatdate-time
bucket_width: optional "1d" or "1h" or "1m"
Time-bucket granularity. When set, each row's `starting_at` and `ending_at` are populated and one actor may span several rows (one per time bucket with usage). The time bucket counts toward `limit`, so one page can return multiple rows for the same actor. `ending_at` is required when `bucket_width` is set, and with `bucket_width="1m"` the range may span at most 24 hours. When omitted, each row aggregates the full `[starting_at, ending_at)` range.
One of the following:
"1d"
"1h"
"1m"
claude_tag_categories: optional array of "dm" or "engaged" or "monitoring" or 2 more
Filter to Claude Tag (Claude in Slack) usage in specific spend categories. Usage with no category never matches. `dm` usage is reported under the user's product rather than `claude-tag`, so combining this filter with `products[]=claude-tag` excludes it. Use `group_by[]=claude_tag_category` to break out per-category values.
maxItems100
One of the following:
"dm"
"engaged"
"monitoring"
"proactive"
"scheduled"
claude_tag_user_ids: optional array of string
Filter to Claude Tag (Claude in Slack) usage attributed to specific Slack users, by Slack user ID (for example `U0123ABCDEF`), not claude.ai user ID. Usage that is not Claude Tag, and Claude Tag usage not attributed to a single user, never matches. Use `group_by[]=claude_tag_user_id` to break out per-user values.
maxItems100
context_windows: optional array of "0-200k" or "200k-1M"
Filter to specific context-window pricing tiers. Use `group_by[]=context_window` to break out per-tier values.
maxItems100
One of the following:
"0-200k"
"200k-1M"
ending_at: optional string
End of range, exclusive. When omitted, defaults to the earlier of now and `starting_at` + 31 days. The range may span at most 31 days.
formatdate-time
exclude_deleted_users: optional boolean
If true, omit rows for users who are deleted (`deleted: true`). A page may contain fewer than `limit` rows; use `has_more` and `next_page` to paginate as usual.
defaultfalse
group_by: optional array of "claude_tag_category" or "claude_tag_user_id" or "context_window" or 6 more
Break each actor's row out by the given dimensions. Accepts the same values as the bucketed `/usage_report` endpoint. `limit` bounds (actor × time bucket × dimension) rows — with dimensions or `bucket_width` present, one actor may span several rows.
maxItems100
One of the following:
"claude_tag_category"
"claude_tag_user_id"
"context_window"
"inference_geo"
"model"
"product"
"rbac_group_id"
"slack_channel_id"
"speed"
inference_geos: optional array of "global" or "not_available" or "us"
Filter to specific inference regions. `not_available` matches rows where the region is unset. Use `group_by[]=inference_geo` to break out per-region values.
maxItems100
One of the following:
"global"
"not_available"
"us"
limit: optional number
Number of rows per page (1-1000, default 20). One row per actor unless `group_by[]` or `bucket_width` splits an actor across rows; `cost_type`/`token_type` fan-out rows (cost endpoint only) are the exception — they do not count toward this limit, so `data` can exceed it.
default20
minimum1
maximum1000
models: optional array of string
Models to include. Defaults to all models. Use `group_by[]=model` to break out per-model values.
maxItems100
order: optional "asc" or "desc"
Sort direction. Defaults to `desc`.
defaultdesc
One of the following:
"asc"
"desc"
order_by: optional "output_tokens" or "requests" or "total_tokens" or "uncached_input_tokens"
Metric to rank actors by. Defaults to `total_tokens`.
defaulttotal_tokens
One of the following:
"output_tokens"
"requests"
"total_tokens"
"uncached_input_tokens"
page: optional string
Opaque cursor from a previous response's `next_page` field.
products: optional array of "chat" or "claude-tag" or "claude_code" or 4 more
Product surfaces to include. Defaults to all products.
maxItems100
One of the following:
"chat"
"claude-tag"
"claude_code"
"claude_design"
"claude_in_chrome"
"cowork"
"office_agent"
rbac_group_ids: optional array of string
Filter to usage attributed to specific RBAC groups. Accepts tagged RBAC group IDs (`rbac_group_...`) or bare group UUIDs. A row matches when the user belonged to any of the listed groups on the (UTC) day the usage occurred; usage with no group attribution never matches.
maxItems100
slack_channel_ids: optional array of string
Filter to usage originating from specific Slack channels. Use `group_by[]=slack_channel_id` to break out per-channel values.
maxItems100
speeds: optional array of "fast" or "standard"
Filter to fast or standard inference mode. Use `group_by[]=speed` to break out per-mode values.
maxItems100
One of the following:
"fast"
"standard"
user_ids: optional array of string
Filter to specific users by tagged user ID.
maxItems100
##### Returns
BetaUserUsage object{ data, data_refreshed_at, has_more, 2 more }
Get Per-User Token Usage
cURL
```python
curl https://api.anthropic.com/v1/organizations/analytics/user_usage_report \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"data": [
{
"actor": {
"deleted": true,
"email": "jane@example.com",
"name": "Jane Smith",
"type": "user_actor",
"user_id": "user_01AbCdEfGhIjKlMnOpQrSt"
},
"cache_creation": {
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 0
},
"cache_read_input_tokens": 3200000,
"claude_tag_category": "dm",
"claude_tag_user_id": "U0123ABCDEF",
"context_window": "0-200k",
"ending_at": "2019-12-27T18:11:19.117Z",
"inference_geo": "global",
"model": "claude-opus-5",
"output_tokens": 891000,
"product": "chat",
"rbac_group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"requests": 128,
"server_tool_use": {
"web_search_requests": 10
},
"slack_channel_id": "C0123ABCDEF",
"speed": "fast",
"starting_at": "2019-12-27T18:11:19.117Z",
"total_tokens": 5377000,
"uncached_input_tokens": 1284500
}
],
"data_refreshed_at": "2019-12-27T18:11:19.117Z",
"has_more": true,
"next_page": "next_page",
"organization_id": "org_013FP9SaFPBg7Kw7fetjn6cF"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"actor": {
"deleted": true,
"email": "jane@example.com",
"name": "Jane Smith",
"type": "user_actor",
"user_id": "user_01AbCdEfGhIjKlMnOpQrSt"
},
"cache_creation": {
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 0
},
"cache_read_input_tokens": 3200000,
"claude_tag_category": "dm",
"claude_tag_user_id": "U0123ABCDEF",
"context_window": "0-200k",
"ending_at": "2019-12-27T18:11:19.117Z",
"inference_geo": "global",
"model": "claude-opus-5",
"output_tokens": 891000,
"product": "chat",
"rbac_group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"requests": 128,
"server_tool_use": {
"web_search_requests": 10
},
"slack_channel_id": "C0123ABCDEF",
"speed": "fast",
"starting_at": "2019-12-27T18:11:19.117Z",
"total_tokens": 5377000,
"uncached_input_tokens": 1284500
}
],
"data_refreshed_at": "2019-12-27T18:11:19.117Z",
"has_more": true,
"next_page": "next_page",
"organization_id": "org_013FP9SaFPBg7Kw7fetjn6cF"
---
## Get Token Usage Over Time - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/analytics/usage_report/list
Path: 04-API-Reference/Admin/beta-organization-analytics-usage-report-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fanalytics%2Fusage_report%2Flist)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Summaries
Users
Apps
Connectors
Plugins
Skills
Artifacts
Usage Report
Get Token Usage Over Time
User Usage Report
Cost Report
User Cost Report
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Analytics](platform-claude-com-http-beta-organization-analytics.md)
5. [Usage Report](http-beta-organization-analytics-usage-report.md)
# Get Token Usage Over Time
Copy page
cURL
GET/v1/organizations/analytics/usage_report
Get token usage over time across a date range.
Returns token usage bucketed by minute, hour, or day, optionally broken down by product, model, context window, inference region, or speed. Available to organizations on a Claude Enterprise plan. Requires an API key with the `read:analytics` scope.
##### Query parameters
starting_at: string
Start of range, inclusive. RFC 3339 tz-aware. Must be within the last 365 days and no earlier than 2026-01-01T00:00:00Z.
formatdate-time
bucket_width: optional "1d" or "1h" or "1m"
Time bucket granularity.
default1d
One of the following:
"1d"
"1h"
"1m"
claude_tag_categories: optional array of [BetaAnalyticsClaudeTagCategory](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_claude_tag_category)
Filter to Claude Tag (Claude in Slack) usage in specific spend categories. Usage with no category never matches. `dm` usage is reported under the user's product rather than `claude-tag`, so combining this filter with `products[]=claude-tag` excludes it. Use `group_by[]=claude_tag_category` to break out per-category values.
maxItems100
One of the following:
"dm"
"engaged"
"monitoring"
"proactive"
"scheduled"
claude_tag_user_ids: optional array of string
Filter to Claude Tag (Claude in Slack) usage attributed to specific Slack users, by Slack user ID (for example `U0123ABCDEF`), not claude.ai user ID. Usage that is not Claude Tag, and Claude Tag usage not attributed to a single user, never matches. Use `group_by[]=claude_tag_user_id` to break out per-user values.
maxItems100
context_windows: optional array of [BetaAnalyticsContextWindow](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_context_window)
Filter to specific context-window pricing tiers. Use `group_by[]=context_window` to break out per-tier values.
maxItems100
One of the following:
"0-200k"
"200k-1M"
ending_at: optional string
End of range, exclusive. When omitted, defaults to the earlier of now and `starting_at` + 31 days. The range may span at most 31 days.
formatdate-time
group_by: optional array of "claude_tag_category" or "claude_tag_user_id" or "context_window" or 6 more
Dimensions to break each time bucket out by. Defaults to no grouping (one total per bucket). Each bucket reports at most its top 100 groups; a group beyond that cap has no row in that bucket (there is no remainder row), so grouped buckets are not exhaustive when a dimension has more than 100 distinct values.
maxItems100
One of the following:
"claude_tag_category"
"claude_tag_user_id"
"context_window"
"inference_geo"
"model"
"product"
"rbac_group_id"
"slack_channel_id"
"speed"
inference_geos: optional array of [BetaAnalyticsInferenceGeoFilter](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_inference_geo_filter)
Filter to specific inference regions. `not_available` matches rows where the region is unset. Use `group_by[]=inference_geo` to break out per-region values.
maxItems100
One of the following:
"global"
"not_available"
"us"
limit: optional number
Maximum number of time buckets per page. Defaults and caps vary by `bucket_width` (`1d`: default 7, max 31; `1h`: default 24, max 168; `1m`: default 60, max 256).
minimum1
models: optional array of string
Models to include. Defaults to all models. Use `group_by[]=model` to break out per-model values.
maxItems100
page: optional string
Opaque cursor from a previous response's `next_page` field.
products: optional array of [BetaAnalyticsProductFilter](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_product_filter)
Product surfaces to include. Defaults to all products. Use `group_by[]=product` to break out per-product values.
maxItems100
One of the following:
"chat"
"chat_cowork_unified"
"claude-tag"
"claude_code"
"claude_design"
"claude_in_chrome"
"cowork"
"office_agent"
rbac_group_ids: optional array of string
Filter to usage attributed to specific RBAC groups. Accepts tagged RBAC group IDs (`rbac_group_...`) or bare group UUIDs. A row matches when the user belonged to any of the listed groups on the (UTC) day the usage occurred; usage with no group attribution never matches.
maxItems100
slack_channel_ids: optional array of string
Filter to usage originating from specific Slack channels. Use `group_by[]=slack_channel_id` to break out per-channel values.
maxItems100
speeds: optional array of "fast" or "standard"
Filter to fast or standard inference mode. Use `group_by[]=speed` to break out per-mode values.
maxItems100
One of the following:
"fast"
"standard"
user_ids: optional array of string
Filter to specific users by tagged user ID.
maxItems100
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
##### Returns
data: array of [BetaAnalyticsUsageReportTimeBucket](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_usage_report_time_bucket) { ending_at, results, starting_at }
Time buckets for this page, oldest first: one per `bucket_width` interval, including intervals with no data (their `results` list is empty). A page holds at most `limit` buckets.
ending_at: string
End of the time bucket (exclusive) in RFC 3339 format.
formatdate-time
results: array of [BetaAnalyticsUsageBucketedResult](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_usage_bucketed_result) { cache_creation, cache_read_input_tokens, claude_tag_category, 12 more }
Rows for this time bucket. Empty when the bucket has no data; otherwise a single combined row when `group_by[]` is omitted, or one row per group (subject to the per-bucket group cap described on the `group_by[]` parameter).
cache_creation: [BetaCacheCreation](../Endpoints/platform-claude-com-http-beta-messages.md#beta_cache_creation) { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens }
The number of input tokens for cache creation.
ephemeral_1h_input_tokens: number
The number of input tokens used to create the 1 hour cache entry.
default0
minimum0
ephemeral_5m_input_tokens: number
The number of input tokens used to create the 5 minute cache entry.
default0
minimum0
cache_read_input_tokens: number
The number of input tokens read from the cache.
claude_tag_category: [BetaAnalyticsClaudeTagCategory](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_claude_tag_category) or null
Claude Tag (Claude in Slack) spend category: `engaged` (a person addressed Claude in a channel or thread), `proactive` (Claude responded without being addressed), `scheduled` (a scheduled routine ran), `monitoring` (Claude watching a channel it was asked to monitor), or `dm` (direct messages with Claude). Populated only when `claude_tag_category` is in `group_by[]`; null for usage that is not Claude Tag. Direct-message usage is billed to the individual user and is reported under that user's product, not under `claude-tag`. New categories may be added over time.
One of the following:
"dm"
"engaged"
"monitoring"
"proactive"
"scheduled"
claude_tag_user_id: string or null
Slack user ID (for example `U0123ABCDEF`) of the member the Claude Tag (Claude in Slack) usage is attributed to, not a claude.ai user ID. Populated only when `claude_tag_user_id` is in `group_by[]`; null for usage that is not Claude Tag and for Claude Tag usage that is not attributed to a single user (for example `monitoring`, and `proactive` usage Claude initiated), so per-user rows can sum to less than the Claude Tag total. Cannot be combined with `group_by[]=rbac_group_id` or the `rbac_group_ids[]` filter.
context_window: [BetaAnalyticsContextWindow](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_context_window) or null
Context-window pricing tier of the usage or cost. Null unless `context_window` is in `group_by[]`; it can also be null on grouped rows with no context-window tier, such as code execution.
One of the following:
"0-200k"
"200k-1M"
inference_geo: "global" or "us" or null
Inference region of the usage or cost. Null unless `inference_geo` is in `group_by[]`; it can also be null on grouped rows where the region is not set (the rows that `inference_geos[]=not_available` matches).
One of the following:
"global"
"us"
model: string or null
Model that produced the usage or cost, as a model name in the form the `models[]` filter accepts (for example, `claude-opus-5-5`). Null unless `model` is in `group_by[]`; it can also be null on grouped rows whose usage or cost is not attributed to a specific model, such as code execution.
output_tokens: number
The number of output tokens generated.
product: string or null
Product surface that produced the usage or cost. Null unless product is in `group_by[]`; it can also be null on grouped rows whose usage cannot be attributed to a known surface. Values include `chat`, `claude_code`, `cowork`, `office_agent`, `claude_in_chrome`, `claude_design`, `claude-tag`, and `chat_cowork_unified`. `claude-tag` is Claude Tag, the Claude product in Slack. `chat_cowork_unified` is Chat and Cowork unified, Cowork's features inside claude.ai chat: chat and Cowork usage by a member who has it turned on is reported under this value instead of `chat` or `cowork`. It is accepted as a filter only on deployments that offer Chat and Cowork unified. Some unattributed usage is reported as "other".
rbac_group_id: string or null
RBAC group (team) the usage is attributed to, in the public tagged `rbac_group_...` spelling — the same spelling the activity resources use for this key, so the same team has one id across resources and it round-trips as an `rbac_group_ids[]` filter value. Populated only when `rbac_group_id` is in `group_by[]`. Any-membership semantics: a user in several groups contributes their full usage to each of those groups' rows, so the named-group rows overlap and their sum can exceed the org total. A null value is the single unassigned row: users in no group on that (UTC) day. For the true org total, run the same query without `group_by[]`.
requests: number or null
Number of API requests in this row's scope. For sandbox / code-execution events, this counts execution spans rather than HTTP requests (these rows surface with `product: null`).
server_tool_use: [BetaAnalyticsServerToolUse](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_server_tool_use) { web_search_requests }
Server-side tool usage metrics.
web_search_requests: number
The number of web search requests made.
slack_channel_id: string or null
Slack channel the usage originated from. Populated only when `slack_channel_id` is in `group_by[]`; null for usage outside Slack (and for rows recorded before channel attribution was enabled).
speed: "fast" or "standard" or null
Inference speed mode of the usage or cost: `fast` or `standard`. Null unless `speed` is in `group_by[]`.
One of the following:
"fast"
"standard"
uncached_input_tokens: number
The number of uncached input tokens processed.
starting_at: string
Start of the time bucket (inclusive) in RFC 3339 format.
formatdate-time
data_refreshed_at: string or null
RFC 3339 timestamp of the export this response was served from. Null when no export yet covers any part of the requested range, in which case every bucket's `results` list is empty. Buckets beyond this watermark are incomplete; for stable results, set `ending_at` to this value or earlier. Data is typically refreshed every 4 hours. Values can be revised as late events arrive and reconciliation runs, until about 7 days after the end of the calendar month the usage falls in; for example, values for October 1 can change until about November 7.
formatdate-time
has_more: boolean
Whether another page is available. When true, pass `next_page` as the `page` parameter to fetch it.
next_page: string or null
Opaque cursor for the next page, or null when `has_more` is false. Pass it as the `page` parameter, keeping the other parameters unchanged. A cursor can expire after the underlying data refreshes; the request then returns HTTP 410 and pagination must restart from the first page.
organization_id: string
ID of the Organization.
Get Token Usage Over Time
cURL
```python
curl https://api.anthropic.com/v1/organizations/analytics/usage_report \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"data": [
{
"ending_at": "2019-12-27T18:11:19.117Z",
"results": [
{
"cache_creation": {
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 0
},
"cache_read_input_tokens": 0,
"claude_tag_category": "dm",
"claude_tag_user_id": "U0123ABCDEF",
"context_window": "0-200k",
"inference_geo": "global",
"model": "claude-opus-5-5",
"output_tokens": 0,
"product": "chat",
"rbac_group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"requests": 0,
"server_tool_use": {
"web_search_requests": 10
},
"slack_channel_id": "C0123ABCDEF",
"speed": "fast",
"uncached_input_tokens": 0
}
],
"starting_at": "2019-12-27T18:11:19.117Z"
}
],
"data_refreshed_at": "2019-12-27T18:11:19.117Z",
"has_more": true,
"next_page": "next_page",
"organization_id": "org_013FP9SaFPBg7Kw7fetjn6cF"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"ending_at": "2019-12-27T18:11:19.117Z",
"results": [
{
"cache_creation": {
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 0
},
"cache_read_input_tokens": 0,
"claude_tag_category": "dm",
"claude_tag_user_id": "U0123ABCDEF",
"context_window": "0-200k",
"inference_geo": "global",
"model": "claude-opus-5-5",
"output_tokens": 0,
"product": "chat",
"rbac_group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"requests": 0,
"server_tool_use": {
"web_search_requests": 10
},
"slack_channel_id": "C0123ABCDEF",
"speed": "fast",
"uncached_input_tokens": 0
}
],
"starting_at": "2019-12-27T18:11:19.117Z"
}
],
"data_refreshed_at": "2019-12-27T18:11:19.117Z",
"has_more": true,
"next_page": "next_page",
"organization_id": "org_013FP9SaFPBg7Kw7fetjn6cF"
---
## Usage Report - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/analytics/usage_report
Path: 04-API-Reference/Admin/beta-organization-analytics-usage-report.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fanalytics%2Fusage_report)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Summaries
Users
Apps
Connectors
Plugins
Skills
Artifacts
Usage Report
Get Token Usage Over Time
User Usage Report
Cost Report
User Cost Report
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Analytics](platform-claude-com-http-beta-organization-analytics.md)
# Usage Report
Copy page
cURL
##### [Get Token Usage Over Time](http-beta-organization-analytics-usage-report-list.md)
GET/v1/organizations/analytics/usage_report
Get token usage over time across a date range.
---
## Get Per-User Cost - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/analytics/user_cost_report/list
Path: 04-API-Reference/Admin/beta-organization-analytics-user-cost-report-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fanalytics%2Fuser_cost_report%2Flist)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Summaries
Users
Apps
Connectors
Plugins
Skills
Artifacts
Usage Report
User Usage Report
Cost Report
User Cost Report
Get Per-User Cost
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Analytics](platform-claude-com-http-beta-organization-analytics.md)
5. [User Cost Report](http-beta-organization-analytics-user-cost-report.md)
# Get Per-User Cost
Copy page
cURL
GET/v1/organizations/analytics/user_cost_report
Get per-user cost in USD across a date range.
Returns one row per user, ranked by spend. Use this to see which users account for the most cost. Only cost attributable to a seat user is included; for organization-wide totals including direct API-key and automation traffic, use the bucketed `/v1/organizations/analytics/cost_report` endpoint. Available to organizations on a Claude Enterprise plan. Requires an API key with the `read:analytics` scope.
##### Query parameters
starting_at: string
Start of range, inclusive. RFC 3339 tz-aware. Must be within the last 365 days and no earlier than 2026-01-01T00:00:00Z.
formatdate-time
bucket_width: optional "1d" or "1h" or "1m"
Time-bucket granularity. When set, each row's `starting_at` and `ending_at` are populated and one actor may span several rows (one per time bucket with usage). The time bucket counts toward `limit`, so one page can return multiple rows for the same actor. `ending_at` is required when `bucket_width` is set, and with `bucket_width="1m"` the range may span at most 24 hours. When omitted, each row aggregates the full `[starting_at, ending_at)` range.
One of the following:
"1d"
"1h"
"1m"
claude_tag_categories: optional array of [BetaAnalyticsClaudeTagCategory](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_claude_tag_category)
Filter to Claude Tag (Claude in Slack) usage in specific spend categories. Usage with no category never matches. `dm` usage is reported under the user's product rather than `claude-tag`, so combining this filter with `products[]=claude-tag` excludes it. Use `group_by[]=claude_tag_category` to break out per-category values.
maxItems100
One of the following:
"dm"
"engaged"
"monitoring"
"proactive"
"scheduled"
claude_tag_user_ids: optional array of string
Filter to Claude Tag (Claude in Slack) usage attributed to specific Slack users, by Slack user ID (for example `U0123ABCDEF`), not claude.ai user ID. Usage that is not Claude Tag, and Claude Tag usage not attributed to a single user, never matches. Use `group_by[]=claude_tag_user_id` to break out per-user values.
maxItems100
context_windows: optional array of [BetaAnalyticsContextWindow](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_context_window)
Filter to specific context-window pricing tiers. Use `group_by[]=context_window` to break out per-tier values.
maxItems100
One of the following:
"0-200k"
"200k-1M"
ending_at: optional string
End of range, exclusive. When omitted, defaults to the earlier of now and `starting_at` + 31 days. The range may span at most 31 days.
formatdate-time
exclude_deleted_users: optional boolean
If true, omit rows for users who are deleted (`deleted: true`). A page may contain fewer than `limit` rows; use `has_more` and `next_page` to paginate as usual.
defaultfalse
group_by: optional array of "claude_tag_category" or "claude_tag_user_id" or "context_window" or 8 more
Break each actor's row out by the given dimensions. Accepts the same values as the bucketed `/cost_report` endpoint. The `product`, `model`, `context_window`, `inference_geo`, and `speed` dimensions — and the time bucket, when `bucket_width` is set — count toward `limit`. `cost_type` and `token_type` do not: `cost_type` returns one row per cost component (tokens, web search, code execution); `token_type` returns one row per token type, each with `cost_type: "tokens"`; combining both returns the per-token-type rows plus the web-search and code-execution rows. A page can therefore contain more rows than `limit` when `cost_type` or `token_type` is requested.
maxItems100
One of the following:
"claude_tag_category"
"claude_tag_user_id"
"context_window"
"cost_type"
"inference_geo"
"model"
"product"
"rbac_group_id"
"slack_channel_id"
"speed"
"token_type"
inference_geos: optional array of [BetaAnalyticsInferenceGeoFilter](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_inference_geo_filter)
Filter to specific inference regions. `not_available` matches rows where the region is unset. Use `group_by[]=inference_geo` to break out per-region values.
maxItems100
One of the following:
"global"
"not_available"
"us"
limit: optional number
Number of rows per page (1-1000, default 20). One row per actor unless `group_by[]` or `bucket_width` splits an actor across rows; `cost_type`/`token_type` fan-out rows (cost endpoint only) are the exception — they do not count toward this limit, so `data` can exceed it.
default20
minimum1
maximum1000
models: optional array of string
Models to include. Defaults to all models. Use `group_by[]=model` to break out per-model values.
maxItems100
order: optional "asc" or "desc"
Sort direction. Defaults to `desc`.
defaultdesc
One of the following:
"asc"
"desc"
order_by: optional "amount" or "list_amount"
Metric to rank actors by. Defaults to `amount`.
defaultamount
One of the following:
"amount"
"list_amount"
page: optional string
Opaque cursor from a previous response's `next_page` field.
products: optional array of [BetaAnalyticsProductFilter](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_product_filter)
Product surfaces to include. Defaults to all products.
maxItems100
One of the following:
"chat"
"chat_cowork_unified"
"claude-tag"
"claude_code"
"claude_design"
"claude_in_chrome"
"cowork"
"office_agent"
rbac_group_ids: optional array of string
Filter to usage attributed to specific RBAC groups. Accepts tagged RBAC group IDs (`rbac_group_...`) or bare group UUIDs. A row matches when the user belonged to any of the listed groups on the (UTC) day the usage occurred; usage with no group attribution never matches.
maxItems100
slack_channel_ids: optional array of string
Filter to usage originating from specific Slack channels. Use `group_by[]=slack_channel_id` to break out per-channel values.
maxItems100
speeds: optional array of "fast" or "standard"
Filter to fast or standard inference mode. Use `group_by[]=speed` to break out per-mode values.
maxItems100
One of the following:
"fast"
"standard"
user_ids: optional array of string
Filter to specific users by tagged user ID.
maxItems100
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
##### Returns
data: array of [BetaAnalyticsCostUsersItem](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_cost_users_item) { actor, amount, claude_tag_category, 15 more }
Rows for this page, ranked by `order_by` in the `order` direction. One row per user, or several per user when `group_by[]` or `bucket_width` breaks that user's usage or cost out across rows. Rows split out by `cost_type` or `token_type` (cost endpoint only) stay adjacent and are ranked as one unit.
actor: [BetaAnalyticsUserActor](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_user_actor) { type: "user_actor", deleted, email, 3 more }
The user this row's usage or cost is attributed to. Always a `user_actor`.
type: "user_actor"
Actor type. Always `"user_actor"`.
deleted: boolean
True when the account has been deleted, or when the user is no longer a member of the organization or its associated organizations (for example, their membership was removed or they were deprovisioned via your identity provider). `email_address` stays populated for removed users and is null when the account has been deleted. `name` follows the rules described on that field. The `user_id` is still populated for reconciliation.
email_address: string or null
The user's email address, including for users who are no longer members of the organization or its associated organizations. Null when the account has been deleted (check `deleted`) and for system-minted service accounts, which have no person's mailbox behind them (check `name`).
name: string or null
The user's full name. Null when the user has not set a name. Returns `"Deleted User"` when the account itself has been deleted, or when the user is no longer a member of the organization or its associated organizations and the organization has chosen to hide the names of removed users. Otherwise, the name stays populated for removed users. Rows for system-minted service accounts render the service name (for example, `"Claude Security"` for usage by Anthropic's security-patching service) or null.
user_id: string
Tagged user ID.
email: string or nullDeprecated
Deprecated: use `email_address`, which carries the same value.
amount: string
Amount (post-discount, pre-credit) in fractional cents (minor units).
claude_tag_category: [BetaAnalyticsClaudeTagCategory](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_claude_tag_category) or null
Claude Tag (Claude in Slack) spend category: `engaged` (a person addressed Claude in a channel or thread), `proactive` (Claude responded without being addressed), `scheduled` (a scheduled routine ran), `monitoring` (Claude watching a channel it was asked to monitor), or `dm` (direct messages with Claude). Populated only when `claude_tag_category` is in `group_by[]`; null for usage that is not Claude Tag. Direct-message usage is billed to the individual user and is reported under that user's product, not under `claude-tag`. New categories may be added over time.
One of the following:
"dm"
"engaged"
"monitoring"
"proactive"
"scheduled"
claude_tag_user_id: string or null
Slack user ID (for example `U0123ABCDEF`) of the member the Claude Tag (Claude in Slack) usage is attributed to, not a claude.ai user ID. Populated only when `claude_tag_user_id` is in `group_by[]`; null for usage that is not Claude Tag and for Claude Tag usage that is not attributed to a single user (for example `monitoring`, and `proactive` usage Claude initiated), so per-user rows can sum to less than the Claude Tag total. Cannot be combined with `group_by[]=rbac_group_id` or the `rbac_group_ids[]` filter.
context_window: [BetaAnalyticsContextWindow](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_context_window) or null
Context-window pricing tier of the usage or cost. Null unless `context_window` is in `group_by[]`; it can also be null on grouped rows with no context-window tier, such as code execution.
One of the following:
"0-200k"
"200k-1M"
cost_type: [BetaAnalyticsCostType](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_cost_type) or null
Cost component breakdown; null when returning the combined total.
One of the following:
"code_execution"
"tokens"
"web_search"
currency: string
Currency code for the cost amount. Currently always `"USD"`.
defaultUSD
ending_at: string or null
End of the row's UTC time bucket (exclusive), as an RFC 3339 timestamp; equal to `starting_at` plus one `bucket_width`. Null unless `bucket_width` is set.
formatdate-time
inference_geo: "global" or "us" or null
Inference region of the usage or cost. Null unless `inference_geo` is in `group_by[]`; it can also be null on grouped rows where the region is not set (the rows that `inference_geos[]=not_available` matches).
One of the following:
"global"
"us"
list_amount: string
List-price amount (pre-discount) in fractional cents.
model: string or null
Model that produced the usage or cost, as a model name in the form the `models[]` filter accepts (for example, `claude-opus-5-5`). Null unless `model` is in `group_by[]`; it can also be null on grouped rows whose usage or cost is not attributed to a specific model, such as code execution.
product: string or null
Product surface that produced the usage or cost. Null unless product is in `group_by[]`; it can also be null on grouped rows whose usage cannot be attributed to a known surface. Values include `chat`, `claude_code`, `cowork`, `office_agent`, `claude_in_chrome`, `claude_design`, `claude-tag`, and `chat_cowork_unified`. `claude-tag` is Claude Tag, the Claude product in Slack. `chat_cowork_unified` is Chat and Cowork unified, Cowork's features inside claude.ai chat: chat and Cowork usage by a member who has it turned on is reported under this value instead of `chat` or `cowork`. It is accepted as a filter only on deployments that offer Chat and Cowork unified. Some unattributed usage is reported as "other".
rbac_group_id: string or null
RBAC group (team) the usage is attributed to, in the public tagged `rbac_group_...` spelling — the same spelling the activity resources use for this key, so the same team has one id across resources and it round-trips as an `rbac_group_ids[]` filter value. Populated only when `rbac_group_id` is in `group_by[]`. Any-membership semantics: a user in several groups contributes their full usage to each of those groups' rows, so the named-group rows overlap and their sum can exceed the org total. A null value is the single unassigned row: users in no group on that (UTC) day. For the true org total, run the same query without `group_by[]`.
requests: number or null
Number of API requests in this row's scope. Null when `group_by` includes `cost_type` or `token_type` (the count has no per-component attribution; read it from the ungrouped response). For sandbox / code-execution events, this counts execution spans rather than HTTP requests (these rows surface with `product: null`).
slack_channel_id: string or null
Slack channel the usage originated from. Populated only when `slack_channel_id` is in `group_by[]`; null for usage outside Slack (and for rows recorded before channel attribution was enabled).
speed: "fast" or "standard" or null
Inference speed mode of the usage or cost: `fast` or `standard`. Null unless `speed` is in `group_by[]`.
One of the following:
"fast"
"standard"
starting_at: string or null
Start of the row's UTC time bucket (inclusive), as an RFC 3339 timestamp. Null unless `bucket_width` is set; without `bucket_width`, each row aggregates the full requested range.
formatdate-time
token_type: [BetaAnalyticsTokenType](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_token_type) or null
Token type when `cost_type` is `tokens`; null otherwise.
One of the following:
"cache_creation.ephemeral_1h_input_tokens"
"cache_creation.ephemeral_5m_input_tokens"
"cache_read_input_tokens"
"output_tokens"
"uncached_input_tokens"
data_refreshed_at: string or null
RFC 3339 timestamp of the export this response was served from. Null when no export yet covers any part of the requested range, in which case `data` is empty. Data beyond this watermark is incomplete; for stable results, set `ending_at` to this value or earlier. Data is typically refreshed every 4 hours. Values can be revised as late events arrive and reconciliation runs, until about 7 days after the end of the calendar month the usage falls in; for example, values for October 1 can change until about November 7.
formatdate-time
has_more: boolean
Whether another page is available. When true, pass `next_page` as the `page` parameter to fetch it.
next_page: string or null
Opaque cursor for the next page, or null when `has_more` is false. Pass it as the `page` parameter, keeping the other parameters unchanged. A cursor can expire after the underlying data refreshes; the request then returns HTTP 410 and pagination must restart from the first page.
organization_id: string
ID of the Organization.
Get Per-User Cost
cURL
```python
curl https://api.anthropic.com/v1/organizations/analytics/user_cost_report \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"data": [
{
"actor": {
"deleted": true,
"email": "jane@example.com",
"email_address": "jane@example.com",
"name": "Jane Smith",
"type": "user_actor",
"user_id": "user_01AbCdEfGhIjKlMnOpQrSt"
},
"amount": "41280.000000",
"claude_tag_category": "dm",
"claude_tag_user_id": "U0123ABCDEF",
"context_window": "0-200k",
"cost_type": "code_execution",
"currency": "USD",
"ending_at": "2019-12-27T18:11:19.117Z",
"inference_geo": "global",
"list_amount": "51600.000000",
"model": "claude-opus-5-5",
"product": "chat",
"rbac_group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"requests": 128,
"slack_channel_id": "C0123ABCDEF",
"speed": "fast",
"starting_at": "2019-12-27T18:11:19.117Z",
"token_type": "cache_creation.ephemeral_1h_input_tokens"
}
],
"data_refreshed_at": "2019-12-27T18:11:19.117Z",
"has_more": true,
"next_page": "next_page",
"organization_id": "org_013FP9SaFPBg7Kw7fetjn6cF"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"actor": {
"deleted": true,
"email": "jane@example.com",
"email_address": "jane@example.com",
"name": "Jane Smith",
"type": "user_actor",
"user_id": "user_01AbCdEfGhIjKlMnOpQrSt"
},
"amount": "41280.000000",
"claude_tag_category": "dm",
"claude_tag_user_id": "U0123ABCDEF",
"context_window": "0-200k",
"cost_type": "code_execution",
"currency": "USD",
"ending_at": "2019-12-27T18:11:19.117Z",
"inference_geo": "global",
"list_amount": "51600.000000",
"model": "claude-opus-5-5",
"product": "chat",
"rbac_group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"requests": 128,
"slack_channel_id": "C0123ABCDEF",
"speed": "fast",
"starting_at": "2019-12-27T18:11:19.117Z",
"token_type": "cache_creation.ephemeral_1h_input_tokens"
}
],
"data_refreshed_at": "2019-12-27T18:11:19.117Z",
"has_more": true,
"next_page": "next_page",
"organization_id": "org_013FP9SaFPBg7Kw7fetjn6cF"
---
## User Cost Report - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/analytics/user_cost_report
Path: 04-API-Reference/Admin/beta-organization-analytics-user-cost-report.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fanalytics%2Fuser_cost_report)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Summaries
Users
Apps
Connectors
Plugins
Skills
Artifacts
Usage Report
User Usage Report
Cost Report
User Cost Report
Get Per-User Cost
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Analytics](platform-claude-com-http-beta-organization-analytics.md)
# User Cost Report
Copy page
cURL
##### [Get Per-User Cost](http-beta-organization-analytics-user-cost-report-list.md)
GET/v1/organizations/analytics/user_cost_report
Get per-user cost in USD across a date range.
---
## Get Per-User Token Usage - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/analytics/user_usage_report/list
Path: 04-API-Reference/Admin/beta-organization-analytics-user-usage-report-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fanalytics%2Fuser_usage_report%2Flist)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Summaries
Users
Apps
Connectors
Plugins
Skills
Artifacts
Usage Report
User Usage Report
Get Per-User Token Usage
Cost Report
User Cost Report
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Analytics](platform-claude-com-http-beta-organization-analytics.md)
5. [User Usage Report](http-beta-organization-analytics-user-usage-report.md)
# Get Per-User Token Usage
Copy page
cURL
GET/v1/organizations/analytics/user_usage_report
Get per-user token usage across a date range.
Returns one row per user, ranked by the chosen token metric. Use this to see which users consume the most tokens. Only usage attributable to a seat user is included; for organization-wide totals including direct API-key and automation traffic, use the bucketed `/v1/organizations/analytics/usage_report` endpoint. Available to organizations on a Claude Enterprise plan. Requires an API key with the `read:analytics` scope.
##### Query parameters
starting_at: string
Start of range, inclusive. RFC 3339 tz-aware. Must be within the last 365 days and no earlier than 2026-01-01T00:00:00Z.
formatdate-time
bucket_width: optional "1d" or "1h" or "1m"
Time-bucket granularity. When set, each row's `starting_at` and `ending_at` are populated and one actor may span several rows (one per time bucket with usage). The time bucket counts toward `limit`, so one page can return multiple rows for the same actor. `ending_at` is required when `bucket_width` is set, and with `bucket_width="1m"` the range may span at most 24 hours. When omitted, each row aggregates the full `[starting_at, ending_at)` range.
One of the following:
"1d"
"1h"
"1m"
claude_tag_categories: optional array of [BetaAnalyticsClaudeTagCategory](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_claude_tag_category)
Filter to Claude Tag (Claude in Slack) usage in specific spend categories. Usage with no category never matches. `dm` usage is reported under the user's product rather than `claude-tag`, so combining this filter with `products[]=claude-tag` excludes it. Use `group_by[]=claude_tag_category` to break out per-category values.
maxItems100
One of the following:
"dm"
"engaged"
"monitoring"
"proactive"
"scheduled"
claude_tag_user_ids: optional array of string
Filter to Claude Tag (Claude in Slack) usage attributed to specific Slack users, by Slack user ID (for example `U0123ABCDEF`), not claude.ai user ID. Usage that is not Claude Tag, and Claude Tag usage not attributed to a single user, never matches. Use `group_by[]=claude_tag_user_id` to break out per-user values.
maxItems100
context_windows: optional array of [BetaAnalyticsContextWindow](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_context_window)
Filter to specific context-window pricing tiers. Use `group_by[]=context_window` to break out per-tier values.
maxItems100
One of the following:
"0-200k"
"200k-1M"
ending_at: optional string
End of range, exclusive. When omitted, defaults to the earlier of now and `starting_at` + 31 days. The range may span at most 31 days.
formatdate-time
exclude_deleted_users: optional boolean
If true, omit rows for users who are deleted (`deleted: true`). A page may contain fewer than `limit` rows; use `has_more` and `next_page` to paginate as usual.
defaultfalse
group_by: optional array of "claude_tag_category" or "claude_tag_user_id" or "context_window" or 6 more
Break each actor's row out by the given dimensions. Accepts the same values as the bucketed `/usage_report` endpoint. `limit` bounds (actor × time bucket × dimension) rows — with dimensions or `bucket_width` present, one actor may span several rows.
maxItems100
One of the following:
"claude_tag_category"
"claude_tag_user_id"
"context_window"
"inference_geo"
"model"
"product"
"rbac_group_id"
"slack_channel_id"
"speed"
inference_geos: optional array of [BetaAnalyticsInferenceGeoFilter](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_inference_geo_filter)
Filter to specific inference regions. `not_available` matches rows where the region is unset. Use `group_by[]=inference_geo` to break out per-region values.
maxItems100
One of the following:
"global"
"not_available"
"us"
limit: optional number
Number of rows per page (1-1000, default 20). One row per actor unless `group_by[]` or `bucket_width` splits an actor across rows; `cost_type`/`token_type` fan-out rows (cost endpoint only) are the exception — they do not count toward this limit, so `data` can exceed it.
default20
minimum1
maximum1000
models: optional array of string
Models to include. Defaults to all models. Use `group_by[]=model` to break out per-model values.
maxItems100
order: optional "asc" or "desc"
Sort direction. Defaults to `desc`.
defaultdesc
One of the following:
"asc"
"desc"
order_by: optional "output_tokens" or "requests" or "total_tokens" or "uncached_input_tokens"
Metric to rank actors by. Defaults to `total_tokens`.
defaulttotal_tokens
One of the following:
"output_tokens"
"requests"
"total_tokens"
"uncached_input_tokens"
page: optional string
Opaque cursor from a previous response's `next_page` field.
products: optional array of [BetaAnalyticsProductFilter](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_product_filter)
Product surfaces to include. Defaults to all products.
maxItems100
One of the following:
"chat"
"chat_cowork_unified"
"claude-tag"
"claude_code"
"claude_design"
"claude_in_chrome"
"cowork"
"office_agent"
rbac_group_ids: optional array of string
Filter to usage attributed to specific RBAC groups. Accepts tagged RBAC group IDs (`rbac_group_...`) or bare group UUIDs. A row matches when the user belonged to any of the listed groups on the (UTC) day the usage occurred; usage with no group attribution never matches.
maxItems100
slack_channel_ids: optional array of string
Filter to usage originating from specific Slack channels. Use `group_by[]=slack_channel_id` to break out per-channel values.
maxItems100
speeds: optional array of "fast" or "standard"
Filter to fast or standard inference mode. Use `group_by[]=speed` to break out per-mode values.
maxItems100
One of the following:
"fast"
"standard"
user_ids: optional array of string
Filter to specific users by tagged user ID.
maxItems100
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
##### Returns
data: array of [BetaAnalyticsUsageUsersItem](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_usage_users_item) { actor, cache_creation, cache_read_input_tokens, 16 more }
Rows for this page, ranked by `order_by` in the `order` direction. One row per user, or several per user when `group_by[]` or `bucket_width` breaks that user's usage or cost out across rows. Rows split out by `cost_type` or `token_type` (cost endpoint only) stay adjacent and are ranked as one unit.
actor: [BetaAnalyticsUserActor](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_user_actor) { type: "user_actor", deleted, email, 3 more }
The user this row's usage or cost is attributed to. Always a `user_actor`.
type: "user_actor"
Actor type. Always `"user_actor"`.
deleted: boolean
True when the account has been deleted, or when the user is no longer a member of the organization or its associated organizations (for example, their membership was removed or they were deprovisioned via your identity provider). `email_address` stays populated for removed users and is null when the account has been deleted. `name` follows the rules described on that field. The `user_id` is still populated for reconciliation.
email_address: string or null
The user's email address, including for users who are no longer members of the organization or its associated organizations. Null when the account has been deleted (check `deleted`) and for system-minted service accounts, which have no person's mailbox behind them (check `name`).
name: string or null
The user's full name. Null when the user has not set a name. Returns `"Deleted User"` when the account itself has been deleted, or when the user is no longer a member of the organization or its associated organizations and the organization has chosen to hide the names of removed users. Otherwise, the name stays populated for removed users. Rows for system-minted service accounts render the service name (for example, `"Claude Security"` for usage by Anthropic's security-patching service) or null.
user_id: string
Tagged user ID.
email: string or nullDeprecated
Deprecated: use `email_address`, which carries the same value.
cache_creation: [BetaCacheCreation](../Endpoints/platform-claude-com-http-beta-messages.md#beta_cache_creation) { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens }
The number of input tokens for cache creation.
ephemeral_1h_input_tokens: number
The number of input tokens used to create the 1 hour cache entry.
default0
minimum0
ephemeral_5m_input_tokens: number
The number of input tokens used to create the 5 minute cache entry.
default0
minimum0
cache_read_input_tokens: number
The number of input tokens read from the cache.
claude_tag_category: [BetaAnalyticsClaudeTagCategory](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_claude_tag_category) or null
Claude Tag (Claude in Slack) spend category: `engaged` (a person addressed Claude in a channel or thread), `proactive` (Claude responded without being addressed), `scheduled` (a scheduled routine ran), `monitoring` (Claude watching a channel it was asked to monitor), or `dm` (direct messages with Claude). Populated only when `claude_tag_category` is in `group_by[]`; null for usage that is not Claude Tag. Direct-message usage is billed to the individual user and is reported under that user's product, not under `claude-tag`. New categories may be added over time.
One of the following:
"dm"
"engaged"
"monitoring"
"proactive"
"scheduled"
claude_tag_user_id: string or null
Slack user ID (for example `U0123ABCDEF`) of the member the Claude Tag (Claude in Slack) usage is attributed to, not a claude.ai user ID. Populated only when `claude_tag_user_id` is in `group_by[]`; null for usage that is not Claude Tag and for Claude Tag usage that is not attributed to a single user (for example `monitoring`, and `proactive` usage Claude initiated), so per-user rows can sum to less than the Claude Tag total. Cannot be combined with `group_by[]=rbac_group_id` or the `rbac_group_ids[]` filter.
context_window: [BetaAnalyticsContextWindow](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_context_window) or null
Context-window pricing tier of the usage or cost. Null unless `context_window` is in `group_by[]`; it can also be null on grouped rows with no context-window tier, such as code execution.
One of the following:
"0-200k"
"200k-1M"
ending_at: string or null
End of the row's UTC time bucket (exclusive), as an RFC 3339 timestamp; equal to `starting_at` plus one `bucket_width`. Null unless `bucket_width` is set.
formatdate-time
inference_geo: "global" or "us" or null
Inference region of the usage or cost. Null unless `inference_geo` is in `group_by[]`; it can also be null on grouped rows where the region is not set (the rows that `inference_geos[]=not_available` matches).
One of the following:
"global"
"us"
model: string or null
Model that produced the usage or cost, as a model name in the form the `models[]` filter accepts (for example, `claude-opus-5-5`). Null unless `model` is in `group_by[]`; it can also be null on grouped rows whose usage or cost is not attributed to a specific model, such as code execution.
output_tokens: number
The number of output tokens generated.
product: string or null
Product surface that produced the usage or cost. Null unless product is in `group_by[]`; it can also be null on grouped rows whose usage cannot be attributed to a known surface. Values include `chat`, `claude_code`, `cowork`, `office_agent`, `claude_in_chrome`, `claude_design`, `claude-tag`, and `chat_cowork_unified`. `claude-tag` is Claude Tag, the Claude product in Slack. `chat_cowork_unified` is Chat and Cowork unified, Cowork's features inside claude.ai chat: chat and Cowork usage by a member who has it turned on is reported under this value instead of `chat` or `cowork`. It is accepted as a filter only on deployments that offer Chat and Cowork unified. Some unattributed usage is reported as "other".
rbac_group_id: string or null
RBAC group (team) the usage is attributed to, in the public tagged `rbac_group_...` spelling — the same spelling the activity resources use for this key, so the same team has one id across resources and it round-trips as an `rbac_group_ids[]` filter value. Populated only when `rbac_group_id` is in `group_by[]`. Any-membership semantics: a user in several groups contributes their full usage to each of those groups' rows, so the named-group rows overlap and their sum can exceed the org total. A null value is the single unassigned row: users in no group on that (UTC) day. For the true org total, run the same query without `group_by[]`.
requests: number or null
Number of API requests in this row's scope. For sandbox / code-execution events, this counts execution spans rather than HTTP requests (these rows surface with `product: null`).
server_tool_use: [BetaAnalyticsServerToolUse](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_server_tool_use) { web_search_requests }
Server-side tool usage metrics.
web_search_requests: number
The number of web search requests made.
slack_channel_id: string or null
Slack channel the usage originated from. Populated only when `slack_channel_id` is in `group_by[]`; null for usage outside Slack (and for rows recorded before channel attribution was enabled).
speed: "fast" or "standard" or null
Inference speed mode of the usage or cost: `fast` or `standard`. Null unless `speed` is in `group_by[]`.
One of the following:
"fast"
"standard"
starting_at: string or null
Start of the row's UTC time bucket (inclusive), as an RFC 3339 timestamp. Null unless `bucket_width` is set; without `bucket_width`, each row aggregates the full requested range.
formatdate-time
total_tokens: number
Total token count across all token types. This is the value the default `order_by` (`total_tokens`) sorts on.
uncached_input_tokens: number
The number of uncached input tokens processed.
data_refreshed_at: string or null
RFC 3339 timestamp of the export this response was served from. Null when no export yet covers any part of the requested range, in which case `data` is empty. Data beyond this watermark is incomplete; for stable results, set `ending_at` to this value or earlier. Data is typically refreshed every 4 hours. Values can be revised as late events arrive and reconciliation runs, until about 7 days after the end of the calendar month the usage falls in; for example, values for October 1 can change until about November 7.
formatdate-time
has_more: boolean
Whether another page is available. When true, pass `next_page` as the `page` parameter to fetch it.
next_page: string or null
Opaque cursor for the next page, or null when `has_more` is false. Pass it as the `page` parameter, keeping the other parameters unchanged. A cursor can expire after the underlying data refreshes; the request then returns HTTP 410 and pagination must restart from the first page.
organization_id: string
ID of the Organization.
Get Per-User Token Usage
cURL
```python
curl https://api.anthropic.com/v1/organizations/analytics/user_usage_report \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"data": [
{
"actor": {
"deleted": true,
"email": "jane@example.com",
"email_address": "jane@example.com",
"name": "Jane Smith",
"type": "user_actor",
"user_id": "user_01AbCdEfGhIjKlMnOpQrSt"
},
"cache_creation": {
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 0
},
"cache_read_input_tokens": 3200000,
"claude_tag_category": "dm",
"claude_tag_user_id": "U0123ABCDEF",
"context_window": "0-200k",
"ending_at": "2019-12-27T18:11:19.117Z",
"inference_geo": "global",
"model": "claude-opus-5-5",
"output_tokens": 891000,
"product": "chat",
"rbac_group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"requests": 128,
"server_tool_use": {
"web_search_requests": 10
},
"slack_channel_id": "C0123ABCDEF",
"speed": "fast",
"starting_at": "2019-12-27T18:11:19.117Z",
"total_tokens": 5377000,
"uncached_input_tokens": 1284500
}
],
"data_refreshed_at": "2019-12-27T18:11:19.117Z",
"has_more": true,
"next_page": "next_page",
"organization_id": "org_013FP9SaFPBg7Kw7fetjn6cF"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"actor": {
"deleted": true,
"email": "jane@example.com",
"email_address": "jane@example.com",
"name": "Jane Smith",
"type": "user_actor",
"user_id": "user_01AbCdEfGhIjKlMnOpQrSt"
},
"cache_creation": {
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 0
},
"cache_read_input_tokens": 3200000,
"claude_tag_category": "dm",
"claude_tag_user_id": "U0123ABCDEF",
"context_window": "0-200k",
"ending_at": "2019-12-27T18:11:19.117Z",
"inference_geo": "global",
"model": "claude-opus-5-5",
"output_tokens": 891000,
"product": "chat",
"rbac_group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"requests": 128,
"server_tool_use": {
"web_search_requests": 10
},
"slack_channel_id": "C0123ABCDEF",
"speed": "fast",
"starting_at": "2019-12-27T18:11:19.117Z",
"total_tokens": 5377000,
"uncached_input_tokens": 1284500
}
],
"data_refreshed_at": "2019-12-27T18:11:19.117Z",
"has_more": true,
"next_page": "next_page",
"organization_id": "org_013FP9SaFPBg7Kw7fetjn6cF"
---
## User Usage Report - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/analytics/user_usage_report
Path: 04-API-Reference/Admin/beta-organization-analytics-user-usage-report.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fanalytics%2Fuser_usage_report)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Summaries
Users
Apps
Connectors
Plugins
Skills
Artifacts
Usage Report
User Usage Report
Get Per-User Token Usage
Cost Report
User Cost Report
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Analytics](platform-claude-com-http-beta-organization-analytics.md)
# User Usage Report
Copy page
cURL
##### [Get Per-User Token Usage](http-beta-organization-analytics-user-usage-report-list.md)
GET/v1/organizations/analytics/user_usage_report
Get per-user token usage across a date range.
---
## List API Keys - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/api_keys/list
Path: 04-API-Reference/Admin/beta-organization-api-keys-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fapi_keys%2Flist)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
List API Keys
Retrieve API Key (Admin API)
Update API Key
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
Looking for your API keys? You can view and create them on the [API keys](../Other/playground.md) page in the Claude Console.
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [API Keys](https://platform.claude.com/docs/en/api/http/beta/organization/api_keys)
# List API Keys
Copy page
cURL
GET/v1/organizations/api_keys
List API Keys
##### Query parameters
after_id: optional string
ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object.
before_id: optional string
ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object.
created_by_user_id: optional string
Filter by the ID of the User who created the object.
limit: optional number
Number of items to return per page.
Defaults to `20`. Ranges from `1` to `1000`.
default20
minimum1
maximum1000
status: optional "active" or "archived" or "expired" or "inactive"
Filter by API key status.
One of the following:
"active"
"archived"
"expired"
"inactive"
workspace_id: optional string
Filter by Workspace ID.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
##### Returns
data: array of [BetaAPIKey](https://platform.claude.com/docs/en/api/http/beta/organization/api_keys#beta_api_key) { type: "api_key", id, created_at, 8 more }
type: "api_key"
Object type.
For API Keys, this is always `"api_key"`.
defaultapi_key
id: string
ID of the API key.
created_at: string
RFC 3339 datetime string indicating when the API Key was created.
formatdate-time
created_by: [BetaAPIKeyCreatedBy](https://platform.claude.com/docs/en/api/http/beta/organization/api_keys#beta_api_key_created_by) { type, id } or null
The ID and type of the actor that created the API key, or `null` when the creator is not recorded (legacy, workload-identity-federated, or system-created keys).
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.
expires_at: string or null
RFC 3339 datetime string indicating when the API Key expires, or `null` if it never expires.
formatdate-time
name: string
Name of the API key.
partial_key_hint: string or null
Partially redacted hint for the API key.
principal: [BetaAPIKeyUserActor](https://platform.claude.com/docs/en/api/http/beta/organization/api_keys#beta_api_key_user_actor) or [BetaAPIKeyServiceAccountActor](https://platform.claude.com/docs/en/api/http/beta/organization/api_keys#beta_api_key_service_account_actor) or null
The principal the API key acts as (a User or a Service Account), or `null` if the API key is not bound to a principal.
One of the following:
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.
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.
scope: [BetaAPIKeyOrganizationScope](https://platform.claude.com/docs/en/api/http/beta/organization/api_keys#beta_api_key_organization_scope) or [BetaAPIKeyWorkspaceScope](https://platform.claude.com/docs/en/api/http/beta/organization/api_keys#beta_api_key_workspace_scope)
Where the API key belongs: its Workspace (`{"type": "workspace", "workspace_id": "wrkspc_..."}`, with the Workspace's real ID even when it is the organization's default Workspace), or the organization (`{"type": "organization"}`) for a principal-bound API key that has no Workspace.
One of the following:
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
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.
status: "active" or "archived" or "expired" or "inactive"
Status of the API key.
One of the following:
"active"
"archived"
"expired"
"inactive"
workspace_id: string or nullDeprecated
Deprecated: use `scope` instead. ID of the Workspace associated with the API key, or `null` if the API key belongs to the default Workspace. Also `null` for a principal-bound API key that has no Workspace; `scope` tells the two apart.
Use \`scope\` instead. \`workspace_id\` is \`null\` both for an API key in the default Workspace and for a principal-bound API key that has no Workspace.
first_id: string or null
First ID in the `data` list. Can be used as the `before_id` for the previous page.
has_more: boolean
Indicates if there are more results in the requested page direction.
last_id: string or null
Last ID in the `data` list. Can be used as the `after_id` for the next page.
List API Keys
cURL
```python
curl https://api.anthropic.com/v1/organizations/api_keys \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"data": [
{
"id": "apikey_01Rj2N8SVvo6BePZj99NhmiT",
"created_at": "2024-10-30T23:58:27.427722Z",
"created_by": {
"id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"type": "user"
},
"expires_at": "2024-10-30T23:58:27.427722Z",
"name": "Developer Key",
"partial_key_hint": "sk-ant-api03-R2D...igAA",
"principal": {
"type": "user_actor",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"scope": {
"type": "workspace",
"workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"
},
"status": "active",
"type": "api_key",
"workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"
}
],
"first_id": "first_id",
"has_more": true,
"last_id": "last_id"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"id": "apikey_01Rj2N8SVvo6BePZj99NhmiT",
"created_at": "2024-10-30T23:58:27.427722Z",
"created_by": {
"id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"type": "user"
},
"expires_at": "2024-10-30T23:58:27.427722Z",
"name": "Developer Key",
"partial_key_hint": "sk-ant-api03-R2D...igAA",
"principal": {
"type": "user_actor",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"scope": {
"type": "workspace",
"workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"
},
"status": "active",
"type": "api_key",
"workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"
---
## Retrieve API Key (Admin API) - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/api_keys/retrieve
Path: 04-API-Reference/Admin/beta-organization-api-keys-retrieve.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fapi_keys%2Fretrieve)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
List API Keys
Retrieve API Key (Admin API)
Update API Key
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
Looking for your API keys? You can view and create them on the [API keys](../Other/playground.md) page in the Claude Console.
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [API Keys](https://platform.claude.com/docs/en/api/http/beta/organization/api_keys)
# Retrieve API Key (Admin API)
Copy page
cURL
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](../Other/playground.md) in the Claude Console.
##### Path parameters
api_key_id: string
ID of the API key.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
##### Returns
BetaAPIKey object{ type: "api_key", id, created_at, 8 more }
Retrieve API Key (Admin API)
cURL
```python
curl https://api.anthropic.com/v1/organizations/api_keys/$API_KEY_ID \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"id": "apikey_01Rj2N8SVvo6BePZj99NhmiT",
"created_at": "2024-10-30T23:58:27.427722Z",
"created_by": {
"id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"type": "user"
},
"expires_at": "2024-10-30T23:58:27.427722Z",
"name": "Developer Key",
"partial_key_hint": "sk-ant-api03-R2D...igAA",
"principal": {
"type": "user_actor",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"scope": {
"type": "workspace",
"workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"
},
"status": "active",
"type": "api_key",
"workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"
}
```
##### Returns Examples
Response 200
```python
{
"id": "apikey_01Rj2N8SVvo6BePZj99NhmiT",
"created_at": "2024-10-30T23:58:27.427722Z",
"created_by": {
"id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"type": "user"
},
"expires_at": "2024-10-30T23:58:27.427722Z",
"name": "Developer Key",
"partial_key_hint": "sk-ant-api03-R2D...igAA",
"principal": {
"type": "user_actor",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"scope": {
"type": "workspace",
"workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"
},
"status": "active",
"type": "api_key",
"workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"
---
## Update API Key - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/api_keys/update
Path: 04-API-Reference/Admin/beta-organization-api-keys-update.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fapi_keys%2Fupdate)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
List API Keys
Retrieve API Key (Admin API)
Update API Key
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
Looking for your API keys? You can view and create them on the [API keys](../Other/playground.md) page in the Claude Console.
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [API Keys](https://platform.claude.com/docs/en/api/http/beta/organization/api_keys)
# Update API Key
Copy page
cURL
POST/v1/organizations/api_keys/{api_key_id}
Update API Key
##### Path parameters
api_key_id: string
ID of the API key.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
##### Body
name: optional string or null
Name of the API key.
minLength1
maxLength500
status: optional "active" or "archived" or "inactive" or null
Status of the API key.
One of the following:
"active"
"archived"
"inactive"
##### Returns
BetaAPIKey object{ type: "api_key", id, created_at, 8 more }
Update API Key
cURL
```python
curl https://api.anthropic.com/v1/organizations/api_keys/$API_KEY_ID \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY" \
-d '{}'
```
Response 200
```python
{
"id": "apikey_01Rj2N8SVvo6BePZj99NhmiT",
"created_at": "2024-10-30T23:58:27.427722Z",
"created_by": {
"id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"type": "user"
},
"expires_at": "2024-10-30T23:58:27.427722Z",
"name": "Developer Key",
"partial_key_hint": "sk-ant-api03-R2D...igAA",
"principal": {
"type": "user_actor",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"scope": {
"type": "workspace",
"workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"
},
"status": "active",
"type": "api_key",
"workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"
}
```
##### Returns Examples
Response 200
```python
{
"id": "apikey_01Rj2N8SVvo6BePZj99NhmiT",
"created_at": "2024-10-30T23:58:27.427722Z",
"created_by": {
"id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"type": "user"
},
"expires_at": "2024-10-30T23:58:27.427722Z",
"name": "Developer Key",
"partial_key_hint": "sk-ant-api03-R2D...igAA",
"principal": {
"type": "user_actor",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"scope": {
"type": "workspace",
"workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"
},
"status": "active",
"type": "api_key",
"workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"
---
## API Keys - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/api_keys
Path: 04-API-Reference/Admin/beta-organization-api-keys.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fapi_keys)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
List API Keys
Retrieve API Key (Admin API)
Update API Key
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
Looking for your API keys? You can view and create them on the [API keys](../Other/playground.md) page in the Claude Console.
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
# API Keys
Copy page
cURL
##### [List API Keys](https://platform.claude.com/docs/en/api/http/beta/organization/api_keys/list)
GET/v1/organizations/api_keys
##### [Retrieve API Key (Admin API)](https://platform.claude.com/docs/en/api/http/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](../Other/playground.md) in the Claude Console.
##### [Update API Key](https://platform.claude.com/docs/en/api/http/beta/organization/api_keys/update)
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.
---
## Get Compliance Settings - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/compliance_settings/retrieve
Path: 04-API-Reference/Admin/beta-organization-compliance-settings-retrieve.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fcompliance_settings%2Fretrieve)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Get Compliance Settings
Update Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Compliance Settings](https://platform.claude.com/docs/en/api/http/beta/organization/compliance_settings)
# Get Compliance Settings
Copy page
cURL
GET/v1/organizations/compliance_settings
Retrieve your organization's Compliance Settings.
Compliance Settings is a singleton resource: there is exactly one per organization, addressed without an identifier. The `state` field reflects whether the Compliance API is enabled. An organization with a parent organization reads the state inherited from the parent's configuration.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
##### Returns
BetaComplianceSettings object{ type: "compliance_settings", state }
type: "compliance_settings"
defaultcompliance_settings
state: [BetaComplianceSettingsState](https://platform.claude.com/docs/en/api/http/beta/organization/compliance_settings#beta_compliance_settings_state)
Whether the Compliance API is enabled for this organization.
One of the following:
BetaComplianceSettingsStateEnabled object{ type: "enabled" }
type: "enabled"
defaultenabled
BetaComplianceSettingsStateDisabled object{ type: "disabled" }
type: "disabled"
defaultdisabled
Get Compliance Settings
cURL
```python
curl https://api.anthropic.com/v1/organizations/compliance_settings \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
---
## Update Compliance Settings - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/compliance_settings/update
Path: 04-API-Reference/Admin/beta-organization-compliance-settings-update.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fcompliance_settings%2Fupdate)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Get Compliance Settings
Update Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Compliance Settings](https://platform.claude.com/docs/en/api/http/beta/organization/compliance_settings)
# Update Compliance Settings
Copy page
cURL
POST/v1/organizations/compliance_settings
Update your organization's Compliance Settings.
Setting `state` to `enabled` turns on the Compliance API and begins capturing organization activity events. Setting it to `disabled` turns both off. `state` reflects whether the Compliance API is enabled.
A request that sets `state` to its current value succeeds and leaves the resource unchanged. A `disabled` request stays in effect until a later `enabled` request or the organization's next provisioning action that enables Access Transparency: enabling Access Transparency also enables the Compliance API, which serves its activity events, so such provisioning (including re-runs) re-enables the Compliance API even after a `disabled` request. Automated provisioning never disables compliance settings.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
##### Body
state: [BetaComplianceSettingsStateParam](https://platform.claude.com/docs/en/api/http/beta/organization/compliance_settings#beta_compliance_settings_state_param)
Desired state. Accepts the string shorthand "enabled" or "disabled" in place of the object form; the response always returns the canonical object form.
One of the following:
BetaComplianceSettingsStateEnabledParam object{ type: "enabled" }
type: "enabled"
BetaComplianceSettingsStateDisabledParam object{ type: "disabled" }
type: "disabled"
##### Returns
BetaComplianceSettings object{ type: "compliance_settings", state }
type: "compliance_settings"
defaultcompliance_settings
state: [BetaComplianceSettingsState](https://platform.claude.com/docs/en/api/http/beta/organization/compliance_settings#beta_compliance_settings_state)
Whether the Compliance API is enabled for this organization.
One of the following:
BetaComplianceSettingsStateEnabled object{ type: "enabled" }
type: "enabled"
defaultenabled
BetaComplianceSettingsStateDisabled object{ type: "disabled" }
type: "disabled"
defaultdisabled
Update Compliance Settings
cURL
```python
curl https://api.anthropic.com/v1/organizations/compliance_settings \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY" \
---
## Compliance Settings - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/compliance_settings
Path: 04-API-Reference/Admin/beta-organization-compliance-settings.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fcompliance_settings)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Get Compliance Settings
Update Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
# Compliance Settings
Copy page
cURL
##### [Get Compliance Settings](https://platform.claude.com/docs/en/api/http/beta/organization/compliance_settings/retrieve)
GET/v1/organizations/compliance_settings
Retrieve your organization's Compliance Settings.
##### [Update Compliance Settings](https://platform.claude.com/docs/en/api/http/beta/organization/compliance_settings/update)
POST/v1/organizations/compliance_settings
Update your organization's Compliance Settings.
##### Models
BetaComplianceSettings object{ type: "compliance_settings", state }
type: "compliance_settings"
defaultcompliance_settings
state: [BetaComplianceSettingsState](https://platform.claude.com/docs/en/api/http/beta/organization/compliance_settings#beta_compliance_settings_state)
Whether the Compliance API is enabled for this organization.
One of the following:
BetaComplianceSettingsStateEnabled object{ type: "enabled" }
type: "enabled"
defaultenabled
BetaComplianceSettingsStateDisabled object{ type: "disabled" }
type: "disabled"
defaultdisabled
BetaComplianceSettingsState = [BetaComplianceSettingsStateEnabled](https://platform.claude.com/docs/en/api/http/beta/organization/compliance_settings#beta_compliance_settings_state_enabled) or [BetaComplianceSettingsStateDisabled](https://platform.claude.com/docs/en/api/http/beta/organization/compliance_settings#beta_compliance_settings_state_disabled)
One of the following:
BetaComplianceSettingsStateEnabled object{ type: "enabled" }
type: "enabled"
defaultenabled
BetaComplianceSettingsStateDisabled object{ type: "disabled" }
type: "disabled"
defaultdisabled
BetaComplianceSettingsStateDisabled object{ type: "disabled" }
type: "disabled"
defaultdisabled
BetaComplianceSettingsStateDisabledParam object{ type: "disabled" }
type: "disabled"
BetaComplianceSettingsStateEnabled object{ type: "enabled" }
type: "enabled"
defaultenabled
BetaComplianceSettingsStateEnabledParam object{ type: "enabled" }
type: "enabled"
BetaComplianceSettingsStateParam = [BetaComplianceSettingsStateEnabledParam](https://platform.claude.com/docs/en/api/http/beta/organization/compliance_settings#beta_compliance_settings_state_enabled_param) or [BetaComplianceSettingsStateDisabledParam](https://platform.claude.com/docs/en/api/http/beta/organization/compliance_settings#beta_compliance_settings_state_disabled_param)
One of the following:
BetaComplianceSettingsStateEnabledParam object{ type: "enabled" }
type: "enabled"
BetaComplianceSettingsStateDisabledParam object{ type: "disabled" }
---
## Get Cost Report - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/cost_report/retrieve
Path: 04-API-Reference/Admin/beta-organization-cost-report-retrieve.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fcost_report%2Fretrieve)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
Get Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Cost Report](https://platform.claude.com/docs/en/api/http/beta/organization/cost_report)
# Get Cost Report
Copy page
cURL
GET/v1/organizations/cost_report
Get Cost Report
##### Query parameters
starting_at: string
Time buckets that start on or after this RFC 3339 timestamp will be returned. Each time bucket will be snapped to the start of the minute/hour/day in UTC.
formatdate-time
bucket_width: optional "1d"
Time granularity of the response data.
default1d
ending_at: optional string
Time buckets that end before this RFC 3339 timestamp will be returned.
formatdate-time
group_by: optional array of "description" or "workspace_id"
Group by any subset of the available options.
One of the following:
"description"
"workspace_id"
limit: optional number
Maximum number of time buckets to return in the response.
default7
minimum1
maximum31
page: optional string
Optionally set to the `next_page` token from the previous response.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"anthropic-beta": optional array of [AnthropicBeta](../Endpoints/platform-claude-com-http-beta.md#anthropic_beta)
Optional header to specify the beta version(s) you want to use.
One of the following:
string
"message-batches-2024-09-24"
"prompt-caching-2024-07-31"
"computer-use-2024-10-22"
"computer-use-2025-01-24"
"pdfs-2024-09-25"
"token-counting-2024-11-01"
"token-efficient-tools-2025-02-19"
"output-128k-2025-02-19"
"files-api-2025-04-14"
"mcp-client-2025-04-04"
"mcp-client-2025-11-20"
"dev-full-thinking-2025-05-14"
"interleaved-thinking-2025-05-14"
"code-execution-2025-05-22"
"extended-cache-ttl-2025-04-11"
"context-1m-2025-08-07"
"context-management-2025-06-27"
"model-context-window-exceeded-2025-08-26"
"skills-2025-10-02"
"fast-mode-2026-02-01"
"output-300k-2026-03-24"
"user-profiles-2026-03-24"
"user-profiles-2026-08-18"
"user-profiles-2026-09-04"
"advisor-tool-2026-03-01"
"managed-agents-2026-04-01"
"cache-diagnosis-2026-04-07"
"dreaming-2026-04-21"
"thinking-token-count-2026-05-13"
"server-side-fallback-2026-06-01"
"server-side-fallback-2026-07-01"
"fallback-credit-2026-06-01"
"fallback-credit-2026-07-01"
"agent-memory-2026-07-22"
"mid-conversation-tool-changes-2026-07-01"
"compact-2026-01-12"
"computer-use-2025-11-24"
"mcp-tunnels-2026-06-22"
"structured-outputs-2025-11-13"
"task-budgets-2026-03-13"
"thinking-display-updates-2026-08-18"
"ce-user-management-2026-07-13"
"mid-conversation-output-config-2026-07-01"
"thinking-binding-controls-2026-08-01"
"mid-conversation-system-clear-at-2026-08-21"
"compact-2026-09-04"
"inline-tools-2026-09-15"
"mcp-client-2026-09-15"
"ce-plugins-2026-09-01"
"spend-limit-reads-2026-09-26"
"telemetry-destinations-2026-08-11"
##### Returns
BetaCostReport object{ data, has_more, next_page }
Get Cost Report
cURL
```python
curl https://api.anthropic.com/v1/organizations/cost_report \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"data": [
{
"ending_at": "2025-08-02T00:00:00Z",
"results": [
{
"amount": "123.78912",
"context_window": "0-200k",
"cost_type": "tokens",
"currency": "USD",
"description": "Claude Opus 5.5 Usage - Input Tokens",
"inference_geo": "global",
"model": "claude-opus-5-5",
"service_tier": "standard",
"speed": "standard",
"token_type": "cache_creation.ephemeral_1h_input_tokens",
"workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"
}
],
"starting_at": "2025-08-01T00:00:00Z"
}
],
"has_more": true,
"next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo="
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"ending_at": "2025-08-02T00:00:00Z",
"results": [
{
"amount": "123.78912",
"context_window": "0-200k",
"cost_type": "tokens",
"currency": "USD",
"description": "Claude Opus 5.5 Usage - Input Tokens",
"inference_geo": "global",
"model": "claude-opus-5-5",
"service_tier": "standard",
"speed": "standard",
"token_type": "cache_creation.ephemeral_1h_input_tokens",
"workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"
}
],
"starting_at": "2025-08-01T00:00:00Z"
}
],
"has_more": true,
"next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo="
---
## Cost Report - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/cost_report
Path: 04-API-Reference/Admin/beta-organization-cost-report.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fcost_report)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
Get Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
# Cost Report
Copy page
cURL
##### [Get Cost Report](https://platform.claude.com/docs/en/api/http/beta/organization/cost_report/retrieve)
GET/v1/organizations/cost_report
##### Models
BetaCostReport object{ data, has_more, next_page }
---
## Create External Key - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/external_keys/create
Path: 04-API-Reference/Admin/beta-organization-external-keys-create.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fexternal_keys%2Fcreate)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Create External Key
List External Keys
Get External Key
Update External Key
Delete External Key
Validate External Key
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [External Keys](https://platform.claude.com/docs/en/api/http/beta/organization/external_keys)
# Create External Key
Copy page
cURL
POST/v1/organizations/external_keys
Create an external key config owned by the caller's organization.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
##### Body
provider_config: [BetaAWSExternalKeyConfig](https://platform.claude.com/docs/en/api/http/beta/organization/external_keys#beta_aws_external_key_config) or [BetaGCPExternalKeyConfig](https://platform.claude.com/docs/en/api/http/beta/organization/external_keys#beta_gcp_external_key_config) or [BetaAzureExternalKeyConfigParam](https://platform.claude.com/docs/en/api/http/beta/organization/external_keys#beta_azure_external_key_config_param)
KMS provider identity and auth coordinates.
One of the following:
BetaAWSExternalKeyConfig object{ type: "aws", kms_arn, region, role_arn }
type: "aws"
kms_arn: string
Full ARN of the AWS KMS key. On Claude Platform on AWS the key must be a single-Region key in your organization's own AWS account; cross-account keys, multi-Region keys, and alias ARNs are rejected.
maxLength2048
region: optional string or null
AWS region. Derived from `kms_arn` if omitted.
role_arn: optional string or nullDeprecated
IAM role ARN. Deprecated — Anthropic reaches the KMS key through its own intermediate role (or, on Claude Platform on AWS, with credentials AWS issues for the Workspace); this field is ignored.
BetaGCPExternalKeyConfig object{ type: "gcp", key_name }
type: "gcp"
key_name: string
Full resource name of the Cloud KMS key.
BetaAzureExternalKeyConfigParam object{ type: "azure", key_name, tenant_id, 2 more }
Azure Key Vault provider configuration.
type: "azure"
key_name: string
Name of the key within the vault.
tenant_id: string
Azure AD tenant ID.
vault_uri: string
Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`.
client_id: optional string or null
Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory.
display_name: optional string or null
Human-friendly display name.
minLength1
maxLength255
geo: optional "us"
Data residency geo. Only `us` is supported.
##### Returns
BetaExternalKey object{ type: "external_key", id, attachment, 5 more }
CMEK external key config belonging to the caller's organization.
Configs are organization-scoped. Workspaces attach to a config; once any workspace references it, the provider fields become effectively immutable (existing encrypted data needs the config for decrypt).
Create External Key
cURL
```python
curl https://api.anthropic.com/v1/organizations/external_keys \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY" \
-d '{
"provider_config": {
"kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222",
"type": "aws"
}
}'
```
Response 200
```python
{
"id": "ekey_01SDCCSbTxrXDpWc1phhtcfK",
"attachment": {
"type": "attached"
},
"created_at": "2024-10-30T23:58:27.427722Z",
"display_name": "prod-us-key",
"geo": "us",
"provider_config": {
"kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222",
"type": "aws",
"region": "us-east-1",
"role_arn": "arn:aws:iam::111122223333:role/anthropic-cmek"
},
"type": "external_key",
"updated_at": "2024-10-30T23:58:27.427722Z"
}
```
##### Returns Examples
Response 200
```python
{
"id": "ekey_01SDCCSbTxrXDpWc1phhtcfK",
"attachment": {
"type": "attached"
},
"created_at": "2024-10-30T23:58:27.427722Z",
"display_name": "prod-us-key",
"geo": "us",
"provider_config": {
"kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222",
"type": "aws",
"region": "us-east-1",
"role_arn": "arn:aws:iam::111122223333:role/anthropic-cmek"
},
"type": "external_key",
"updated_at": "2024-10-30T23:58:27.427722Z"
---
## Delete External Key - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/external_keys/delete
Path: 04-API-Reference/Admin/beta-organization-external-keys-delete.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fexternal_keys%2Fdelete)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Create External Key
List External Keys
Get External Key
Update External Key
Delete External Key
Validate External Key
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [External Keys](https://platform.claude.com/docs/en/api/http/beta/organization/external_keys)
# Delete External Key
Copy page
cURL
DELETE/v1/organizations/external_keys/{external_key_id}
Delete an external key config.
The request is rejected if any workspace still references this config.
##### Path parameters
external_key_id: string
ID of the External Key.
maxLength2048
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
##### Returns
type: "external_key_deleted"
defaultexternal_key_deleted
id: string
ID of the deleted External Key.
Delete External Key
cURL
```python
curl https://api.anthropic.com/v1/organizations/external_keys/$EXTERNAL_KEY_ID \
-X DELETE \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"id": "ekey_01AbCdEfGhIjKlMnOpQrStUv",
"type": "external_key_deleted"
}
```
##### Returns Examples
Response 200
```python
{
"id": "ekey_01AbCdEfGhIjKlMnOpQrStUv",
"type": "external_key_deleted"
---
## List External Keys - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/external_keys/list
Path: 04-API-Reference/Admin/beta-organization-external-keys-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fexternal_keys%2Flist)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Create External Key
List External Keys
Get External Key
Update External Key
Delete External Key
Validate External Key
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [External Keys](https://platform.claude.com/docs/en/api/http/beta/organization/external_keys)
# List External Keys
Copy page
cURL
GET/v1/organizations/external_keys
List external key configs in the caller's organization.
Results are ordered by creation time (newest first). Use the `next_page` cursor from the response to fetch subsequent pages.
##### Query parameters
limit: optional number
Number of results per page.
default20
minimum1
maximum100
page: optional string
Opaque cursor from a previous response's `next_page`.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
##### Returns
data: array of [BetaExternalKey](https://platform.claude.com/docs/en/api/http/beta/organization/external_keys#beta_external_key) { type: "external_key", id, attachment, 5 more }
type: "external_key"
defaultexternal_key
id: string
Identifier of the external key config. A tagged ID prefixed `ekey_`, or — for organizations on the Claude Platform on AWS — the AWS KMS key ARN.
attachment: [BetaExternalKeyAttachedAttachment](https://platform.claude.com/docs/en/api/http/beta/organization/external_keys#beta_external_key_attached_attachment) or [BetaExternalKeyUnattachedAttachment](https://platform.claude.com/docs/en/api/http/beta/organization/external_keys#beta_external_key_unattached_attachment)
Whether any workspace uses this config to encrypt its data — counting live and archived workspaces (an archived workspace's data remains encrypted under the config), excluding deleted ones. Only an attached config is used by the encryption path; an `unattached` config is inert and can be deleted.
One of the following:
BetaExternalKeyAttachedAttachment object{ type: "attached" }
type: "attached"
defaultattached
BetaExternalKeyUnattachedAttachment object{ type: "unattached" }
type: "unattached"
defaultunattached
created_at: string
formatdate-time
display_name: string or null
Human-friendly display name. Null if none was set.
geo: string
Data residency geo. Selects which regional validator handles this key's encrypt/decrypt roundtrips.
provider_config: [BetaAWSExternalKeyConfig](https://platform.claude.com/docs/en/api/http/beta/organization/external_keys#beta_aws_external_key_config) or [BetaGCPExternalKeyConfig](https://platform.claude.com/docs/en/api/http/beta/organization/external_keys#beta_gcp_external_key_config) or [BetaAzureExternalKeyConfig](https://platform.claude.com/docs/en/api/http/beta/organization/external_keys#beta_azure_external_key_config)
KMS provider identity and auth coordinates.
One of the following:
BetaAWSExternalKeyConfig object{ type: "aws", kms_arn, region, role_arn }
type: "aws"
kms_arn: string
Full ARN of the AWS KMS key. On Claude Platform on AWS the key must be a single-Region key in your organization's own AWS account; cross-account keys, multi-Region keys, and alias ARNs are rejected.
maxLength2048
region: optional string or null
AWS region. Derived from `kms_arn` if omitted.
role_arn: optional string or nullDeprecated
IAM role ARN. Deprecated — Anthropic reaches the KMS key through its own intermediate role (or, on Claude Platform on AWS, with credentials AWS issues for the Workspace); this field is ignored.
BetaGCPExternalKeyConfig object{ type: "gcp", key_name }
type: "gcp"
key_name: string
Full resource name of the Cloud KMS key.
BetaAzureExternalKeyConfig object{ type: "azure", key_name, tenant_id, 2 more }
type: "azure"
key_name: string
Name of the key within the vault.
tenant_id: string
Azure AD tenant ID.
vault_uri: string
Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`.
client_id: optional string or null
Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory.
updated_at: string
formatdate-time
next_page: string or null
Opaque cursor for the next page, or null if no more results. Pass as `?page=` to fetch the next page.
List External Keys
cURL
```python
curl https://api.anthropic.com/v1/organizations/external_keys \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"data": [
{
"id": "ekey_01SDCCSbTxrXDpWc1phhtcfK",
"attachment": {
"type": "attached"
},
"created_at": "2024-10-30T23:58:27.427722Z",
"display_name": "prod-us-key",
"geo": "us",
"provider_config": {
"kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222",
"type": "aws",
"region": "us-east-1",
"role_arn": "arn:aws:iam::111122223333:role/anthropic-cmek"
},
"type": "external_key",
"updated_at": "2024-10-30T23:58:27.427722Z"
}
],
"next_page": "next_page"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"id": "ekey_01SDCCSbTxrXDpWc1phhtcfK",
"attachment": {
"type": "attached"
},
"created_at": "2024-10-30T23:58:27.427722Z",
"display_name": "prod-us-key",
"geo": "us",
"provider_config": {
"kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222",
"type": "aws",
"region": "us-east-1",
"role_arn": "arn:aws:iam::111122223333:role/anthropic-cmek"
},
"type": "external_key",
"updated_at": "2024-10-30T23:58:27.427722Z"
---
## Get External Key - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/external_keys/retrieve
Path: 04-API-Reference/Admin/beta-organization-external-keys-retrieve.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fexternal_keys%2Fretrieve)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Create External Key
List External Keys
Get External Key
Update External Key
Delete External Key
Validate External Key
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [External Keys](https://platform.claude.com/docs/en/api/http/beta/organization/external_keys)
# Get External Key
Copy page
cURL
GET/v1/organizations/external_keys/{external_key_id}
Retrieve a single external key config in the caller's organization by ID.
##### Path parameters
external_key_id: string
ID of the External Key.
maxLength2048
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
##### Returns
BetaExternalKey object{ type: "external_key", id, attachment, 5 more }
CMEK external key config belonging to the caller's organization.
Configs are organization-scoped. Workspaces attach to a config; once any workspace references it, the provider fields become effectively immutable (existing encrypted data needs the config for decrypt).
Get External Key
cURL
```python
curl https://api.anthropic.com/v1/organizations/external_keys/$EXTERNAL_KEY_ID \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"id": "ekey_01SDCCSbTxrXDpWc1phhtcfK",
"attachment": {
"type": "attached"
},
"created_at": "2024-10-30T23:58:27.427722Z",
"display_name": "prod-us-key",
"geo": "us",
"provider_config": {
"kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222",
"type": "aws",
"region": "us-east-1",
"role_arn": "arn:aws:iam::111122223333:role/anthropic-cmek"
},
"type": "external_key",
"updated_at": "2024-10-30T23:58:27.427722Z"
}
```
##### Returns Examples
Response 200
```python
{
"id": "ekey_01SDCCSbTxrXDpWc1phhtcfK",
"attachment": {
"type": "attached"
},
"created_at": "2024-10-30T23:58:27.427722Z",
"display_name": "prod-us-key",
"geo": "us",
"provider_config": {
"kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222",
"type": "aws",
"region": "us-east-1",
"role_arn": "arn:aws:iam::111122223333:role/anthropic-cmek"
},
"type": "external_key",
"updated_at": "2024-10-30T23:58:27.427722Z"
---
## Update External Key - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/external_keys/update
Path: 04-API-Reference/Admin/beta-organization-external-keys-update.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fexternal_keys%2Fupdate)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Create External Key
List External Keys
Get External Key
Update External Key
Delete External Key
Validate External Key
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [External Keys](https://platform.claude.com/docs/en/api/http/beta/organization/external_keys)
# Update External Key
Copy page
cURL
POST/v1/organizations/external_keys/{external_key_id}
Partially update an external key config. Omitted fields are left unchanged.
`display_name` is always editable. `geo` and `provider_config` cannot be changed once any workspace references this config, because previously encrypted data requires the original key identity to decrypt.
##### Path parameters
external_key_id: string
ID of the External Key.
maxLength2048
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
##### Body
display_name: optional string or null
Human-friendly display name.
minLength1
maxLength255
geo: optional "us" or null
Data residency geo. Only `us` is supported.
provider_config: optional [BetaAWSExternalKeyConfig](https://platform.claude.com/docs/en/api/http/beta/organization/external_keys#beta_aws_external_key_config) or [BetaGCPExternalKeyConfig](https://platform.claude.com/docs/en/api/http/beta/organization/external_keys#beta_gcp_external_key_config) or [BetaAzureExternalKeyConfigParam](https://platform.claude.com/docs/en/api/http/beta/organization/external_keys#beta_azure_external_key_config_param) or null
KMS provider identity and auth coordinates.
One of the following:
BetaAWSExternalKeyConfig object{ type: "aws", kms_arn, region, role_arn }
type: "aws"
kms_arn: string
Full ARN of the AWS KMS key. On Claude Platform on AWS the key must be a single-Region key in your organization's own AWS account; cross-account keys, multi-Region keys, and alias ARNs are rejected.
maxLength2048
region: optional string or null
AWS region. Derived from `kms_arn` if omitted.
role_arn: optional string or nullDeprecated
IAM role ARN. Deprecated — Anthropic reaches the KMS key through its own intermediate role (or, on Claude Platform on AWS, with credentials AWS issues for the Workspace); this field is ignored.
BetaGCPExternalKeyConfig object{ type: "gcp", key_name }
type: "gcp"
key_name: string
Full resource name of the Cloud KMS key.
BetaAzureExternalKeyConfigParam object{ type: "azure", key_name, tenant_id, 2 more }
Azure Key Vault provider configuration.
type: "azure"
key_name: string
Name of the key within the vault.
tenant_id: string
Azure AD tenant ID.
vault_uri: string
Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`.
client_id: optional string or null
Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory.
##### Returns
BetaExternalKey object{ type: "external_key", id, attachment, 5 more }
CMEK external key config belonging to the caller's organization.
Configs are organization-scoped. Workspaces attach to a config; once any workspace references it, the provider fields become effectively immutable (existing encrypted data needs the config for decrypt).
Update External Key
cURL
```python
curl https://api.anthropic.com/v1/organizations/external_keys/$EXTERNAL_KEY_ID \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY" \
-d '{}'
```
Response 200
```python
{
"id": "ekey_01SDCCSbTxrXDpWc1phhtcfK",
"attachment": {
"type": "attached"
},
"created_at": "2024-10-30T23:58:27.427722Z",
"display_name": "prod-us-key",
"geo": "us",
"provider_config": {
"kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222",
"type": "aws",
"region": "us-east-1",
"role_arn": "arn:aws:iam::111122223333:role/anthropic-cmek"
},
"type": "external_key",
"updated_at": "2024-10-30T23:58:27.427722Z"
}
```
##### Returns Examples
Response 200
```python
{
"id": "ekey_01SDCCSbTxrXDpWc1phhtcfK",
"attachment": {
"type": "attached"
},
"created_at": "2024-10-30T23:58:27.427722Z",
"display_name": "prod-us-key",
"geo": "us",
"provider_config": {
"kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222",
"type": "aws",
"region": "us-east-1",
"role_arn": "arn:aws:iam::111122223333:role/anthropic-cmek"
},
"type": "external_key",
"updated_at": "2024-10-30T23:58:27.427722Z"
---
## Validate External Key - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/external_keys/validate
Path: 04-API-Reference/Admin/beta-organization-external-keys-validate.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fexternal_keys%2Fvalidate)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Create External Key
List External Keys
Get External Key
Update External Key
Delete External Key
Validate External Key
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [External Keys](https://platform.claude.com/docs/en/api/http/beta/organization/external_keys)
# Validate External Key
Copy page
cURL
POST/v1/organizations/external_keys/{external_key_id}/validate
Validate an external key config against the customer's KMS.
Anthropic performs an encrypt/decrypt roundtrip against the configured KMS key and waits up to 30 seconds for the result. The response status is `success` if the roundtrip succeeded, or `failure` with an error message if it failed or timed out.
##### Path parameters
external_key_id: string
ID of the External Key.
maxLength2048
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
##### Returns
type: "external_key_validation"
defaultexternal_key_validation
error: string or null
Error message when status is `failure`. Null otherwise.
status: "failure" or "success"
`success` — encrypt/decrypt roundtrip succeeded. `failure` — the roundtrip failed or timed out; see `error`.
One of the following:
"failure"
"success"
Validate External Key
cURL
```python
curl https://api.anthropic.com/v1/organizations/external_keys/$EXTERNAL_KEY_ID/validate \
-X POST \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"error": "error",
"status": "failure",
"type": "external_key_validation"
}
```
##### Returns Examples
Response 200
```python
{
"error": "error",
"status": "failure",
"type": "external_key_validation"
---
## External Keys - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/external_keys
Path: 04-API-Reference/Admin/beta-organization-external-keys.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fexternal_keys)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Create External Key
List External Keys
Get External Key
Update External Key
Delete External Key
Validate External Key
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
# External Keys
Copy page
cURL
##### [Create External Key](https://platform.claude.com/docs/en/api/http/beta/organization/external_keys/create)
POST/v1/organizations/external_keys
Create an external key config owned by the caller's organization.
##### [List External Keys](https://platform.claude.com/docs/en/api/http/beta/organization/external_keys/list)
GET/v1/organizations/external_keys
List external key configs in the caller's organization.
##### [Get External Key](https://platform.claude.com/docs/en/api/http/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](https://platform.claude.com/docs/en/api/http/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](https://platform.claude.com/docs/en/api/http/beta/organization/external_keys/delete)
DELETE/v1/organizations/external_keys/{external_key_id}
Delete an external key config.
##### [Validate External Key](https://platform.claude.com/docs/en/api/http/beta/organization/external_keys/validate)
POST/v1/organizations/external_keys/{external_key_id}/validate
Validate an external key config against the customer's KMS.
##### Models
BetaAWSExternalKeyConfig object{ type: "aws", kms_arn, region, role_arn }
type: "aws"
kms_arn: string
Full ARN of the AWS KMS key. On Claude Platform on AWS the key must be a single-Region key in your organization's own AWS account; cross-account keys, multi-Region keys, and alias ARNs are rejected.
maxLength2048
region: optional string or null
AWS region. Derived from `kms_arn` if omitted.
role_arn: optional string or nullDeprecated
IAM role ARN. Deprecated — Anthropic reaches the KMS key through its own intermediate role (or, on Claude Platform on AWS, with credentials AWS issues for the Workspace); this field is ignored.
BetaAzureExternalKeyConfig object{ type: "azure", key_name, tenant_id, 2 more }
type: "azure"
key_name: string
Name of the key within the vault.
tenant_id: string
Azure AD tenant ID.
vault_uri: string
Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`.
client_id: optional string or null
Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory.
BetaAzureExternalKeyConfigParam object{ type: "azure", key_name, tenant_id, 2 more }
Azure Key Vault provider configuration.
type: "azure"
key_name: string
Name of the key within the vault.
tenant_id: string
Azure AD tenant ID.
vault_uri: string
Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`.
client_id: optional string or null
Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory.
BetaExternalKey object{ type: "external_key", id, attachment, 5 more }
CMEK external key config belonging to the caller's organization.
Configs are organization-scoped. Workspaces attach to a config; once any workspace references it, the provider fields become effectively immutable (existing encrypted data needs the config for decrypt).
BetaExternalKeyAttachedAttachment object{ type: "attached" }
type: "attached"
defaultattached
BetaExternalKeyUnattachedAttachment object{ type: "unattached" }
type: "unattached"
defaultunattached
BetaGCPExternalKeyConfig object{ type: "gcp", key_name }
type: "gcp"
key_name: string
Full resource name of the Cloud KMS key.
ExternalKeyDeleteResponse object{ type: "external_key_deleted", id }
type: "external_key_deleted"
defaultexternal_key_deleted
id: string
ID of the deleted External Key.
ExternalKeyValidateResponse object{ type: "external_key_validation", error, status }
Result of a validation roundtrip against the customer's KMS.
HTTP 200 for both outcomes — the operation completed; `status` says whether the key works.
type: "external_key_validation"
defaultexternal_key_validation
error: string or null
Error message when status is `failure`. Null otherwise.
status: "failure" or "success"
`success` — encrypt/decrypt roundtrip succeeded. `failure` — the roundtrip failed or timed out; see `error`.
---
## Archive Federation Issuer - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/federation/issuers/archive
Path: 04-API-Reference/Admin/beta-organization-federation-issuers-archive.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Ffederation%2Fissuers%2Farchive)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Issuers
Create Federation Issuer
List Federation Issuers
Get Federation Issuer
Update Federation Issuer
Archive Federation Issuer
Rules
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Federation](https://platform.claude.com/docs/en/api/http/beta/organization/federation)
5. [Issuers](https://platform.claude.com/docs/en/api/http/beta/organization/federation/issuers)
# Archive Federation Issuer
Copy page
cURL
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](../Other/manage-claude-wif-admin-api.md).
Archive a federation issuer.
Idempotent; re-archiving returns the issuer with its original `archived_at`. Rejected with 400 if any live (non-archived) federation rule still references the issuer; archive those rules first (a rule's issuer cannot be changed), or recreate them against another issuer.
##### Path parameters
federation_issuer_id: string
ID of the federation issuer to archive.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"anthropic-beta": optional array of [AnthropicBeta](../Endpoints/platform-claude-com-http-beta.md#anthropic_beta)
Optional header to specify the beta version(s) you want to use.
One of the following:
string
"message-batches-2024-09-24"
"prompt-caching-2024-07-31"
"computer-use-2024-10-22"
"computer-use-2025-01-24"
"pdfs-2024-09-25"
"token-counting-2024-11-01"
"token-efficient-tools-2025-02-19"
"output-128k-2025-02-19"
"files-api-2025-04-14"
"mcp-client-2025-04-04"
"mcp-client-2025-11-20"
"dev-full-thinking-2025-05-14"
"interleaved-thinking-2025-05-14"
"code-execution-2025-05-22"
"extended-cache-ttl-2025-04-11"
"context-1m-2025-08-07"
"context-management-2025-06-27"
"model-context-window-exceeded-2025-08-26"
"skills-2025-10-02"
"fast-mode-2026-02-01"
"output-300k-2026-03-24"
"user-profiles-2026-03-24"
"user-profiles-2026-08-18"
"user-profiles-2026-09-04"
"advisor-tool-2026-03-01"
"managed-agents-2026-04-01"
"cache-diagnosis-2026-04-07"
"dreaming-2026-04-21"
"thinking-token-count-2026-05-13"
"server-side-fallback-2026-06-01"
"server-side-fallback-2026-07-01"
"fallback-credit-2026-06-01"
"fallback-credit-2026-07-01"
"agent-memory-2026-07-22"
"mid-conversation-tool-changes-2026-07-01"
"compact-2026-01-12"
"computer-use-2025-11-24"
"mcp-tunnels-2026-06-22"
"structured-outputs-2025-11-13"
"task-budgets-2026-03-13"
"thinking-display-updates-2026-08-18"
"ce-user-management-2026-07-13"
"mid-conversation-output-config-2026-07-01"
"thinking-binding-controls-2026-08-01"
"mid-conversation-system-clear-at-2026-08-21"
"compact-2026-09-04"
"inline-tools-2026-09-15"
"mcp-client-2026-09-15"
"ce-plugins-2026-09-01"
"spend-limit-reads-2026-09-26"
"telemetry-destinations-2026-08-11"
"webhooks-2026-10-07"
##### Returns
BetaFederationIssuer object{ type: "federation_issuer", id, archived_at, 12 more }
Registered external OIDC identity provider.
Records an external IdP the organization trusts for the RFC 7523 jwt-bearer grant. The `issuer_url` must match the JWT `iss` claim exactly.
Archive Federation Issuer
cURL
```python
curl https://api.anthropic.com/v1/organizations/federation_issuers/$FEDERATION_ISSUER_ID/archive \
-X POST \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"id": "fdis_01SDCCSbTxrXDpWc1phhtcfK",
"archived_at": "2019-12-27T18:11:19.117Z",
"archived_by_actor_id": "archived_by_actor_id",
"check_jti": true,
"created_at": "2024-10-30T23:58:27.427722Z",
"created_by_actor_id": "created_by_actor_id",
"issuer_url": "https://token.actions.githubusercontent.com",
"jwks": {
"type": "discovery",
"ca_cert_pem": "ca_cert_pem",
"discovery_base": "discovery_base"
},
"jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z",
"max_jwt_lifetime_seconds": 0,
"name": "github-actions",
"poll_status": {
"consecutive_failures": 0,
"last_fetched_at": "2019-12-27T18:11:19.117Z",
"next_poll_at": "2019-12-27T18:11:19.117Z"
},
"type": "federation_issuer",
"updated_at": "2024-10-30T23:58:27.427722Z",
"updated_by_actor_id": "updated_by_actor_id"
}
```
##### Returns Examples
Response 200
```python
{
"id": "fdis_01SDCCSbTxrXDpWc1phhtcfK",
"archived_at": "2019-12-27T18:11:19.117Z",
"archived_by_actor_id": "archived_by_actor_id",
"check_jti": true,
"created_at": "2024-10-30T23:58:27.427722Z",
"created_by_actor_id": "created_by_actor_id",
"issuer_url": "https://token.actions.githubusercontent.com",
"jwks": {
"type": "discovery",
"ca_cert_pem": "ca_cert_pem",
"discovery_base": "discovery_base"
},
"jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z",
"max_jwt_lifetime_seconds": 0,
"name": "github-actions",
"poll_status": {
"consecutive_failures": 0,
"last_fetched_at": "2019-12-27T18:11:19.117Z",
"next_poll_at": "2019-12-27T18:11:19.117Z"
},
"type": "federation_issuer",
"updated_at": "2024-10-30T23:58:27.427722Z",
"updated_by_actor_id": "updated_by_actor_id"
---
## Create Federation Issuer - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/federation/issuers/create
Path: 04-API-Reference/Admin/beta-organization-federation-issuers-create.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Ffederation%2Fissuers%2Fcreate)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Issuers
Create Federation Issuer
List Federation Issuers
Get Federation Issuer
Update Federation Issuer
Archive Federation Issuer
Rules
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Federation](https://platform.claude.com/docs/en/api/http/beta/organization/federation)
5. [Issuers](https://platform.claude.com/docs/en/api/http/beta/organization/federation/issuers)
# Create Federation Issuer
Copy page
cURL
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](../Other/manage-claude-wif-admin-api.md).
Register an OIDC issuer that Anthropic will trust for workload identity federation in your organization.
The `jwks` field controls how the issuer's signing keys are obtained and takes one of three shapes selected by `type`: `discovery` (resolve keys through OIDC discovery), `explicit_url` (fetch keys from a fixed JWKS URL), or `inline` (provide a static key set). When `jwks.type` is `discovery` and no `discovery_base` is set, the issuer URL must be publicly reachable over HTTPS so Anthropic can fetch the discovery document; for `explicit_url` and `inline` modes the issuer URL is only matched as the JWT's `iss` claim and is not fetched.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"anthropic-beta": optional array of [AnthropicBeta](../Endpoints/platform-claude-com-http-beta.md#anthropic_beta)
Optional header to specify the beta version(s) you want to use.
One of the following:
string
"message-batches-2024-09-24"
"prompt-caching-2024-07-31"
"computer-use-2024-10-22"
"computer-use-2025-01-24"
"pdfs-2024-09-25"
"token-counting-2024-11-01"
"token-efficient-tools-2025-02-19"
"output-128k-2025-02-19"
"files-api-2025-04-14"
"mcp-client-2025-04-04"
"mcp-client-2025-11-20"
"dev-full-thinking-2025-05-14"
"interleaved-thinking-2025-05-14"
"code-execution-2025-05-22"
"extended-cache-ttl-2025-04-11"
"context-1m-2025-08-07"
"context-management-2025-06-27"
"model-context-window-exceeded-2025-08-26"
"skills-2025-10-02"
"fast-mode-2026-02-01"
"output-300k-2026-03-24"
"user-profiles-2026-03-24"
"user-profiles-2026-08-18"
"user-profiles-2026-09-04"
"advisor-tool-2026-03-01"
"managed-agents-2026-04-01"
"cache-diagnosis-2026-04-07"
"dreaming-2026-04-21"
"thinking-token-count-2026-05-13"
"server-side-fallback-2026-06-01"
"server-side-fallback-2026-07-01"
"fallback-credit-2026-06-01"
"fallback-credit-2026-07-01"
"agent-memory-2026-07-22"
"mid-conversation-tool-changes-2026-07-01"
"compact-2026-01-12"
"computer-use-2025-11-24"
"mcp-tunnels-2026-06-22"
"structured-outputs-2025-11-13"
"task-budgets-2026-03-13"
"thinking-display-updates-2026-08-18"
"ce-user-management-2026-07-13"
"mid-conversation-output-config-2026-07-01"
"thinking-binding-controls-2026-08-01"
"mid-conversation-system-clear-at-2026-08-21"
"compact-2026-09-04"
"inline-tools-2026-09-15"
"mcp-client-2026-09-15"
"ce-plugins-2026-09-01"
"spend-limit-reads-2026-09-26"
"telemetry-destinations-2026-08-11"
"webhooks-2026-10-07"
##### Body
issuer_url: string
The `iss` claim value to match against.
minLength1
name: string
Slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409.
minLength1
maxLength255
check_jti: optional boolean or null
Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Defaults to true. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement.
jwks: optional [BetaJWKSDiscovery](https://platform.claude.com/docs/en/api/http/beta/organization/federation/issuers#beta_jwks_discovery) or [BetaJWKSExplicitURL](https://platform.claude.com/docs/en/api/http/beta/organization/federation/issuers#beta_jwks_explicit_url) or [BetaJWKSInline](https://platform.claude.com/docs/en/api/http/beta/organization/federation/issuers#beta_jwks_inline)
How signing keys are obtained. Defaults to OIDC discovery.
One of the following:
BetaJWKSDiscovery object{ type: "discovery", ca_cert_pem, discovery_base }
JWKS via the issuer's OIDC discovery document.
type: "discovery"
ca_cert_pem: optional string or null
Optional custom CA (PEM) for TLS verification of the JWKS fetch.
maxLength8192
discovery_base: optional string or null
Set when the discovery URL differs from `issuer_url`.
BetaJWKSExplicitURL object{ type: "explicit_url", url, ca_cert_pem }
JWKS fetched from a fixed endpoint.
type: "explicit_url"
url: string
JWKS endpoint.
minLength1
ca_cert_pem: optional string or null
Optional custom CA (PEM) for TLS verification of the JWKS fetch.
maxLength8192
BetaJWKSInline object{ type: "inline", keys }
JWKS supplied directly; no network fetch.
type: "inline"
keys: array of map\[unknown\]
Inline JWK objects.
minItems1
max_jwt_lifetime_seconds: optional number or null
Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Defaults to 3600 (1h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected.
minimum1
maximum176400
##### Returns
BetaFederationIssuer object{ type: "federation_issuer", id, archived_at, 12 more }
Registered external OIDC identity provider.
Records an external IdP the organization trusts for the RFC 7523 jwt-bearer grant. The `issuer_url` must match the JWT `iss` claim exactly.
Create Federation Issuer
cURL
```python
curl https://api.anthropic.com/v1/organizations/federation_issuers \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY" \
-d '{
"issuer_url": "x",
"name": "x"
}'
```
Response 200
```python
{
"id": "fdis_01SDCCSbTxrXDpWc1phhtcfK",
"archived_at": "2019-12-27T18:11:19.117Z",
"archived_by_actor_id": "archived_by_actor_id",
"check_jti": true,
"created_at": "2024-10-30T23:58:27.427722Z",
"created_by_actor_id": "created_by_actor_id",
"issuer_url": "https://token.actions.githubusercontent.com",
"jwks": {
"type": "discovery",
"ca_cert_pem": "ca_cert_pem",
"discovery_base": "discovery_base"
},
"jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z",
"max_jwt_lifetime_seconds": 0,
"name": "github-actions",
"poll_status": {
"consecutive_failures": 0,
"last_fetched_at": "2019-12-27T18:11:19.117Z",
"next_poll_at": "2019-12-27T18:11:19.117Z"
},
"type": "federation_issuer",
"updated_at": "2024-10-30T23:58:27.427722Z",
"updated_by_actor_id": "updated_by_actor_id"
}
```
##### Returns Examples
Response 200
```python
{
"id": "fdis_01SDCCSbTxrXDpWc1phhtcfK",
"archived_at": "2019-12-27T18:11:19.117Z",
"archived_by_actor_id": "archived_by_actor_id",
"check_jti": true,
"created_at": "2024-10-30T23:58:27.427722Z",
"created_by_actor_id": "created_by_actor_id",
"issuer_url": "https://token.actions.githubusercontent.com",
"jwks": {
"type": "discovery",
"ca_cert_pem": "ca_cert_pem",
"discovery_base": "discovery_base"
},
"jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z",
"max_jwt_lifetime_seconds": 0,
"name": "github-actions",
"poll_status": {
"consecutive_failures": 0,
"last_fetched_at": "2019-12-27T18:11:19.117Z",
"next_poll_at": "2019-12-27T18:11:19.117Z"
},
"type": "federation_issuer",
"updated_at": "2024-10-30T23:58:27.427722Z",
"updated_by_actor_id": "updated_by_actor_id"
---
## List Federation Issuers - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/federation/issuers/list
Path: 04-API-Reference/Admin/beta-organization-federation-issuers-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Ffederation%2Fissuers%2Flist)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Issuers
Create Federation Issuer
List Federation Issuers
Get Federation Issuer
Update Federation Issuer
Archive Federation Issuer
Rules
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Federation](https://platform.claude.com/docs/en/api/http/beta/organization/federation)
5. [Issuers](https://platform.claude.com/docs/en/api/http/beta/organization/federation/issuers)
# List Federation Issuers
Copy page
cURL
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](../Other/manage-claude-wif-admin-api.md).
List federation issuers in your organization.
Archived issuers are excluded unless `include_archived=true`.
##### Query parameters
include_archived: optional boolean
Include archived resources. Defaults to false.
defaultfalse
limit: optional number
Number of results per page.
default20
minimum1
maximum100
page: optional string
Opaque cursor from a previous response's `next_page`.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"anthropic-beta": optional array of [AnthropicBeta](../Endpoints/platform-claude-com-http-beta.md#anthropic_beta)
Optional header to specify the beta version(s) you want to use.
One of the following:
string
"message-batches-2024-09-24"
"prompt-caching-2024-07-31"
"computer-use-2024-10-22"
"computer-use-2025-01-24"
"pdfs-2024-09-25"
"token-counting-2024-11-01"
"token-efficient-tools-2025-02-19"
"output-128k-2025-02-19"
"files-api-2025-04-14"
"mcp-client-2025-04-04"
"mcp-client-2025-11-20"
"dev-full-thinking-2025-05-14"
"interleaved-thinking-2025-05-14"
"code-execution-2025-05-22"
"extended-cache-ttl-2025-04-11"
"context-1m-2025-08-07"
"context-management-2025-06-27"
"model-context-window-exceeded-2025-08-26"
"skills-2025-10-02"
"fast-mode-2026-02-01"
"output-300k-2026-03-24"
"user-profiles-2026-03-24"
"user-profiles-2026-08-18"
"user-profiles-2026-09-04"
"advisor-tool-2026-03-01"
"managed-agents-2026-04-01"
"cache-diagnosis-2026-04-07"
"dreaming-2026-04-21"
"thinking-token-count-2026-05-13"
"server-side-fallback-2026-06-01"
"server-side-fallback-2026-07-01"
"fallback-credit-2026-06-01"
"fallback-credit-2026-07-01"
"agent-memory-2026-07-22"
"mid-conversation-tool-changes-2026-07-01"
"compact-2026-01-12"
"computer-use-2025-11-24"
"mcp-tunnels-2026-06-22"
"structured-outputs-2025-11-13"
"task-budgets-2026-03-13"
"thinking-display-updates-2026-08-18"
"ce-user-management-2026-07-13"
"mid-conversation-output-config-2026-07-01"
"thinking-binding-controls-2026-08-01"
"mid-conversation-system-clear-at-2026-08-21"
"compact-2026-09-04"
"inline-tools-2026-09-15"
"mcp-client-2026-09-15"
"ce-plugins-2026-09-01"
"spend-limit-reads-2026-09-26"
"telemetry-destinations-2026-08-11"
"webhooks-2026-10-07"
##### Returns
data: array of [BetaFederationIssuer](https://platform.claude.com/docs/en/api/http/beta/organization/federation/issuers#beta_federation_issuer) { type: "federation_issuer", id, archived_at, 12 more }
type: "federation_issuer"
defaultfederation_issuer
id: string
Tagged ID of the federation issuer.
archived_at: string or null
If set, all rules referencing this issuer reject token exchange.
formatdate-time
archived_by_actor_id: string or null
Tagged ID (`user_`/`svac_`) of the actor that archived this issuer.
check_jti: boolean
Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement.
created_at: string
When this issuer was created.
formatdate-time
created_by_actor_id: string or null
Tagged ID (`user_`/`svac_`) of the actor that created this issuer.
issuer_url: string
The `iss` claim value. Incoming JWTs must match exactly.
jwks: [BetaJWKSDiscovery](https://platform.claude.com/docs/en/api/http/beta/organization/federation/issuers#beta_jwks_discovery) or [BetaJWKSExplicitURL](https://platform.claude.com/docs/en/api/http/beta/organization/federation/issuers#beta_jwks_explicit_url) or [BetaJWKSInline](https://platform.claude.com/docs/en/api/http/beta/organization/federation/issuers#beta_jwks_inline)
How signing keys are obtained for signature verification.
One of the following:
BetaJWKSDiscovery object{ type: "discovery", ca_cert_pem, discovery_base }
JWKS via the issuer's OIDC discovery document.
type: "discovery"
ca_cert_pem: optional string or null
Optional custom CA (PEM) for TLS verification of the JWKS fetch.
maxLength8192
discovery_base: optional string or null
Set when the discovery URL differs from `issuer_url`.
BetaJWKSExplicitURL object{ type: "explicit_url", url, ca_cert_pem }
JWKS fetched from a fixed endpoint.
type: "explicit_url"
url: string
JWKS endpoint.
minLength1
ca_cert_pem: optional string or null
Optional custom CA (PEM) for TLS verification of the JWKS fetch.
maxLength8192
BetaJWKSInline object{ type: "inline", keys }
JWKS supplied directly; no network fetch.
type: "inline"
keys: array of map\[unknown\]
Inline JWK objects.
minItems1
jwks_polling_disabled_at: string or null
If set, Anthropic's JWKS poller has paused polling for this issuer after repeated fetch failures. Re-enable by sending `jwks_polling_disabled: false` via the issuer update endpoint (POST) once the upstream JWKS endpoint is fixed. An OAuth caller cannot send this when the issuer backs a rule with any scope other than `workspace:developer` or `workspace:inference`; use a Console session.
formatdate-time
max_jwt_lifetime_seconds: number
Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected.
name: string
Admin-chosen slug identifier.
poll_status: [BetaFederationIssuerPollStatus](https://platform.claude.com/docs/en/api/http/beta/organization/federation/issuers#beta_federation_issuer_poll_status) { consecutive_failures, last_fetched_at, next_poll_at } or null
Live state of Anthropic's JWKS polling for this issuer. Populated on both single-issuer retrieval and list responses, including archived issuers. Typically null for inline-key issuers (no polling), or when poll status is temporarily unavailable or polling has not started yet.
consecutive_failures: number
Consecutive fetch failures since the last success.
last_fetched_at: string or null
When the last successful fetch completed.
formatdate-time
next_poll_at: string or null
When the next fetch is scheduled. Null if paused.
formatdate-time
updated_at: string
When this issuer was last updated.
formatdate-time
updated_by_actor_id: string or null
Tagged ID (`user_`/`svac_`) of the actor that last updated this issuer.
next_page: string or null
Opaque cursor for the next page, or null if no more results.
List Federation Issuers
cURL
```python
curl https://api.anthropic.com/v1/organizations/federation_issuers \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"data": [
{
"id": "fdis_01SDCCSbTxrXDpWc1phhtcfK",
"archived_at": "2019-12-27T18:11:19.117Z",
"archived_by_actor_id": "archived_by_actor_id",
"check_jti": true,
"created_at": "2024-10-30T23:58:27.427722Z",
"created_by_actor_id": "created_by_actor_id",
"issuer_url": "https://token.actions.githubusercontent.com",
"jwks": {
"type": "discovery",
"ca_cert_pem": "ca_cert_pem",
"discovery_base": "discovery_base"
},
"jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z",
"max_jwt_lifetime_seconds": 0,
"name": "github-actions",
"poll_status": {
"consecutive_failures": 0,
"last_fetched_at": "2019-12-27T18:11:19.117Z",
"next_poll_at": "2019-12-27T18:11:19.117Z"
},
"type": "federation_issuer",
"updated_at": "2024-10-30T23:58:27.427722Z",
"updated_by_actor_id": "updated_by_actor_id"
}
],
"next_page": "next_page"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"id": "fdis_01SDCCSbTxrXDpWc1phhtcfK",
"archived_at": "2019-12-27T18:11:19.117Z",
"archived_by_actor_id": "archived_by_actor_id",
"check_jti": true,
"created_at": "2024-10-30T23:58:27.427722Z",
"created_by_actor_id": "created_by_actor_id",
"issuer_url": "https://token.actions.githubusercontent.com",
"jwks": {
"type": "discovery",
"ca_cert_pem": "ca_cert_pem",
"discovery_base": "discovery_base"
},
"jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z",
"max_jwt_lifetime_seconds": 0,
"name": "github-actions",
"poll_status": {
"consecutive_failures": 0,
"last_fetched_at": "2019-12-27T18:11:19.117Z",
"next_poll_at": "2019-12-27T18:11:19.117Z"
},
"type": "federation_issuer",
"updated_at": "2024-10-30T23:58:27.427722Z",
"updated_by_actor_id": "updated_by_actor_id"
---
## Get Federation Issuer - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/federation/issuers/retrieve
Path: 04-API-Reference/Admin/beta-organization-federation-issuers-retrieve.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Ffederation%2Fissuers%2Fretrieve)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Issuers
Create Federation Issuer
List Federation Issuers
Get Federation Issuer
Update Federation Issuer
Archive Federation Issuer
Rules
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Federation](https://platform.claude.com/docs/en/api/http/beta/organization/federation)
5. [Issuers](https://platform.claude.com/docs/en/api/http/beta/organization/federation/issuers)
# Get Federation Issuer
Copy page
cURL
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](../Other/manage-claude-wif-admin-api.md).
Retrieve a federation issuer by its ID (`fdis_...`).
##### Path parameters
federation_issuer_id: string
ID of the federation issuer.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"anthropic-beta": optional array of [AnthropicBeta](../Endpoints/platform-claude-com-http-beta.md#anthropic_beta)
Optional header to specify the beta version(s) you want to use.
One of the following:
string
"message-batches-2024-09-24"
"prompt-caching-2024-07-31"
"computer-use-2024-10-22"
"computer-use-2025-01-24"
"pdfs-2024-09-25"
"token-counting-2024-11-01"
"token-efficient-tools-2025-02-19"
"output-128k-2025-02-19"
"files-api-2025-04-14"
"mcp-client-2025-04-04"
"mcp-client-2025-11-20"
"dev-full-thinking-2025-05-14"
"interleaved-thinking-2025-05-14"
"code-execution-2025-05-22"
"extended-cache-ttl-2025-04-11"
"context-1m-2025-08-07"
"context-management-2025-06-27"
"model-context-window-exceeded-2025-08-26"
"skills-2025-10-02"
"fast-mode-2026-02-01"
"output-300k-2026-03-24"
"user-profiles-2026-03-24"
"user-profiles-2026-08-18"
"user-profiles-2026-09-04"
"advisor-tool-2026-03-01"
"managed-agents-2026-04-01"
"cache-diagnosis-2026-04-07"
"dreaming-2026-04-21"
"thinking-token-count-2026-05-13"
"server-side-fallback-2026-06-01"
"server-side-fallback-2026-07-01"
"fallback-credit-2026-06-01"
"fallback-credit-2026-07-01"
"agent-memory-2026-07-22"
"mid-conversation-tool-changes-2026-07-01"
"compact-2026-01-12"
"computer-use-2025-11-24"
"mcp-tunnels-2026-06-22"
"structured-outputs-2025-11-13"
"task-budgets-2026-03-13"
"thinking-display-updates-2026-08-18"
"ce-user-management-2026-07-13"
"mid-conversation-output-config-2026-07-01"
"thinking-binding-controls-2026-08-01"
"mid-conversation-system-clear-at-2026-08-21"
"compact-2026-09-04"
"inline-tools-2026-09-15"
"mcp-client-2026-09-15"
"ce-plugins-2026-09-01"
"spend-limit-reads-2026-09-26"
"telemetry-destinations-2026-08-11"
"webhooks-2026-10-07"
##### Returns
BetaFederationIssuer object{ type: "federation_issuer", id, archived_at, 12 more }
Registered external OIDC identity provider.
Records an external IdP the organization trusts for the RFC 7523 jwt-bearer grant. The `issuer_url` must match the JWT `iss` claim exactly.
Get Federation Issuer
cURL
```python
curl https://api.anthropic.com/v1/organizations/federation_issuers/$FEDERATION_ISSUER_ID \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"id": "fdis_01SDCCSbTxrXDpWc1phhtcfK",
"archived_at": "2019-12-27T18:11:19.117Z",
"archived_by_actor_id": "archived_by_actor_id",
"check_jti": true,
"created_at": "2024-10-30T23:58:27.427722Z",
"created_by_actor_id": "created_by_actor_id",
"issuer_url": "https://token.actions.githubusercontent.com",
"jwks": {
"type": "discovery",
"ca_cert_pem": "ca_cert_pem",
"discovery_base": "discovery_base"
},
"jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z",
"max_jwt_lifetime_seconds": 0,
"name": "github-actions",
"poll_status": {
"consecutive_failures": 0,
"last_fetched_at": "2019-12-27T18:11:19.117Z",
"next_poll_at": "2019-12-27T18:11:19.117Z"
},
"type": "federation_issuer",
"updated_at": "2024-10-30T23:58:27.427722Z",
"updated_by_actor_id": "updated_by_actor_id"
}
```
##### Returns Examples
Response 200
```python
{
"id": "fdis_01SDCCSbTxrXDpWc1phhtcfK",
"archived_at": "2019-12-27T18:11:19.117Z",
"archived_by_actor_id": "archived_by_actor_id",
"check_jti": true,
"created_at": "2024-10-30T23:58:27.427722Z",
"created_by_actor_id": "created_by_actor_id",
"issuer_url": "https://token.actions.githubusercontent.com",
"jwks": {
"type": "discovery",
"ca_cert_pem": "ca_cert_pem",
"discovery_base": "discovery_base"
},
"jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z",
"max_jwt_lifetime_seconds": 0,
"name": "github-actions",
"poll_status": {
"consecutive_failures": 0,
"last_fetched_at": "2019-12-27T18:11:19.117Z",
"next_poll_at": "2019-12-27T18:11:19.117Z"
},
"type": "federation_issuer",
"updated_at": "2024-10-30T23:58:27.427722Z",
"updated_by_actor_id": "updated_by_actor_id"
---
## Update Federation Issuer - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/federation/issuers/update
Path: 04-API-Reference/Admin/beta-organization-federation-issuers-update.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Ffederation%2Fissuers%2Fupdate)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Issuers
Create Federation Issuer
List Federation Issuers
Get Federation Issuer
Update Federation Issuer
Archive Federation Issuer
Rules
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Federation](https://platform.claude.com/docs/en/api/http/beta/organization/federation)
5. [Issuers](https://platform.claude.com/docs/en/api/http/beta/organization/federation/issuers)
# Update Federation Issuer
Copy page
cURL
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](../Other/manage-claude-wif-admin-api.md).
Partially update a federation issuer.
Setting `jwks` replaces the full JWKS shape at once. Archived issuers cannot be updated; this returns 400. Create a new issuer instead.
Updating an issuer that backs a rule with a scope outside `workspace:developer` or `workspace:inference` requires a Console session.
##### Path parameters
federation_issuer_id: string
ID of the federation issuer to update.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"anthropic-beta": optional array of [AnthropicBeta](../Endpoints/platform-claude-com-http-beta.md#anthropic_beta)
Optional header to specify the beta version(s) you want to use.
One of the following:
string
"message-batches-2024-09-24"
"prompt-caching-2024-07-31"
"computer-use-2024-10-22"
"computer-use-2025-01-24"
"pdfs-2024-09-25"
"token-counting-2024-11-01"
"token-efficient-tools-2025-02-19"
"output-128k-2025-02-19"
"files-api-2025-04-14"
"mcp-client-2025-04-04"
"mcp-client-2025-11-20"
"dev-full-thinking-2025-05-14"
"interleaved-thinking-2025-05-14"
"code-execution-2025-05-22"
"extended-cache-ttl-2025-04-11"
"context-1m-2025-08-07"
"context-management-2025-06-27"
"model-context-window-exceeded-2025-08-26"
"skills-2025-10-02"
"fast-mode-2026-02-01"
"output-300k-2026-03-24"
"user-profiles-2026-03-24"
"user-profiles-2026-08-18"
"user-profiles-2026-09-04"
"advisor-tool-2026-03-01"
"managed-agents-2026-04-01"
"cache-diagnosis-2026-04-07"
"dreaming-2026-04-21"
"thinking-token-count-2026-05-13"
"server-side-fallback-2026-06-01"
"server-side-fallback-2026-07-01"
"fallback-credit-2026-06-01"
"fallback-credit-2026-07-01"
"agent-memory-2026-07-22"
"mid-conversation-tool-changes-2026-07-01"
"compact-2026-01-12"
"computer-use-2025-11-24"
"mcp-tunnels-2026-06-22"
"structured-outputs-2025-11-13"
"task-budgets-2026-03-13"
"thinking-display-updates-2026-08-18"
"ce-user-management-2026-07-13"
"mid-conversation-output-config-2026-07-01"
"thinking-binding-controls-2026-08-01"
"mid-conversation-system-clear-at-2026-08-21"
"compact-2026-09-04"
"inline-tools-2026-09-15"
"mcp-client-2026-09-15"
"ce-plugins-2026-09-01"
"spend-limit-reads-2026-09-26"
"telemetry-destinations-2026-08-11"
"webhooks-2026-10-07"
##### Body
check_jti: optional boolean or null
Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement.
issuer_url: optional string or null
Replaces the `iss` claim value to match against. For discovery-mode issuers without a `discovery_base`, this is also the URL Anthropic fetches the OIDC discovery document and signing keys from, so changing it repoints the JWKS source. Changing the issuer URL to a well-known shared platform is rejected while any live rule under this issuer would not constrain tenant identity.
minLength1
jwks: optional [BetaJWKSDiscovery](https://platform.claude.com/docs/en/api/http/beta/organization/federation/issuers#beta_jwks_discovery) or [BetaJWKSExplicitURL](https://platform.claude.com/docs/en/api/http/beta/organization/federation/issuers#beta_jwks_explicit_url) or [BetaJWKSInline](https://platform.claude.com/docs/en/api/http/beta/organization/federation/issuers#beta_jwks_inline) or null
Replaces the entire JWKS configuration.
One of the following:
BetaJWKSDiscovery object{ type: "discovery", ca_cert_pem, discovery_base }
JWKS via the issuer's OIDC discovery document.
type: "discovery"
ca_cert_pem: optional string or null
Optional custom CA (PEM) for TLS verification of the JWKS fetch.
maxLength8192
discovery_base: optional string or null
Set when the discovery URL differs from `issuer_url`.
BetaJWKSExplicitURL object{ type: "explicit_url", url, ca_cert_pem }
JWKS fetched from a fixed endpoint.
type: "explicit_url"
url: string
JWKS endpoint.
minLength1
ca_cert_pem: optional string or null
Optional custom CA (PEM) for TLS verification of the JWKS fetch.
maxLength8192
BetaJWKSInline object{ type: "inline", keys }
JWKS supplied directly; no network fetch.
type: "inline"
keys: array of map\[unknown\]
Inline JWK objects.
minItems1
jwks_polling_disabled: optional boolean or null
Only `false` is accepted, to re-enable polling after the system pauses it. Polling is paused automatically; sending `true` is rejected.
max_jwt_lifetime_seconds: optional number or null
Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected.
minimum1
maximum176400
name: optional string or null
Replaces the slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409.
minLength1
maxLength255
##### Returns
BetaFederationIssuer object{ type: "federation_issuer", id, archived_at, 12 more }
Registered external OIDC identity provider.
Records an external IdP the organization trusts for the RFC 7523 jwt-bearer grant. The `issuer_url` must match the JWT `iss` claim exactly.
Update Federation Issuer
cURL
```python
curl https://api.anthropic.com/v1/organizations/federation_issuers/$FEDERATION_ISSUER_ID \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY" \
-d '{}'
```
Response 200
```python
{
"id": "fdis_01SDCCSbTxrXDpWc1phhtcfK",
"archived_at": "2019-12-27T18:11:19.117Z",
"archived_by_actor_id": "archived_by_actor_id",
"check_jti": true,
"created_at": "2024-10-30T23:58:27.427722Z",
"created_by_actor_id": "created_by_actor_id",
"issuer_url": "https://token.actions.githubusercontent.com",
"jwks": {
"type": "discovery",
"ca_cert_pem": "ca_cert_pem",
"discovery_base": "discovery_base"
},
"jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z",
"max_jwt_lifetime_seconds": 0,
"name": "github-actions",
"poll_status": {
"consecutive_failures": 0,
"last_fetched_at": "2019-12-27T18:11:19.117Z",
"next_poll_at": "2019-12-27T18:11:19.117Z"
},
"type": "federation_issuer",
"updated_at": "2024-10-30T23:58:27.427722Z",
"updated_by_actor_id": "updated_by_actor_id"
}
```
##### Returns Examples
Response 200
```python
{
"id": "fdis_01SDCCSbTxrXDpWc1phhtcfK",
"archived_at": "2019-12-27T18:11:19.117Z",
"archived_by_actor_id": "archived_by_actor_id",
"check_jti": true,
"created_at": "2024-10-30T23:58:27.427722Z",
"created_by_actor_id": "created_by_actor_id",
"issuer_url": "https://token.actions.githubusercontent.com",
"jwks": {
"type": "discovery",
"ca_cert_pem": "ca_cert_pem",
"discovery_base": "discovery_base"
},
"jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z",
"max_jwt_lifetime_seconds": 0,
"name": "github-actions",
"poll_status": {
"consecutive_failures": 0,
"last_fetched_at": "2019-12-27T18:11:19.117Z",
"next_poll_at": "2019-12-27T18:11:19.117Z"
},
"type": "federation_issuer",
"updated_at": "2024-10-30T23:58:27.427722Z",
"updated_by_actor_id": "updated_by_actor_id"
---
## Issuers - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/federation/issuers
Path: 04-API-Reference/Admin/beta-organization-federation-issuers.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Ffederation%2Fissuers)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Issuers
Create Federation Issuer
List Federation Issuers
Get Federation Issuer
Update Federation Issuer
Archive Federation Issuer
Rules
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Federation](https://platform.claude.com/docs/en/api/http/beta/organization/federation)
# Issuers
Copy page
cURL
##### [Create Federation Issuer](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [List Federation Issuers](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [Get Federation Issuer](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [Update Federation Issuer](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [Archive Federation Issuer](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### Models
BetaFederationIssuer object{ type: "federation_issuer", id, archived_at, 12 more }
Registered external OIDC identity provider.
Records an external IdP the organization trusts for the RFC 7523 jwt-bearer grant. The `issuer_url` must match the JWT `iss` claim exactly.
BetaFederationIssuerPollStatus object{ consecutive_failures, last_fetched_at, next_poll_at }
Status of automatic JWKS polling for a federation issuer.
Anthropic periodically fetches the issuer's signing keys in the background. These fields summarize the most recent fetches so the health of the JWKS endpoint can be monitored.
consecutive_failures: number
Consecutive fetch failures since the last success.
last_fetched_at: string or null
When the last successful fetch completed.
formatdate-time
next_poll_at: string or null
When the next fetch is scheduled. Null if paused.
formatdate-time
BetaJWKSDiscovery object{ type: "discovery", ca_cert_pem, discovery_base }
JWKS via the issuer's OIDC discovery document.
type: "discovery"
ca_cert_pem: optional string or null
Optional custom CA (PEM) for TLS verification of the JWKS fetch.
maxLength8192
discovery_base: optional string or null
Set when the discovery URL differs from `issuer_url`.
BetaJWKSExplicitURL object{ type: "explicit_url", url, ca_cert_pem }
JWKS fetched from a fixed endpoint.
type: "explicit_url"
url: string
JWKS endpoint.
minLength1
ca_cert_pem: optional string or null
Optional custom CA (PEM) for TLS verification of the JWKS fetch.
maxLength8192
BetaJWKSInline object{ type: "inline", keys }
JWKS supplied directly; no network fetch.
type: "inline"
keys: array of map\[unknown\]
Inline JWK objects.
---
## Archive Federation Rule - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/federation/rules/archive
Path: 04-API-Reference/Admin/beta-organization-federation-rules-archive.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Ffederation%2Frules%2Farchive)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Issuers
Rules
Create Federation Rule
List Federation Rules
Get Federation Rule
Update Federation Rule
Archive Federation Rule
Workspaces
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Federation](https://platform.claude.com/docs/en/api/http/beta/organization/federation)
5. [Rules](https://platform.claude.com/docs/en/api/http/beta/organization/federation/rules)
# Archive Federation Rule
Copy page
cURL
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](../Other/manage-claude-wif-admin-api.md).
Archive a federation rule.
Token exchange through this rule stops immediately. Idempotent; re-archiving returns the rule with its original `archived_at`. Archiving clears the rule's workspace targeting (`workspace_id` and `workspace_ids` are emptied). Tokens already minted before archive remain valid until they expire. OAuth callers may only manage rules whose `oauth_scope` is `workspace:developer` or `workspace:inference`; other scopes require a Console session.
##### Path parameters
federation_rule_id: string
ID of the federation rule to archive.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"anthropic-beta": optional array of [AnthropicBeta](../Endpoints/platform-claude-com-http-beta.md#anthropic_beta)
Optional header to specify the beta version(s) you want to use.
One of the following:
string
"message-batches-2024-09-24"
"prompt-caching-2024-07-31"
"computer-use-2024-10-22"
"computer-use-2025-01-24"
"pdfs-2024-09-25"
"token-counting-2024-11-01"
"token-efficient-tools-2025-02-19"
"output-128k-2025-02-19"
"files-api-2025-04-14"
"mcp-client-2025-04-04"
"mcp-client-2025-11-20"
"dev-full-thinking-2025-05-14"
"interleaved-thinking-2025-05-14"
"code-execution-2025-05-22"
"extended-cache-ttl-2025-04-11"
"context-1m-2025-08-07"
"context-management-2025-06-27"
"model-context-window-exceeded-2025-08-26"
"skills-2025-10-02"
"fast-mode-2026-02-01"
"output-300k-2026-03-24"
"user-profiles-2026-03-24"
"user-profiles-2026-08-18"
"user-profiles-2026-09-04"
"advisor-tool-2026-03-01"
"managed-agents-2026-04-01"
"cache-diagnosis-2026-04-07"
"dreaming-2026-04-21"
"thinking-token-count-2026-05-13"
"server-side-fallback-2026-06-01"
"server-side-fallback-2026-07-01"
"fallback-credit-2026-06-01"
"fallback-credit-2026-07-01"
"agent-memory-2026-07-22"
"mid-conversation-tool-changes-2026-07-01"
"compact-2026-01-12"
"computer-use-2025-11-24"
"mcp-tunnels-2026-06-22"
"structured-outputs-2025-11-13"
"task-budgets-2026-03-13"
"thinking-display-updates-2026-08-18"
"ce-user-management-2026-07-13"
"mid-conversation-output-config-2026-07-01"
"thinking-binding-controls-2026-08-01"
"mid-conversation-system-clear-at-2026-08-21"
"compact-2026-09-04"
"inline-tools-2026-09-15"
"mcp-client-2026-09-15"
"ce-plugins-2026-09-01"
"spend-limit-reads-2026-09-26"
"telemetry-destinations-2026-08-11"
"webhooks-2026-10-07"
##### Returns
BetaFederationRule object{ type: "federation_rule", id, applies_to_all_workspaces, 17 more }
Authorization rule binding an external OIDC identity to Anthropic.
Evaluates the match conditions and mints an OAuth access token for the resolved target, scoped to a single workspace where the rule is enabled (chosen by the caller at exchange time when the rule is enabled for more than one). For rules enabled via `workspace_ids` or `applies_to_all_workspaces`, the target service account must be a member of that workspace (it is implicitly a member of the default workspace); rules carrying only the legacy `workspace_id` binding do not enforce this.
Archive Federation Rule
cURL
```python
curl https://api.anthropic.com/v1/organizations/federation_rules/$FEDERATION_RULE_ID/archive \
-X POST \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK",
"applies_to_all_workspaces": true,
"archived_at": "2019-12-27T18:11:19.117Z",
"archived_by_actor_id": "archived_by_actor_id",
"attributes": {
"foo": "string"
},
"created_at": "2024-10-30T23:58:27.427722Z",
"created_by_actor_id": "created_by_actor_id",
"description": "description",
"issuer_id": "issuer_id",
"issuer_name": "issuer_name",
"match": {
"audience": "audience",
"claims": {
"foo": "string"
},
"condition": "condition",
"subject_prefix": "subject_prefix"
},
"name": "prod-deploy-pipeline",
"oauth_scope": "oauth_scope",
"target": {
"service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK",
"type": "service_account",
"service_account_name": "service_account_name"
},
"token_lifetime_seconds": 0,
"type": "federation_rule",
"updated_at": "2024-10-30T23:58:27.427722Z",
"updated_by_actor_id": "updated_by_actor_id",
"workspace_id": "workspace_id",
"workspace_ids": [
"string"
]
}
```
##### Returns Examples
Response 200
```python
{
"id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK",
"applies_to_all_workspaces": true,
"archived_at": "2019-12-27T18:11:19.117Z",
"archived_by_actor_id": "archived_by_actor_id",
"attributes": {
"foo": "string"
},
"created_at": "2024-10-30T23:58:27.427722Z",
"created_by_actor_id": "created_by_actor_id",
"description": "description",
"issuer_id": "issuer_id",
"issuer_name": "issuer_name",
"match": {
"audience": "audience",
"claims": {
"foo": "string"
},
"condition": "condition",
"subject_prefix": "subject_prefix"
},
"name": "prod-deploy-pipeline",
"oauth_scope": "oauth_scope",
"target": {
"service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK",
"type": "service_account",
"service_account_name": "service_account_name"
},
"token_lifetime_seconds": 0,
"type": "federation_rule",
"updated_at": "2024-10-30T23:58:27.427722Z",
"updated_by_actor_id": "updated_by_actor_id",
"workspace_id": "workspace_id",
---
## Create Federation Rule - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/federation/rules/create
Path: 04-API-Reference/Admin/beta-organization-federation-rules-create.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Ffederation%2Frules%2Fcreate)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Issuers
Rules
Create Federation Rule
List Federation Rules
Get Federation Rule
Update Federation Rule
Archive Federation Rule
Workspaces
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Federation](https://platform.claude.com/docs/en/api/http/beta/organization/federation)
5. [Rules](https://platform.claude.com/docs/en/api/http/beta/organization/federation/rules)
# Create Federation Rule
Copy page
cURL
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](../Other/manage-claude-wif-admin-api.md).
Create a federation rule owned by your organization.
The referenced issuer and the target service account must already exist in the same organization; invalid references are rejected with a 400 error. The workspace reference is validated. Membership is not checked at rule creation: token exchange resolves a single enabled workspace per call and is rejected unless the target service account is a member of that workspace (it is implicitly a member of the default workspace). Rules on well-known shared issuers (GitHub Actions, GitLab, Buildkite, Terraform Cloud, Google) must constrain tenant identity via an identity-bearing claim, a tenant-pinning subject prefix (such as `repo:YOUR_ORG/...`), or a CEL condition referencing one of those identity claims (e.g. `claims.repository_owner`). OAuth callers may only manage rules whose `oauth_scope` is `workspace:developer` or `workspace:inference`; other scopes require a Console session.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"anthropic-beta": optional array of [AnthropicBeta](../Endpoints/platform-claude-com-http-beta.md#anthropic_beta)
Optional header to specify the beta version(s) you want to use.
One of the following:
string
"message-batches-2024-09-24"
"prompt-caching-2024-07-31"
"computer-use-2024-10-22"
"computer-use-2025-01-24"
"pdfs-2024-09-25"
"token-counting-2024-11-01"
"token-efficient-tools-2025-02-19"
"output-128k-2025-02-19"
"files-api-2025-04-14"
"mcp-client-2025-04-04"
"mcp-client-2025-11-20"
"dev-full-thinking-2025-05-14"
"interleaved-thinking-2025-05-14"
"code-execution-2025-05-22"
"extended-cache-ttl-2025-04-11"
"context-1m-2025-08-07"
"context-management-2025-06-27"
"model-context-window-exceeded-2025-08-26"
"skills-2025-10-02"
"fast-mode-2026-02-01"
"output-300k-2026-03-24"
"user-profiles-2026-03-24"
"user-profiles-2026-08-18"
"user-profiles-2026-09-04"
"advisor-tool-2026-03-01"
"managed-agents-2026-04-01"
"cache-diagnosis-2026-04-07"
"dreaming-2026-04-21"
"thinking-token-count-2026-05-13"
"server-side-fallback-2026-06-01"
"server-side-fallback-2026-07-01"
"fallback-credit-2026-06-01"
"fallback-credit-2026-07-01"
"agent-memory-2026-07-22"
"mid-conversation-tool-changes-2026-07-01"
"compact-2026-01-12"
"computer-use-2025-11-24"
"mcp-tunnels-2026-06-22"
"structured-outputs-2025-11-13"
"task-budgets-2026-03-13"
"thinking-display-updates-2026-08-18"
"ce-user-management-2026-07-13"
"mid-conversation-output-config-2026-07-01"
"thinking-binding-controls-2026-08-01"
"mid-conversation-system-clear-at-2026-08-21"
"compact-2026-09-04"
"inline-tools-2026-09-15"
"mcp-client-2026-09-15"
"ce-plugins-2026-09-01"
"spend-limit-reads-2026-09-26"
"telemetry-destinations-2026-08-11"
"webhooks-2026-10-07"
##### Body
issuer_id: string
Tagged ID of the federation issuer.
match: [BetaFederationRuleMatch](https://platform.claude.com/docs/en/api/http/beta/organization/federation/rules#beta_federation_rule_match) { audience, claims, condition, subject_prefix }
Conditions the verified JWT must satisfy for this rule to apply. At least one of `subject_prefix` (other than a wildcard-only value like `*`), `claims`, or `condition` is required; `audience` alone is not sufficient.
audience: optional string or null
Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default.
maxLength1024
claims: optional map\[string\] or null
Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims.
condition: optional string or null
CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400.
maxLength4096
subject_prefix: optional string or null
Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`.
maxLength1024
name: string
Slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409.
minLength1
maxLength255
oauth_scope: string
Space-separated OAuth scopes. OAuth callers may only set `workspace:developer` or `workspace:inference`; other scopes (such as `org:admin`) require a Console session.
minLength1
target: [BetaServiceAccountTarget](https://platform.claude.com/docs/en/api/http/beta/organization/federation/rules#beta_service_account_target) { type: "service_account", service_account_id, service_account_name }
Identity that tokens minted via this rule act as. Currently always a `service_account` target.
type: "service_account"
service_account_id: string
Tagged ID of the service account to mint tokens for.
service_account_name: optional string or null
Service account's display name at read time. Ignored on writes.
applies_to_all_workspaces: optional boolean
When true, enable this rule for every workspace in the org (including workspaces created later).
attributes: optional map\[string\] or null
CEL expressions `{name: expr}` extracting named values from claims. Not yet supported; any non-empty value is rejected with 400.
description: optional string or null
Optional free-text description.
maxLength2000
token_lifetime_seconds: optional number
Lifetime in seconds for access tokens minted via this rule (60-86400). Defaults to 3600 (1h). Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds.
minimum60
maximum86400
workspace_id: optional string or null
Tagged ID of the workspace to enable this rule for. Required unless `applies_to_all_workspaces` is true. Additional workspaces can be added via the `/federation_rules/{federation_rule_id}/workspaces` sub-resource.
##### Returns
BetaFederationRule object{ type: "federation_rule", id, applies_to_all_workspaces, 17 more }
Authorization rule binding an external OIDC identity to Anthropic.
Evaluates the match conditions and mints an OAuth access token for the resolved target, scoped to a single workspace where the rule is enabled (chosen by the caller at exchange time when the rule is enabled for more than one). For rules enabled via `workspace_ids` or `applies_to_all_workspaces`, the target service account must be a member of that workspace (it is implicitly a member of the default workspace); rules carrying only the legacy `workspace_id` binding do not enforce this.
Create Federation Rule
cURL
```python
curl https://api.anthropic.com/v1/organizations/federation_rules \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY" \
-d '{
"issuer_id": "issuer_id",
"match": {},
"name": "x",
"oauth_scope": "x",
"target": {
"service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK",
"type": "service_account"
}
}'
```
Response 200
```python
{
"id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK",
"applies_to_all_workspaces": true,
"archived_at": "2019-12-27T18:11:19.117Z",
"archived_by_actor_id": "archived_by_actor_id",
"attributes": {
"foo": "string"
},
"created_at": "2024-10-30T23:58:27.427722Z",
"created_by_actor_id": "created_by_actor_id",
"description": "description",
"issuer_id": "issuer_id",
"issuer_name": "issuer_name",
"match": {
"audience": "audience",
"claims": {
"foo": "string"
},
"condition": "condition",
"subject_prefix": "subject_prefix"
},
"name": "prod-deploy-pipeline",
"oauth_scope": "oauth_scope",
"target": {
"service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK",
"type": "service_account",
"service_account_name": "service_account_name"
},
"token_lifetime_seconds": 0,
"type": "federation_rule",
"updated_at": "2024-10-30T23:58:27.427722Z",
"updated_by_actor_id": "updated_by_actor_id",
"workspace_id": "workspace_id",
"workspace_ids": [
"string"
]
}
```
##### Returns Examples
Response 200
```python
{
"id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK",
"applies_to_all_workspaces": true,
"archived_at": "2019-12-27T18:11:19.117Z",
"archived_by_actor_id": "archived_by_actor_id",
"attributes": {
"foo": "string"
},
"created_at": "2024-10-30T23:58:27.427722Z",
"created_by_actor_id": "created_by_actor_id",
"description": "description",
"issuer_id": "issuer_id",
"issuer_name": "issuer_name",
"match": {
"audience": "audience",
"claims": {
"foo": "string"
},
"condition": "condition",
"subject_prefix": "subject_prefix"
},
"name": "prod-deploy-pipeline",
"oauth_scope": "oauth_scope",
"target": {
"service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK",
"type": "service_account",
"service_account_name": "service_account_name"
},
"token_lifetime_seconds": 0,
"type": "federation_rule",
"updated_at": "2024-10-30T23:58:27.427722Z",
"updated_by_actor_id": "updated_by_actor_id",
"workspace_id": "workspace_id",
---
## List Federation Rules - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/federation/rules/list
Path: 04-API-Reference/Admin/beta-organization-federation-rules-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Ffederation%2Frules%2Flist)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Issuers
Rules
Create Federation Rule
List Federation Rules
Get Federation Rule
Update Federation Rule
Archive Federation Rule
Workspaces
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Federation](https://platform.claude.com/docs/en/api/http/beta/organization/federation)
5. [Rules](https://platform.claude.com/docs/en/api/http/beta/organization/federation/rules)
# List Federation Rules
Copy page
cURL
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](../Other/manage-claude-wif-admin-api.md).
List federation rules in your organization.
Optionally filter by issuer with `issuer_id`. Archived rules are excluded unless `include_archived=true`.
##### Query parameters
include_archived: optional boolean
Include archived resources. Defaults to false.
defaultfalse
issuer_id: optional string
Filter to rules referencing this federation issuer.
limit: optional number
Number of results per page.
default20
minimum1
maximum100
page: optional string
Opaque cursor from a previous response's `next_page`.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"anthropic-beta": optional array of [AnthropicBeta](../Endpoints/platform-claude-com-http-beta.md#anthropic_beta)
Optional header to specify the beta version(s) you want to use.
One of the following:
string
"message-batches-2024-09-24"
"prompt-caching-2024-07-31"
"computer-use-2024-10-22"
"computer-use-2025-01-24"
"pdfs-2024-09-25"
"token-counting-2024-11-01"
"token-efficient-tools-2025-02-19"
"output-128k-2025-02-19"
"files-api-2025-04-14"
"mcp-client-2025-04-04"
"mcp-client-2025-11-20"
"dev-full-thinking-2025-05-14"
"interleaved-thinking-2025-05-14"
"code-execution-2025-05-22"
"extended-cache-ttl-2025-04-11"
"context-1m-2025-08-07"
"context-management-2025-06-27"
"model-context-window-exceeded-2025-08-26"
"skills-2025-10-02"
"fast-mode-2026-02-01"
"output-300k-2026-03-24"
"user-profiles-2026-03-24"
"user-profiles-2026-08-18"
"user-profiles-2026-09-04"
"advisor-tool-2026-03-01"
"managed-agents-2026-04-01"
"cache-diagnosis-2026-04-07"
"dreaming-2026-04-21"
"thinking-token-count-2026-05-13"
"server-side-fallback-2026-06-01"
"server-side-fallback-2026-07-01"
"fallback-credit-2026-06-01"
"fallback-credit-2026-07-01"
"agent-memory-2026-07-22"
"mid-conversation-tool-changes-2026-07-01"
"compact-2026-01-12"
"computer-use-2025-11-24"
"mcp-tunnels-2026-06-22"
"structured-outputs-2025-11-13"
"task-budgets-2026-03-13"
"thinking-display-updates-2026-08-18"
"ce-user-management-2026-07-13"
"mid-conversation-output-config-2026-07-01"
"thinking-binding-controls-2026-08-01"
"mid-conversation-system-clear-at-2026-08-21"
"compact-2026-09-04"
"inline-tools-2026-09-15"
"mcp-client-2026-09-15"
"ce-plugins-2026-09-01"
"spend-limit-reads-2026-09-26"
"telemetry-destinations-2026-08-11"
"webhooks-2026-10-07"
##### Returns
data: array of [BetaFederationRule](https://platform.claude.com/docs/en/api/http/beta/organization/federation/rules#beta_federation_rule) { type: "federation_rule", id, applies_to_all_workspaces, 17 more }
type: "federation_rule"
defaultfederation_rule
id: string
Tagged ID of the federation rule.
applies_to_all_workspaces: boolean
When true, this rule is enabled for every workspace in the org (including ones created after the rule). `workspace_ids` is ignored at exchange time.
archived_at: string or null
If set, this rule is archived and rejects token exchange.
formatdate-time
archived_by_actor_id: string or null
Tagged ID (`user_`/`svac_`) of the actor that archived this rule.
attributes: map\[string\] or null
CEL expressions extracting named values from claims. Not yet supported; always null.
created_at: string
When this rule was created.
formatdate-time
created_by_actor_id: string or null
Tagged ID (`user_`/`svac_`) of the actor that created this rule.
description: string or null
Optional free-text description.
issuer_id: string
Tagged ID of the issuer whose tokens this rule accepts.
issuer_name: string or null
Issuer's display name at read time.
match: [BetaFederationRuleMatch](https://platform.claude.com/docs/en/api/http/beta/organization/federation/rules#beta_federation_rule_match) { audience, claims, condition, subject_prefix }
Conditions the verified JWT must satisfy for this rule to apply. All populated matcher fields must pass.
audience: optional string or null
Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default.
maxLength1024
claims: optional map\[string\] or null
Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims.
condition: optional string or null
CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400.
maxLength4096
subject_prefix: optional string or null
Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`.
maxLength1024
name: string
Admin-chosen slug identifier.
oauth_scope: string
Space-separated OAuth scopes granted on the minted token.
target: [BetaServiceAccountTarget](https://platform.claude.com/docs/en/api/http/beta/organization/federation/rules#beta_service_account_target) { type: "service_account", service_account_id, service_account_name }
What this rule targets. Check `type` before reading the other fields. Tokens minted via a rule whose target `type` is `service_account` act as that service account.
type: "service_account"
service_account_id: string
Tagged ID of the service account to mint tokens for.
service_account_name: optional string or null
Service account's display name at read time. Ignored on writes.
token_lifetime_seconds: number
Lifetime in seconds of access tokens minted via this rule. Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds.
updated_at: string
When this rule was last updated.
formatdate-time
updated_by_actor_id: string or null
Tagged ID (`user_`/`svac_`) of the actor that last updated this rule.
workspace_id: string or null
Legacy single-workspace binding. Prefer `workspace_ids` and the `/federation_rules/{federation_rule_id}/workspaces` sub-resource for managing workspace enablement.
workspace_ids: array of string
Tagged IDs of the workspaces this rule is enabled for. May be empty for older rules that only carry the legacy `workspace_id` binding. Ignored at exchange time when `applies_to_all_workspaces` is true (the list may still be non-empty).
next_page: string or null
Opaque cursor for the next page, or null if no more results.
List Federation Rules
cURL
```python
curl https://api.anthropic.com/v1/organizations/federation_rules \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"data": [
{
"id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK",
"applies_to_all_workspaces": true,
"archived_at": "2019-12-27T18:11:19.117Z",
"archived_by_actor_id": "archived_by_actor_id",
"attributes": {
"foo": "string"
},
"created_at": "2024-10-30T23:58:27.427722Z",
"created_by_actor_id": "created_by_actor_id",
"description": "description",
"issuer_id": "issuer_id",
"issuer_name": "issuer_name",
"match": {
"audience": "audience",
"claims": {
"foo": "string"
},
"condition": "condition",
"subject_prefix": "subject_prefix"
},
"name": "prod-deploy-pipeline",
"oauth_scope": "oauth_scope",
"target": {
"service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK",
"type": "service_account",
"service_account_name": "service_account_name"
},
"token_lifetime_seconds": 0,
"type": "federation_rule",
"updated_at": "2024-10-30T23:58:27.427722Z",
"updated_by_actor_id": "updated_by_actor_id",
"workspace_id": "workspace_id",
"workspace_ids": [
"string"
]
}
],
"next_page": "next_page"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK",
"applies_to_all_workspaces": true,
"archived_at": "2019-12-27T18:11:19.117Z",
"archived_by_actor_id": "archived_by_actor_id",
"attributes": {
"foo": "string"
},
"created_at": "2024-10-30T23:58:27.427722Z",
"created_by_actor_id": "created_by_actor_id",
"description": "description",
"issuer_id": "issuer_id",
"issuer_name": "issuer_name",
"match": {
"audience": "audience",
"claims": {
"foo": "string"
},
"condition": "condition",
"subject_prefix": "subject_prefix"
},
"name": "prod-deploy-pipeline",
"oauth_scope": "oauth_scope",
"target": {
"service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK",
"type": "service_account",
"service_account_name": "service_account_name"
},
"token_lifetime_seconds": 0,
"type": "federation_rule",
"updated_at": "2024-10-30T23:58:27.427722Z",
"updated_by_actor_id": "updated_by_actor_id",
"workspace_id": "workspace_id",
---
## Get Federation Rule - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/federation/rules/retrieve
Path: 04-API-Reference/Admin/beta-organization-federation-rules-retrieve.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Ffederation%2Frules%2Fretrieve)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Issuers
Rules
Create Federation Rule
List Federation Rules
Get Federation Rule
Update Federation Rule
Archive Federation Rule
Workspaces
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Federation](https://platform.claude.com/docs/en/api/http/beta/organization/federation)
5. [Rules](https://platform.claude.com/docs/en/api/http/beta/organization/federation/rules)
# Get Federation Rule
Copy page
cURL
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](../Other/manage-claude-wif-admin-api.md).
Retrieve a federation rule by its ID (`fdrl_...`).
##### Path parameters
federation_rule_id: string
ID of the federation rule.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"anthropic-beta": optional array of [AnthropicBeta](../Endpoints/platform-claude-com-http-beta.md#anthropic_beta)
Optional header to specify the beta version(s) you want to use.
One of the following:
string
"message-batches-2024-09-24"
"prompt-caching-2024-07-31"
"computer-use-2024-10-22"
"computer-use-2025-01-24"
"pdfs-2024-09-25"
"token-counting-2024-11-01"
"token-efficient-tools-2025-02-19"
"output-128k-2025-02-19"
"files-api-2025-04-14"
"mcp-client-2025-04-04"
"mcp-client-2025-11-20"
"dev-full-thinking-2025-05-14"
"interleaved-thinking-2025-05-14"
"code-execution-2025-05-22"
"extended-cache-ttl-2025-04-11"
"context-1m-2025-08-07"
"context-management-2025-06-27"
"model-context-window-exceeded-2025-08-26"
"skills-2025-10-02"
"fast-mode-2026-02-01"
"output-300k-2026-03-24"
"user-profiles-2026-03-24"
"user-profiles-2026-08-18"
"user-profiles-2026-09-04"
"advisor-tool-2026-03-01"
"managed-agents-2026-04-01"
"cache-diagnosis-2026-04-07"
"dreaming-2026-04-21"
"thinking-token-count-2026-05-13"
"server-side-fallback-2026-06-01"
"server-side-fallback-2026-07-01"
"fallback-credit-2026-06-01"
"fallback-credit-2026-07-01"
"agent-memory-2026-07-22"
"mid-conversation-tool-changes-2026-07-01"
"compact-2026-01-12"
"computer-use-2025-11-24"
"mcp-tunnels-2026-06-22"
"structured-outputs-2025-11-13"
"task-budgets-2026-03-13"
"thinking-display-updates-2026-08-18"
"ce-user-management-2026-07-13"
"mid-conversation-output-config-2026-07-01"
"thinking-binding-controls-2026-08-01"
"mid-conversation-system-clear-at-2026-08-21"
"compact-2026-09-04"
"inline-tools-2026-09-15"
"mcp-client-2026-09-15"
"ce-plugins-2026-09-01"
"spend-limit-reads-2026-09-26"
"telemetry-destinations-2026-08-11"
"webhooks-2026-10-07"
##### Returns
BetaFederationRule object{ type: "federation_rule", id, applies_to_all_workspaces, 17 more }
Authorization rule binding an external OIDC identity to Anthropic.
Evaluates the match conditions and mints an OAuth access token for the resolved target, scoped to a single workspace where the rule is enabled (chosen by the caller at exchange time when the rule is enabled for more than one). For rules enabled via `workspace_ids` or `applies_to_all_workspaces`, the target service account must be a member of that workspace (it is implicitly a member of the default workspace); rules carrying only the legacy `workspace_id` binding do not enforce this.
Get Federation Rule
cURL
```python
curl https://api.anthropic.com/v1/organizations/federation_rules/$FEDERATION_RULE_ID \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK",
"applies_to_all_workspaces": true,
"archived_at": "2019-12-27T18:11:19.117Z",
"archived_by_actor_id": "archived_by_actor_id",
"attributes": {
"foo": "string"
},
"created_at": "2024-10-30T23:58:27.427722Z",
"created_by_actor_id": "created_by_actor_id",
"description": "description",
"issuer_id": "issuer_id",
"issuer_name": "issuer_name",
"match": {
"audience": "audience",
"claims": {
"foo": "string"
},
"condition": "condition",
"subject_prefix": "subject_prefix"
},
"name": "prod-deploy-pipeline",
"oauth_scope": "oauth_scope",
"target": {
"service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK",
"type": "service_account",
"service_account_name": "service_account_name"
},
"token_lifetime_seconds": 0,
"type": "federation_rule",
"updated_at": "2024-10-30T23:58:27.427722Z",
"updated_by_actor_id": "updated_by_actor_id",
"workspace_id": "workspace_id",
"workspace_ids": [
"string"
]
}
```
##### Returns Examples
Response 200
```python
{
"id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK",
"applies_to_all_workspaces": true,
"archived_at": "2019-12-27T18:11:19.117Z",
"archived_by_actor_id": "archived_by_actor_id",
"attributes": {
"foo": "string"
},
"created_at": "2024-10-30T23:58:27.427722Z",
"created_by_actor_id": "created_by_actor_id",
"description": "description",
"issuer_id": "issuer_id",
"issuer_name": "issuer_name",
"match": {
"audience": "audience",
"claims": {
"foo": "string"
},
"condition": "condition",
"subject_prefix": "subject_prefix"
},
"name": "prod-deploy-pipeline",
"oauth_scope": "oauth_scope",
"target": {
"service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK",
"type": "service_account",
"service_account_name": "service_account_name"
},
"token_lifetime_seconds": 0,
"type": "federation_rule",
"updated_at": "2024-10-30T23:58:27.427722Z",
"updated_by_actor_id": "updated_by_actor_id",
"workspace_id": "workspace_id",
---
## Update Federation Rule - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/federation/rules/update
Path: 04-API-Reference/Admin/beta-organization-federation-rules-update.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Ffederation%2Frules%2Fupdate)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Issuers
Rules
Create Federation Rule
List Federation Rules
Get Federation Rule
Update Federation Rule
Archive Federation Rule
Workspaces
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Federation](https://platform.claude.com/docs/en/api/http/beta/organization/federation)
5. [Rules](https://platform.claude.com/docs/en/api/http/beta/organization/federation/rules)
# Update Federation Rule
Copy page
cURL
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](../Other/manage-claude-wif-admin-api.md).
Partially update a federation rule.
`issuer_id` is immutable. `match` and `target` are replaced as whole objects when set. Referenced service accounts and workspaces must exist in your organization; invalid references are rejected with a 400 error. Archived rules cannot be updated; this returns 400. Create a new rule instead. Rules on well-known shared issuers (GitHub Actions, GitLab, Buildkite, Terraform Cloud, Google) must constrain tenant identity via an identity-bearing claim, a tenant-pinning subject prefix (such as `repo:YOUR_ORG/...`), or a CEL condition referencing one of those identity claims (e.g. `claims.repository_owner`). On these issuers the requirement is re-checked on every update; if an existing rule's stored match does not yet constrain tenant identity, any update (even a rename or description change) must also supply a conforming `match` in the same request. OAuth callers may only manage rules whose `oauth_scope` is `workspace:developer` or `workspace:inference`; other scopes require a Console session.
##### Path parameters
federation_rule_id: string
ID of the federation rule to update.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"anthropic-beta": optional array of [AnthropicBeta](../Endpoints/platform-claude-com-http-beta.md#anthropic_beta)
Optional header to specify the beta version(s) you want to use.
One of the following:
string
"message-batches-2024-09-24"
"prompt-caching-2024-07-31"
"computer-use-2024-10-22"
"computer-use-2025-01-24"
"pdfs-2024-09-25"
"token-counting-2024-11-01"
"token-efficient-tools-2025-02-19"
"output-128k-2025-02-19"
"files-api-2025-04-14"
"mcp-client-2025-04-04"
"mcp-client-2025-11-20"
"dev-full-thinking-2025-05-14"
"interleaved-thinking-2025-05-14"
"code-execution-2025-05-22"
"extended-cache-ttl-2025-04-11"
"context-1m-2025-08-07"
"context-management-2025-06-27"
"model-context-window-exceeded-2025-08-26"
"skills-2025-10-02"
"fast-mode-2026-02-01"
"output-300k-2026-03-24"
"user-profiles-2026-03-24"
"user-profiles-2026-08-18"
"user-profiles-2026-09-04"
"advisor-tool-2026-03-01"
"managed-agents-2026-04-01"
"cache-diagnosis-2026-04-07"
"dreaming-2026-04-21"
"thinking-token-count-2026-05-13"
"server-side-fallback-2026-06-01"
"server-side-fallback-2026-07-01"
"fallback-credit-2026-06-01"
"fallback-credit-2026-07-01"
"agent-memory-2026-07-22"
"mid-conversation-tool-changes-2026-07-01"
"compact-2026-01-12"
"computer-use-2025-11-24"
"mcp-tunnels-2026-06-22"
"structured-outputs-2025-11-13"
"task-budgets-2026-03-13"
"thinking-display-updates-2026-08-18"
"ce-user-management-2026-07-13"
"mid-conversation-output-config-2026-07-01"
"thinking-binding-controls-2026-08-01"
"mid-conversation-system-clear-at-2026-08-21"
"compact-2026-09-04"
"inline-tools-2026-09-15"
"mcp-client-2026-09-15"
"ce-plugins-2026-09-01"
"spend-limit-reads-2026-09-26"
"telemetry-destinations-2026-08-11"
"webhooks-2026-10-07"
##### Body
applies_to_all_workspaces: optional boolean or null
When true, enables this rule for every workspace in the org (including workspaces created later). Setting `false` is rejected with 400 if no workspace would remain enabled; a rule with only a legacy `workspace_id` binding continues to mint.
attributes: optional map\[string\] or null
Replaces the CEL expressions `{name: expr}` extracting named values from claims. Send null to clear them. Not yet supported; any non-empty value is rejected with 400.
description: optional string or null
Replaces the description. Omit to leave unchanged; send `null` to clear (the field is stored as an empty string).
maxLength2000
match: optional [BetaFederationRuleMatch](https://platform.claude.com/docs/en/api/http/beta/organization/federation/rules#beta_federation_rule_match) { audience, claims, condition, subject_prefix } or null
Replaces the entire match object. All populated matcher fields must pass.
audience: optional string or null
Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default.
maxLength1024
claims: optional map\[string\] or null
Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims.
condition: optional string or null
CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400.
maxLength4096
subject_prefix: optional string or null
Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`.
maxLength1024
name: optional string or null
Replaces the slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409.
minLength1
maxLength255
oauth_scope: optional string or null
Replaces the space-separated OAuth scopes granted on minted tokens. OAuth callers may only set `workspace:developer` or `workspace:inference`; other scopes (such as `org:admin`) require a Console session.
minLength1
target: optional [BetaServiceAccountTarget](https://platform.claude.com/docs/en/api/http/beta/organization/federation/rules#beta_service_account_target) { type: "service_account", service_account_id, service_account_name } or null
Replaces the entire target object. Currently always a `service_account` target.
type: "service_account"
service_account_id: string
Tagged ID of the service account to mint tokens for.
service_account_name: optional string or null
Service account's display name at read time. Ignored on writes.
token_lifetime_seconds: optional number or null
Replaces the lifetime in seconds for access tokens minted via this rule (60-86400). Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds.
minimum60
maximum86400
workspace_id: optional string or null
Replaces the existing single workspace enablement (the previous one is removed). Rejected with 400 if the rule is enabled for more than one workspace; use the `/federation_rules/{federation_rule_id}/workspaces` sub-resource instead.
##### Returns
BetaFederationRule object{ type: "federation_rule", id, applies_to_all_workspaces, 17 more }
Authorization rule binding an external OIDC identity to Anthropic.
Evaluates the match conditions and mints an OAuth access token for the resolved target, scoped to a single workspace where the rule is enabled (chosen by the caller at exchange time when the rule is enabled for more than one). For rules enabled via `workspace_ids` or `applies_to_all_workspaces`, the target service account must be a member of that workspace (it is implicitly a member of the default workspace); rules carrying only the legacy `workspace_id` binding do not enforce this.
Update Federation Rule
cURL
```python
curl https://api.anthropic.com/v1/organizations/federation_rules/$FEDERATION_RULE_ID \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY" \
-d '{}'
```
Response 200
```python
{
"id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK",
"applies_to_all_workspaces": true,
"archived_at": "2019-12-27T18:11:19.117Z",
"archived_by_actor_id": "archived_by_actor_id",
"attributes": {
"foo": "string"
},
"created_at": "2024-10-30T23:58:27.427722Z",
"created_by_actor_id": "created_by_actor_id",
"description": "description",
"issuer_id": "issuer_id",
"issuer_name": "issuer_name",
"match": {
"audience": "audience",
"claims": {
"foo": "string"
},
"condition": "condition",
"subject_prefix": "subject_prefix"
},
"name": "prod-deploy-pipeline",
"oauth_scope": "oauth_scope",
"target": {
"service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK",
"type": "service_account",
"service_account_name": "service_account_name"
},
"token_lifetime_seconds": 0,
"type": "federation_rule",
"updated_at": "2024-10-30T23:58:27.427722Z",
"updated_by_actor_id": "updated_by_actor_id",
"workspace_id": "workspace_id",
"workspace_ids": [
"string"
]
}
```
##### Returns Examples
Response 200
```python
{
"id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK",
"applies_to_all_workspaces": true,
"archived_at": "2019-12-27T18:11:19.117Z",
"archived_by_actor_id": "archived_by_actor_id",
"attributes": {
"foo": "string"
},
"created_at": "2024-10-30T23:58:27.427722Z",
"created_by_actor_id": "created_by_actor_id",
"description": "description",
"issuer_id": "issuer_id",
"issuer_name": "issuer_name",
"match": {
"audience": "audience",
"claims": {
"foo": "string"
},
"condition": "condition",
"subject_prefix": "subject_prefix"
},
"name": "prod-deploy-pipeline",
"oauth_scope": "oauth_scope",
"target": {
"service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK",
"type": "service_account",
"service_account_name": "service_account_name"
},
"token_lifetime_seconds": 0,
"type": "federation_rule",
"updated_at": "2024-10-30T23:58:27.427722Z",
"updated_by_actor_id": "updated_by_actor_id",
"workspace_id": "workspace_id",
---
## Add Federation Rule Workspace - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/federation/rules/workspaces/add
Path: 04-API-Reference/Admin/beta-organization-federation-rules-workspaces-add.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Ffederation%2Frules%2Fworkspaces%2Fadd)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Issuers
Rules
Create Federation Rule
List Federation Rules
Get Federation Rule
Update Federation Rule
Archive Federation Rule
Workspaces
Add Federation Rule Workspace
List Federation Rule Workspaces
Remove Federation Rule Workspace
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Federation](https://platform.claude.com/docs/en/api/http/beta/organization/federation)
5. [Rules](https://platform.claude.com/docs/en/api/http/beta/organization/federation/rules)
6. [Workspaces](https://platform.claude.com/docs/en/api/http/beta/organization/federation/rules/workspaces)
# Add Federation Rule Workspace
Copy page
cURL
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](../Other/manage-claude-wif-admin-api.md).
Enable a federation rule for a workspace.
Idempotent; re-enabling returns the existing enablement. The rule and workspace must both belong to your organization. Membership of the rule's target service account in this workspace is not checked at enablement: token exchange into this workspace is rejected unless the target is a member (it is implicitly a member of the default workspace). Archived rules are rejected with 400. OAuth callers may only manage rules whose `oauth_scope` is `workspace:developer` or `workspace:inference`; other scopes require a Console session.
##### Path parameters
federation_rule_id: string
ID of the federation rule.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"anthropic-beta": optional array of [AnthropicBeta](../Endpoints/platform-claude-com-http-beta.md#anthropic_beta)
Optional header to specify the beta version(s) you want to use.
One of the following:
string
"message-batches-2024-09-24"
"prompt-caching-2024-07-31"
"computer-use-2024-10-22"
"computer-use-2025-01-24"
"pdfs-2024-09-25"
"token-counting-2024-11-01"
"token-efficient-tools-2025-02-19"
"output-128k-2025-02-19"
"files-api-2025-04-14"
"mcp-client-2025-04-04"
"mcp-client-2025-11-20"
"dev-full-thinking-2025-05-14"
"interleaved-thinking-2025-05-14"
"code-execution-2025-05-22"
"extended-cache-ttl-2025-04-11"
"context-1m-2025-08-07"
"context-management-2025-06-27"
"model-context-window-exceeded-2025-08-26"
"skills-2025-10-02"
"fast-mode-2026-02-01"
"output-300k-2026-03-24"
"user-profiles-2026-03-24"
"user-profiles-2026-08-18"
"user-profiles-2026-09-04"
"advisor-tool-2026-03-01"
"managed-agents-2026-04-01"
"cache-diagnosis-2026-04-07"
"dreaming-2026-04-21"
"thinking-token-count-2026-05-13"
"server-side-fallback-2026-06-01"
"server-side-fallback-2026-07-01"
"fallback-credit-2026-06-01"
"fallback-credit-2026-07-01"
"agent-memory-2026-07-22"
"mid-conversation-tool-changes-2026-07-01"
"compact-2026-01-12"
"computer-use-2025-11-24"
"mcp-tunnels-2026-06-22"
"structured-outputs-2025-11-13"
"task-budgets-2026-03-13"
"thinking-display-updates-2026-08-18"
"ce-user-management-2026-07-13"
"mid-conversation-output-config-2026-07-01"
"thinking-binding-controls-2026-08-01"
"mid-conversation-system-clear-at-2026-08-21"
"compact-2026-09-04"
"inline-tools-2026-09-15"
"mcp-client-2026-09-15"
"ce-plugins-2026-09-01"
"spend-limit-reads-2026-09-26"
"telemetry-destinations-2026-08-11"
"webhooks-2026-10-07"
##### Body
workspace_id: string
Tagged ID of the workspace to enable this rule for.
##### Returns
BetaFederationRuleWorkspace object{ type: "federation_rule_workspace", created_at, created_by_actor_id, 3 more }
type: "federation_rule_workspace"
defaultfederation_rule_workspace
created_at: string
When this workspace was enabled for the rule.
formatdate-time
created_by_actor_id: string or null
Tagged ID (`user_...` or `svac_...`) of the actor that enabled this workspace for the rule, if known.
federation_rule_id: string
Tagged ID of the federation rule.
workspace_id: string
Tagged ID of the workspace this rule is enabled for.
workspace_name: string or null
Workspace display name. Populated when listing; null in the enable response.
Add Federation Rule Workspace
cURL
```python
curl https://api.anthropic.com/v1/organizations/federation_rules/$FEDERATION_RULE_ID/workspaces \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY" \
-d '{
"workspace_id": "workspace_id"
}'
```
Response 200
```python
{
"created_at": "2024-10-30T23:58:27.427722Z",
"created_by_actor_id": "created_by_actor_id",
"federation_rule_id": "federation_rule_id",
"type": "federation_rule_workspace",
"workspace_id": "workspace_id",
"workspace_name": "workspace_name"
}
```
##### Returns Examples
Response 200
```python
{
"created_at": "2024-10-30T23:58:27.427722Z",
"created_by_actor_id": "created_by_actor_id",
"federation_rule_id": "federation_rule_id",
"type": "federation_rule_workspace",
"workspace_id": "workspace_id",
"workspace_name": "workspace_name"
---
## List Federation Rule Workspaces - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/federation/rules/workspaces/list
Path: 04-API-Reference/Admin/beta-organization-federation-rules-workspaces-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Ffederation%2Frules%2Fworkspaces%2Flist)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Issuers
Rules
Create Federation Rule
List Federation Rules
Get Federation Rule
Update Federation Rule
Archive Federation Rule
Workspaces
Add Federation Rule Workspace
List Federation Rule Workspaces
Remove Federation Rule Workspace
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Federation](https://platform.claude.com/docs/en/api/http/beta/organization/federation)
5. [Rules](https://platform.claude.com/docs/en/api/http/beta/organization/federation/rules)
6. [Workspaces](https://platform.claude.com/docs/en/api/http/beta/organization/federation/rules/workspaces)
# List Federation Rule Workspaces
Copy page
cURL
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](../Other/manage-claude-wif-admin-api.md).
List workspaces where this federation rule is enabled.
Returns all workspace enablements in a single response; the `limit` and `page` parameters are accepted but have no effect, and `next_page` is always `null`. Returns explicit per-workspace enablements only; for rules with `applies_to_all_workspaces` or a legacy single `workspace_id`, check those fields on the rule itself.
##### Path parameters
federation_rule_id: string
ID of the federation rule.
##### Query parameters
limit: optional number
Number of results per page.
default20
minimum1
maximum100
page: optional string
Opaque cursor from a previous response's `next_page`.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"anthropic-beta": optional array of [AnthropicBeta](../Endpoints/platform-claude-com-http-beta.md#anthropic_beta)
Optional header to specify the beta version(s) you want to use.
One of the following:
string
"message-batches-2024-09-24"
"prompt-caching-2024-07-31"
"computer-use-2024-10-22"
"computer-use-2025-01-24"
"pdfs-2024-09-25"
"token-counting-2024-11-01"
"token-efficient-tools-2025-02-19"
"output-128k-2025-02-19"
"files-api-2025-04-14"
"mcp-client-2025-04-04"
"mcp-client-2025-11-20"
"dev-full-thinking-2025-05-14"
"interleaved-thinking-2025-05-14"
"code-execution-2025-05-22"
"extended-cache-ttl-2025-04-11"
"context-1m-2025-08-07"
"context-management-2025-06-27"
"model-context-window-exceeded-2025-08-26"
"skills-2025-10-02"
"fast-mode-2026-02-01"
"output-300k-2026-03-24"
"user-profiles-2026-03-24"
"user-profiles-2026-08-18"
"user-profiles-2026-09-04"
"advisor-tool-2026-03-01"
"managed-agents-2026-04-01"
"cache-diagnosis-2026-04-07"
"dreaming-2026-04-21"
"thinking-token-count-2026-05-13"
"server-side-fallback-2026-06-01"
"server-side-fallback-2026-07-01"
"fallback-credit-2026-06-01"
"fallback-credit-2026-07-01"
"agent-memory-2026-07-22"
"mid-conversation-tool-changes-2026-07-01"
"compact-2026-01-12"
"computer-use-2025-11-24"
"mcp-tunnels-2026-06-22"
"structured-outputs-2025-11-13"
"task-budgets-2026-03-13"
"thinking-display-updates-2026-08-18"
"ce-user-management-2026-07-13"
"mid-conversation-output-config-2026-07-01"
"thinking-binding-controls-2026-08-01"
"mid-conversation-system-clear-at-2026-08-21"
"compact-2026-09-04"
"inline-tools-2026-09-15"
"mcp-client-2026-09-15"
"ce-plugins-2026-09-01"
"spend-limit-reads-2026-09-26"
"telemetry-destinations-2026-08-11"
"webhooks-2026-10-07"
##### Returns
data: array of [BetaFederationRuleWorkspace](https://platform.claude.com/docs/en/api/http/beta/organization/federation/rules#beta_federation_rule_workspace) { type: "federation_rule_workspace", created_at, created_by_actor_id, 3 more }
type: "federation_rule_workspace"
defaultfederation_rule_workspace
created_at: string
When this workspace was enabled for the rule.
formatdate-time
created_by_actor_id: string or null
Tagged ID (`user_...` or `svac_...`) of the actor that enabled this workspace for the rule, if known.
federation_rule_id: string
Tagged ID of the federation rule.
workspace_id: string
Tagged ID of the workspace this rule is enabled for.
workspace_name: string or null
Workspace display name. Populated when listing; null in the enable response.
next_page: string or null
Opaque cursor for the next page; null when there are no more results.
List Federation Rule Workspaces
cURL
```python
curl https://api.anthropic.com/v1/organizations/federation_rules/$FEDERATION_RULE_ID/workspaces \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"data": [
{
"created_at": "2024-10-30T23:58:27.427722Z",
"created_by_actor_id": "created_by_actor_id",
"federation_rule_id": "federation_rule_id",
"type": "federation_rule_workspace",
"workspace_id": "workspace_id",
"workspace_name": "workspace_name"
}
],
"next_page": "next_page"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"created_at": "2024-10-30T23:58:27.427722Z",
"created_by_actor_id": "created_by_actor_id",
"federation_rule_id": "federation_rule_id",
"type": "federation_rule_workspace",
"workspace_id": "workspace_id",
"workspace_name": "workspace_name"
---
## Remove Federation Rule Workspace - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/federation/rules/workspaces/remove
Path: 04-API-Reference/Admin/beta-organization-federation-rules-workspaces-remove.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Ffederation%2Frules%2Fworkspaces%2Fremove)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Issuers
Rules
Create Federation Rule
List Federation Rules
Get Federation Rule
Update Federation Rule
Archive Federation Rule
Workspaces
Add Federation Rule Workspace
List Federation Rule Workspaces
Remove Federation Rule Workspace
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Federation](https://platform.claude.com/docs/en/api/http/beta/organization/federation)
5. [Rules](https://platform.claude.com/docs/en/api/http/beta/organization/federation/rules)
6. [Workspaces](https://platform.claude.com/docs/en/api/http/beta/organization/federation/rules/workspaces)
# Remove Federation Rule Workspace
Copy page
cURL
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](../Other/manage-claude-wif-admin-api.md).
Disable a federation rule for a workspace.
Idempotent; succeeds even if the enablement was already removed. OAuth callers may only manage rules whose `oauth_scope` is `workspace:developer` or `workspace:inference`; other scopes require a Console session.
##### Path parameters
federation_rule_id: string
ID of the federation rule.
workspace_id: string
ID of the workspace to disable for.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"anthropic-beta": optional array of [AnthropicBeta](../Endpoints/platform-claude-com-http-beta.md#anthropic_beta)
Optional header to specify the beta version(s) you want to use.
One of the following:
string
"message-batches-2024-09-24"
"prompt-caching-2024-07-31"
"computer-use-2024-10-22"
"computer-use-2025-01-24"
"pdfs-2024-09-25"
"token-counting-2024-11-01"
"token-efficient-tools-2025-02-19"
"output-128k-2025-02-19"
"files-api-2025-04-14"
"mcp-client-2025-04-04"
"mcp-client-2025-11-20"
"dev-full-thinking-2025-05-14"
"interleaved-thinking-2025-05-14"
"code-execution-2025-05-22"
"extended-cache-ttl-2025-04-11"
"context-1m-2025-08-07"
"context-management-2025-06-27"
"model-context-window-exceeded-2025-08-26"
"skills-2025-10-02"
"fast-mode-2026-02-01"
"output-300k-2026-03-24"
"user-profiles-2026-03-24"
"user-profiles-2026-08-18"
"user-profiles-2026-09-04"
"advisor-tool-2026-03-01"
"managed-agents-2026-04-01"
"cache-diagnosis-2026-04-07"
"dreaming-2026-04-21"
"thinking-token-count-2026-05-13"
"server-side-fallback-2026-06-01"
"server-side-fallback-2026-07-01"
"fallback-credit-2026-06-01"
"fallback-credit-2026-07-01"
"agent-memory-2026-07-22"
"mid-conversation-tool-changes-2026-07-01"
"compact-2026-01-12"
"computer-use-2025-11-24"
"mcp-tunnels-2026-06-22"
"structured-outputs-2025-11-13"
"task-budgets-2026-03-13"
"thinking-display-updates-2026-08-18"
"ce-user-management-2026-07-13"
"mid-conversation-output-config-2026-07-01"
"thinking-binding-controls-2026-08-01"
"mid-conversation-system-clear-at-2026-08-21"
"compact-2026-09-04"
"inline-tools-2026-09-15"
"mcp-client-2026-09-15"
"ce-plugins-2026-09-01"
"spend-limit-reads-2026-09-26"
"telemetry-destinations-2026-08-11"
"webhooks-2026-10-07"
##### Returns
type: "federation_rule_workspace_deleted"
defaultfederation_rule_workspace_deleted
federation_rule_id: string
Tagged ID of the federation rule.
workspace_id: string
Tagged ID of the workspace named in the delete request. Removal is idempotent.
Remove Federation Rule Workspace
cURL
```python
curl https://api.anthropic.com/v1/organizations/federation_rules/$FEDERATION_RULE_ID/workspaces/$WORKSPACE_ID \
-X DELETE \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"federation_rule_id": "federation_rule_id",
"type": "federation_rule_workspace_deleted",
"workspace_id": "workspace_id"
}
```
##### Returns Examples
Response 200
```python
{
"federation_rule_id": "federation_rule_id",
"type": "federation_rule_workspace_deleted",
"workspace_id": "workspace_id"
---
## Workspaces - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/federation/rules/workspaces
Path: 04-API-Reference/Admin/beta-organization-federation-rules-workspaces.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Ffederation%2Frules%2Fworkspaces)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Issuers
Rules
Create Federation Rule
List Federation Rules
Get Federation Rule
Update Federation Rule
Archive Federation Rule
Workspaces
Add Federation Rule Workspace
List Federation Rule Workspaces
Remove Federation Rule Workspace
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Federation](https://platform.claude.com/docs/en/api/http/beta/organization/federation)
5. [Rules](https://platform.claude.com/docs/en/api/http/beta/organization/federation/rules)
# Workspaces
Copy page
cURL
##### [Add Federation Rule Workspace](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [List Federation Rule Workspaces](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [Remove Federation Rule Workspace](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### Models
WorkspaceRemoveResponse object{ type: "federation_rule_workspace_deleted", federation_rule_id, workspace_id }
type: "federation_rule_workspace_deleted"
defaultfederation_rule_workspace_deleted
federation_rule_id: string
Tagged ID of the federation rule.
workspace_id: string
Tagged ID of the workspace named in the delete request. Removal is idempotent.
---
## Rules - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/federation/rules
Path: 04-API-Reference/Admin/beta-organization-federation-rules.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Ffederation%2Frules)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Issuers
Rules
Create Federation Rule
List Federation Rules
Get Federation Rule
Update Federation Rule
Archive Federation Rule
Workspaces
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Federation](https://platform.claude.com/docs/en/api/http/beta/organization/federation)
# Rules
Copy page
cURL
##### [Create Federation Rule](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [List Federation Rules](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [Get Federation Rule](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [Update Federation Rule](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [Archive Federation Rule](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### Models
BetaFederationRule object{ type: "federation_rule", id, applies_to_all_workspaces, 17 more }
Authorization rule binding an external OIDC identity to Anthropic.
Evaluates the match conditions and mints an OAuth access token for the resolved target, scoped to a single workspace where the rule is enabled (chosen by the caller at exchange time when the rule is enabled for more than one). For rules enabled via `workspace_ids` or `applies_to_all_workspaces`, the target service account must be a member of that workspace (it is implicitly a member of the default workspace); rules carrying only the legacy `workspace_id` binding do not enforce this.
BetaFederationRuleMatch object{ audience, claims, condition, subject_prefix }
Does the incoming JWT qualify?
All populated fields must pass; omitted fields are skipped. At least one of `subject_prefix` (other than a wildcard-only value like `*`), `claims`, or `condition` is required; `audience` alone is not sufficient.
audience: optional string or null
Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default.
maxLength1024
claims: optional map\[string\] or null
Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims.
condition: optional string or null
CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400.
maxLength4096
subject_prefix: optional string or null
Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`.
maxLength1024
BetaFederationRuleWorkspace object{ type: "federation_rule_workspace", created_at, created_by_actor_id, 3 more }
type: "federation_rule_workspace"
defaultfederation_rule_workspace
created_at: string
When this workspace was enabled for the rule.
formatdate-time
created_by_actor_id: string or null
Tagged ID (`user_...` or `svac_...`) of the actor that enabled this workspace for the rule, if known.
federation_rule_id: string
Tagged ID of the federation rule.
workspace_id: string
Tagged ID of the workspace this rule is enabled for.
workspace_name: string or null
Workspace display name. Populated when listing; null in the enable response.
BetaServiceAccountTarget object{ type: "service_account", service_account_id, service_account_name }
Bind to a fixed service account by ID.
type: "service_account"
service_account_id: string
Tagged ID of the service account to mint tokens for.
service_account_name: optional string or null
Service account's display name at read time. Ignored on writes.
#### Rules[Workspaces](https://platform.claude.com/docs/en/api/http/beta/organization/federation/rules/workspaces)
##### [Add Federation Rule Workspace](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [List Federation Rule Workspaces](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [Remove Federation Rule Workspace](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
---
## Federation - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/federation
Path: 04-API-Reference/Admin/beta-organization-federation.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Ffederation)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Issuers
Rules
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
# Federation
Copy page
cURL
#### Federation[Issuers](https://platform.claude.com/docs/en/api/http/beta/organization/federation/issuers)
##### [Create Federation Issuer](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [List Federation Issuers](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [Get Federation Issuer](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [Update Federation Issuer](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [Archive Federation Issuer](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
#### Federation[Rules](https://platform.claude.com/docs/en/api/http/beta/organization/federation/rules)
##### [Create Federation Rule](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [List Federation Rules](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [Get Federation Rule](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [Update Federation Rule](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [Archive Federation Rule](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
#### FederationRules[Workspaces](https://platform.claude.com/docs/en/api/http/beta/organization/federation/rules/workspaces)
##### [Add Federation Rule Workspace](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [List Federation Rule Workspaces](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [Remove Federation Rule Workspace](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
---
## Create Invite - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/invites/create
Path: 04-API-Reference/Admin/beta-organization-invites-create.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Finvites%2Fcreate)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Create Invite
List Invites
Get Invite
Delete Invite
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Invites](https://platform.claude.com/docs/en/api/http/beta/organization/invites)
# Create Invite
POST/v1/organizations/invites
Invite a user to join the organization by email.
On plans that draw members from a finite pool of purchased seats, the invite automatically consumes a seat from the lowest tier with availability; there is no seat-tier parameter. When no seat is free the request fails with a 400 error rather than purchasing a seat.
##### Body
email: string
Email of the User.
formatemail
role: "billing" or "claude_code_user" or "developer" or 2 more
Role for the invited User.
The accepted values depend on the organization type. Console and API organizations accept `user`, `developer`, `billing`, and `claude_code_user`; `admin` cannot be assigned through the API. Claude Enterprise organizations accept `user` and `managed`.
One of the following:
"billing"
"claude_code_user"
"developer"
"managed"
"user"
rbac_group_ids: optional array of string
RBAC group IDs to assign to the User when the Invite is accepted. A non-empty array is accepted only for a Claude Enterprise organization with RBAC groups, and requires the key to carry the `write:rbac_groups` scope.
maxItems100
##### Returns
BetaOrganizationInvite object{ type: "invite", id, accepted_at, 6 more }
Create Invite
cURL
```python
curl https://api.anthropic.com/v1/organizations/invites \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY" \
-d '{
"email": "user@emaildomain.com",
"role": "user"
}'
```
Response 200
```python
{
"id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu",
"accepted_at": "2019-12-27T18:11:19.117Z",
"email": "user@emaildomain.com",
"expires_at": "2024-11-20T23:58:27.427722Z",
"invited_at": "2024-10-30T23:58:27.427722Z",
"rbac_group_ids": [
"string"
],
"role": "admin",
"status": "pending",
"type": "invite"
}
```
##### Returns Examples
Response 200
```python
{
"id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu",
"accepted_at": "2019-12-27T18:11:19.117Z",
"email": "user@emaildomain.com",
"expires_at": "2024-11-20T23:58:27.427722Z",
"invited_at": "2024-10-30T23:58:27.427722Z",
---
## Delete Invite - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/invites/delete
Path: 04-API-Reference/Admin/beta-organization-invites-delete.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Finvites%2Fdelete)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Create Invite
List Invites
Get Invite
Delete Invite
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Invites](https://platform.claude.com/docs/en/api/http/beta/organization/invites)
# Delete Invite
DELETE/v1/organizations/invites/{invite_id}
Delete a pending invite.
##### Path parameters
invite_id: string
ID of the Invite.
##### Returns
type: "invite_deleted"
Deleted object type.
For Invites, this is always `"invite_deleted"`.
defaultinvite_deleted
id: string
ID of the Invite.
Delete Invite
cURL
```python
curl https://api.anthropic.com/v1/organizations/invites/$INVITE_ID \
-X DELETE \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu",
"type": "invite_deleted"
}
```
##### Returns Examples
Response 200
```python
{
"id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu",
---
## List Invites - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/invites/list
Path: 04-API-Reference/Admin/beta-organization-invites-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Finvites%2Flist)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Create Invite
List Invites
Get Invite
Delete Invite
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Invites](https://platform.claude.com/docs/en/api/http/beta/organization/invites)
# List Invites
Copy page
cURL
GET/v1/organizations/invites
List the organization's invites.
##### Query parameters
after_id: optional string
ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object.
before_id: optional string
ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object.
email: optional string
Filter by the email address the Invite was sent to. Matches the same way as the Users list's `email` filter (normalized, case-insensitive).
formatemail
limit: optional number
Number of items to return per page.
Defaults to `20`. Ranges from `1` to `1000`.
default20
minimum1
maximum1000
roles: optional array of string
Filter to items whose `role` equals one of the supplied values. Repeatable; values are OR'ed together.
Accepted values depend on the organization type: Console and API organizations accept `user`, `developer`, `billing`, `admin`, and `claude_code_user`; Claude Enterprise organizations accept `user`, `owner`, `primary_owner`, `membership_admin`, and `managed`.
statuses: optional array of "accepted" or "expired" or "pending"
Filter by Invite status. Repeatable; values are OR'ed together. Omit to return `pending`, `accepted`, and `expired` Invites alike.
One of the following:
"accepted"
"expired"
"pending"
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
##### Returns
data: array of [BetaOrganizationInvite](https://platform.claude.com/docs/en/api/http/beta/organization/invites#beta_organization_invite) { type: "invite", id, accepted_at, 6 more }
type: "invite"
Object type.
For Invites, this is always `"invite"`.
defaultinvite
id: string
ID of the Invite.
accepted_at: string or null
RFC 3339 datetime string indicating when the Invite was accepted, or null.
formatdate-time
email: string
Email of the User being invited.
expires_at: string
RFC 3339 datetime string indicating when the Invite expires.
formatdate-time
invited_at: string
RFC 3339 datetime string indicating when the Invite was created.
formatdate-time
rbac_group_ids: array of string
RBAC group IDs recorded on the Invite (Claude Enterprise organizations), to be assigned to the User when the Invite is accepted. `[]` when none.
role: [BetaOrganizationRole](platform-claude-com-http-beta-organization.md#beta_organization_role)
Organization role of the User.
One of the following:
"admin"
"billing"
"claude_code_user"
"developer"
"managed"
"membership_admin"
"owner"
"primary_owner"
"user"
status: "accepted" or "deleted" or "expired" or "pending"
Status of the Invite.
One of the following:
"accepted"
"deleted"
"expired"
"pending"
first_id: string or null
First ID in the `data` list. Can be used as the `before_id` for the previous page.
has_more: boolean
Indicates if there are more results in the requested page direction.
last_id: string or null
Last ID in the `data` list. Can be used as the `after_id` for the next page.
List Invites
cURL
```python
curl https://api.anthropic.com/v1/organizations/invites \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"data": [
{
"id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu",
"accepted_at": "2019-12-27T18:11:19.117Z",
"email": "user@emaildomain.com",
"expires_at": "2024-11-20T23:58:27.427722Z",
"invited_at": "2024-10-30T23:58:27.427722Z",
"rbac_group_ids": [
"string"
],
"role": "admin",
"status": "pending",
"type": "invite"
}
],
"first_id": "first_id",
"has_more": true,
"last_id": "last_id"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu",
"accepted_at": "2019-12-27T18:11:19.117Z",
"email": "user@emaildomain.com",
"expires_at": "2024-11-20T23:58:27.427722Z",
"invited_at": "2024-10-30T23:58:27.427722Z",
---
## Get Invite - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/invites/retrieve
Path: 04-API-Reference/Admin/beta-organization-invites-retrieve.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Finvites%2Fretrieve)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Create Invite
List Invites
Get Invite
Delete Invite
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Invites](https://platform.claude.com/docs/en/api/http/beta/organization/invites)
# Get Invite
Copy page
cURL
GET/v1/organizations/invites/{invite_id}
Retrieve an invite by ID.
##### Path parameters
invite_id: string
ID of the Invite.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
##### Returns
BetaOrganizationInvite object{ type: "invite", id, accepted_at, 6 more }
Get Invite
cURL
```python
curl https://api.anthropic.com/v1/organizations/invites/$INVITE_ID \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu",
"accepted_at": "2019-12-27T18:11:19.117Z",
"email": "user@emaildomain.com",
"expires_at": "2024-11-20T23:58:27.427722Z",
"invited_at": "2024-10-30T23:58:27.427722Z",
"rbac_group_ids": [
"string"
],
"role": "admin",
"status": "pending",
"type": "invite"
}
```
##### Returns Examples
Response 200
```python
{
"id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu",
"accepted_at": "2019-12-27T18:11:19.117Z",
"email": "user@emaildomain.com",
"expires_at": "2024-11-20T23:58:27.427722Z",
"invited_at": "2024-10-30T23:58:27.427722Z",
---
## Invites - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/invites
Path: 04-API-Reference/Admin/beta-organization-invites.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Finvites)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Create Invite
List Invites
Get Invite
Delete Invite
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
# Invites
Copy page
cURL
##### [Create Invite](https://platform.claude.com/docs/en/api/http/beta/organization/invites/create)
POST/v1/organizations/invites
Invite a user to join the organization by email.
##### [List Invites](https://platform.claude.com/docs/en/api/http/beta/organization/invites/list)
GET/v1/organizations/invites
List the organization's invites.
##### [Get Invite](https://platform.claude.com/docs/en/api/http/beta/organization/invites/retrieve)
GET/v1/organizations/invites/{invite_id}
Retrieve an invite by ID.
##### [Delete Invite](https://platform.claude.com/docs/en/api/http/beta/organization/invites/delete)
DELETE/v1/organizations/invites/{invite_id}
Delete a pending invite.
##### Models
BetaOrganizationInvite object{ type: "invite", id, accepted_at, 6 more }
InviteDeleteResponse object{ type: "invite_deleted", id }
type: "invite_deleted"
Deleted object type.
For Invites, this is always `"invite_deleted"`.
defaultinvite_deleted
id: string
ID of the Invite.
---
## Archive Tunnel - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/mcp_tunnels/archive
Path: 04-API-Reference/Admin/beta-organization-mcp-tunnels-archive.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fmcp_tunnels%2Farchive)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
List Tunnels Deprecated
Get Tunnel Deprecated
Archive Tunnel Deprecated
Reveal Tunnel Token Deprecated
Rotate Tunnel Token Deprecated
Tunnel Certificates
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [MCP Tunnels](https://platform.claude.com/docs/en/api/http/beta/organization/mcp_tunnels)
# Archive Tunnel
Copy page
cURL
Deprecated
POST/v1/organizations/tunnels/{tunnel_id}/archive
**Deprecated.** This Admin API endpoint is superseded by `/v1/tunnels` on the Claude API and will be removed after a migration window. New integrations should use [`/v1/tunnels`](../Endpoints/http-beta-tunnels.md) with the `anthropic-beta: mcp-tunnels-2026-06-22` header and a WIF token carrying the `workspace:manage_tunnels` scope. Existing integrations continue to work with the `mcp-tunnels-2026-05-19` header and `org:manage_tunnels` scope during the migration window.
Archive a tunnel. Archival is irreversible.
Every non-archived certificate on the tunnel is archived in the same operation, the hostname is retired and never re-allocated, and the tunnel token is invalidated. Retrying against an already-archived tunnel returns the existing record unchanged.
##### Path parameters
tunnel_id: string
ID of the Tunnel.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"anthropic-beta": array of [AnthropicBeta](../Endpoints/platform-claude-com-http-beta.md#anthropic_beta)
This endpoint is in beta: requests must send `mcp-tunnels-2026-05-19` in this header.
One of the following:
string
"message-batches-2024-09-24"
"prompt-caching-2024-07-31"
"computer-use-2024-10-22"
"computer-use-2025-01-24"
"pdfs-2024-09-25"
"token-counting-2024-11-01"
"token-efficient-tools-2025-02-19"
"output-128k-2025-02-19"
"files-api-2025-04-14"
"mcp-client-2025-04-04"
"mcp-client-2025-11-20"
"dev-full-thinking-2025-05-14"
"interleaved-thinking-2025-05-14"
"code-execution-2025-05-22"
"extended-cache-ttl-2025-04-11"
"context-1m-2025-08-07"
"context-management-2025-06-27"
"model-context-window-exceeded-2025-08-26"
"skills-2025-10-02"
"fast-mode-2026-02-01"
"output-300k-2026-03-24"
"user-profiles-2026-03-24"
"user-profiles-2026-08-18"
"user-profiles-2026-09-04"
"advisor-tool-2026-03-01"
"managed-agents-2026-04-01"
"cache-diagnosis-2026-04-07"
"dreaming-2026-04-21"
"thinking-token-count-2026-05-13"
"server-side-fallback-2026-06-01"
"server-side-fallback-2026-07-01"
"fallback-credit-2026-06-01"
"fallback-credit-2026-07-01"
"agent-memory-2026-07-22"
"mid-conversation-tool-changes-2026-07-01"
"compact-2026-01-12"
"computer-use-2025-11-24"
"mcp-tunnels-2026-06-22"
"structured-outputs-2025-11-13"
"task-budgets-2026-03-13"
"thinking-display-updates-2026-08-18"
"ce-user-management-2026-07-13"
"mid-conversation-output-config-2026-07-01"
"thinking-binding-controls-2026-08-01"
"mid-conversation-system-clear-at-2026-08-21"
"compact-2026-09-04"
"inline-tools-2026-09-15"
"mcp-client-2026-09-15"
"ce-plugins-2026-09-01"
"spend-limit-reads-2026-09-26"
"telemetry-destinations-2026-08-11"
##### Returns
BetaOrganizationTunnel object{ type: "tunnel", id, archived_at, 4 more }
type: "tunnel"
Object type. Always `tunnel` for Tunnels.
defaulttunnel
id: string
ID of the Tunnel.
archived_at: string or null
RFC 3339 datetime string indicating when the Tunnel was archived, or `null` if it is not archived.
formatdate-time
created_at: string
RFC 3339 datetime string indicating when the Tunnel was created.
formatdate-time
display_name: string or null
Human-readable name for the Tunnel (1–255 characters), or `null` if unset.
domain: string
Anthropic-assigned hostname for the Tunnel. MCP server URLs whose host is a subdomain of this value are routed through the Tunnel. Globally unique and never reused, even after the Tunnel is archived.
workspace_id: string or null
ID of the Workspace this Tunnel belongs to. May be `null` for a Tunnel in the default Workspace. A Tunnel never moves to another Workspace.
Archive Tunnel
cURL
```python
curl https://api.anthropic.com/v1/organizations/tunnels/$TUNNEL_ID/archive \
-X POST \
-H 'anthropic-version: 2023-06-01' \
-H 'anthropic-beta: mcp-tunnels-2026-05-19' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"id": "tnl_01Hx9Kp2RtQvMn3sWbYdLcF8",
"archived_at": "2024-11-01T23:59:27.427722Z",
"created_at": "2024-10-30T23:58:27.427722Z",
"display_name": "Production",
"domain": "a1b2c3d4.tunnel.anthropic.com",
"type": "tunnel",
"workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"
}
```
##### Returns Examples
Response 200
```python
{
"id": "tnl_01Hx9Kp2RtQvMn3sWbYdLcF8",
"archived_at": "2024-11-01T23:59:27.427722Z",
"created_at": "2024-10-30T23:58:27.427722Z",
"display_name": "Production",
"domain": "a1b2c3d4.tunnel.anthropic.com",
"type": "tunnel",
"workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"
---
## List Tunnels - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/mcp_tunnels/list
Path: 04-API-Reference/Admin/beta-organization-mcp-tunnels-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fmcp_tunnels%2Flist)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
List Tunnels Deprecated
Get Tunnel Deprecated
Archive Tunnel Deprecated
Reveal Tunnel Token Deprecated
Rotate Tunnel Token Deprecated
Tunnel Certificates
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [MCP Tunnels](https://platform.claude.com/docs/en/api/http/beta/organization/mcp_tunnels)
# List Tunnels
Copy page
cURL
Deprecated
GET/v1/organizations/tunnels
**Deprecated.** This Admin API endpoint is superseded by `/v1/tunnels` on the Claude API and will be removed after a migration window. New integrations should use [`/v1/tunnels`](../Endpoints/http-beta-tunnels.md) with the `anthropic-beta: mcp-tunnels-2026-06-22` header and a WIF token carrying the `workspace:manage_tunnels` scope. Existing integrations continue to work with the `mcp-tunnels-2026-05-19` header and `org:manage_tunnels` scope during the migration window.
List the organization's tunnels.
Results span the caller's organization, ordered by creation time (newest first). Use `workspace_id` to filter to a single workspace; archived tunnels are excluded unless `include_archived` is set.
##### Query parameters
include_archived: optional boolean
Include archived tunnels in the results. Archived tunnels are excluded by default.
defaultfalse
limit: optional number
Maximum number of tunnels to return in a single page.
default20
minimum1
maximum1000
page: optional string
Opaque pagination cursor from a previous response's `next_page`. Omit to fetch the first page.
workspace_id: optional string
Return only tunnels in this Workspace. Accepts a `wrkspc_`-prefixed Workspace ID; omit to list tunnels across all Workspaces.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"anthropic-beta": array of [AnthropicBeta](../Endpoints/platform-claude-com-http-beta.md#anthropic_beta)
This endpoint is in beta: requests must send `mcp-tunnels-2026-05-19` in this header.
One of the following:
string
"message-batches-2024-09-24"
"prompt-caching-2024-07-31"
"computer-use-2024-10-22"
"computer-use-2025-01-24"
"pdfs-2024-09-25"
"token-counting-2024-11-01"
"token-efficient-tools-2025-02-19"
"output-128k-2025-02-19"
"files-api-2025-04-14"
"mcp-client-2025-04-04"
"mcp-client-2025-11-20"
"dev-full-thinking-2025-05-14"
"interleaved-thinking-2025-05-14"
"code-execution-2025-05-22"
"extended-cache-ttl-2025-04-11"
"context-1m-2025-08-07"
"context-management-2025-06-27"
"model-context-window-exceeded-2025-08-26"
"skills-2025-10-02"
"fast-mode-2026-02-01"
"output-300k-2026-03-24"
"user-profiles-2026-03-24"
"user-profiles-2026-08-18"
"user-profiles-2026-09-04"
"advisor-tool-2026-03-01"
"managed-agents-2026-04-01"
"cache-diagnosis-2026-04-07"
"dreaming-2026-04-21"
"thinking-token-count-2026-05-13"
"server-side-fallback-2026-06-01"
"server-side-fallback-2026-07-01"
"fallback-credit-2026-06-01"
"fallback-credit-2026-07-01"
"agent-memory-2026-07-22"
"mid-conversation-tool-changes-2026-07-01"
"compact-2026-01-12"
"computer-use-2025-11-24"
"mcp-tunnels-2026-06-22"
"structured-outputs-2025-11-13"
"task-budgets-2026-03-13"
"thinking-display-updates-2026-08-18"
"ce-user-management-2026-07-13"
"mid-conversation-output-config-2026-07-01"
"thinking-binding-controls-2026-08-01"
"mid-conversation-system-clear-at-2026-08-21"
"compact-2026-09-04"
"inline-tools-2026-09-15"
"mcp-client-2026-09-15"
"ce-plugins-2026-09-01"
"spend-limit-reads-2026-09-26"
"telemetry-destinations-2026-08-11"
##### Returns
data: array of [BetaOrganizationTunnel](https://platform.claude.com/docs/en/api/http/beta/organization/mcp_tunnels#beta_organization_tunnel) { type: "tunnel", id, archived_at, 4 more }
type: "tunnel"
Object type. Always `tunnel` for Tunnels.
defaulttunnel
id: string
ID of the Tunnel.
archived_at: string or null
RFC 3339 datetime string indicating when the Tunnel was archived, or `null` if it is not archived.
formatdate-time
created_at: string
RFC 3339 datetime string indicating when the Tunnel was created.
formatdate-time
display_name: string or null
Human-readable name for the Tunnel (1–255 characters), or `null` if unset.
domain: string
Anthropic-assigned hostname for the Tunnel. MCP server URLs whose host is a subdomain of this value are routed through the Tunnel. Globally unique and never reused, even after the Tunnel is archived.
workspace_id: string or null
ID of the Workspace this Tunnel belongs to. May be `null` for a Tunnel in the default Workspace. A Tunnel never moves to another Workspace.
next_page: string or null
Opaque cursor for the next page, or `null` if there are no more results.
List Tunnels
cURL
```python
curl https://api.anthropic.com/v1/organizations/tunnels \
-H 'anthropic-version: 2023-06-01' \
-H 'anthropic-beta: mcp-tunnels-2026-05-19' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"data": [
{
"id": "tnl_01Hx9Kp2RtQvMn3sWbYdLcF8",
"archived_at": "2024-11-01T23:59:27.427722Z",
"created_at": "2024-10-30T23:58:27.427722Z",
"display_name": "Production",
"domain": "a1b2c3d4.tunnel.anthropic.com",
"type": "tunnel",
"workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"
}
],
"next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo="
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"id": "tnl_01Hx9Kp2RtQvMn3sWbYdLcF8",
"archived_at": "2024-11-01T23:59:27.427722Z",
"created_at": "2024-10-30T23:58:27.427722Z",
"display_name": "Production",
"domain": "a1b2c3d4.tunnel.anthropic.com",
"type": "tunnel",
"workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"
}
],
"next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo="
---
## Get Tunnel - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/mcp_tunnels/retrieve
Path: 04-API-Reference/Admin/beta-organization-mcp-tunnels-retrieve.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fmcp_tunnels%2Fretrieve)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
List Tunnels Deprecated
Get Tunnel Deprecated
Archive Tunnel Deprecated
Reveal Tunnel Token Deprecated
Rotate Tunnel Token Deprecated
Tunnel Certificates
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [MCP Tunnels](https://platform.claude.com/docs/en/api/http/beta/organization/mcp_tunnels)
# Get Tunnel
Copy page
cURL
Deprecated
GET/v1/organizations/tunnels/{tunnel_id}
**Deprecated.** This Admin API endpoint is superseded by `/v1/tunnels` on the Claude API and will be removed after a migration window. New integrations should use [`/v1/tunnels`](../Endpoints/http-beta-tunnels.md) with the `anthropic-beta: mcp-tunnels-2026-06-22` header and a WIF token carrying the `workspace:manage_tunnels` scope. Existing integrations continue to work with the `mcp-tunnels-2026-05-19` header and `org:manage_tunnels` scope during the migration window.
Retrieve a single tunnel in the caller's organization by ID.
##### Path parameters
tunnel_id: string
ID of the Tunnel.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"anthropic-beta": array of [AnthropicBeta](../Endpoints/platform-claude-com-http-beta.md#anthropic_beta)
This endpoint is in beta: requests must send `mcp-tunnels-2026-05-19` in this header.
One of the following:
string
"message-batches-2024-09-24"
"prompt-caching-2024-07-31"
"computer-use-2024-10-22"
"computer-use-2025-01-24"
"pdfs-2024-09-25"
"token-counting-2024-11-01"
"token-efficient-tools-2025-02-19"
"output-128k-2025-02-19"
"files-api-2025-04-14"
"mcp-client-2025-04-04"
"mcp-client-2025-11-20"
"dev-full-thinking-2025-05-14"
"interleaved-thinking-2025-05-14"
"code-execution-2025-05-22"
"extended-cache-ttl-2025-04-11"
"context-1m-2025-08-07"
"context-management-2025-06-27"
"model-context-window-exceeded-2025-08-26"
"skills-2025-10-02"
"fast-mode-2026-02-01"
"output-300k-2026-03-24"
"user-profiles-2026-03-24"
"user-profiles-2026-08-18"
"user-profiles-2026-09-04"
"advisor-tool-2026-03-01"
"managed-agents-2026-04-01"
"cache-diagnosis-2026-04-07"
"dreaming-2026-04-21"
"thinking-token-count-2026-05-13"
"server-side-fallback-2026-06-01"
"server-side-fallback-2026-07-01"
"fallback-credit-2026-06-01"
"fallback-credit-2026-07-01"
"agent-memory-2026-07-22"
"mid-conversation-tool-changes-2026-07-01"
"compact-2026-01-12"
"computer-use-2025-11-24"
"mcp-tunnels-2026-06-22"
"structured-outputs-2025-11-13"
"task-budgets-2026-03-13"
"thinking-display-updates-2026-08-18"
"ce-user-management-2026-07-13"
"mid-conversation-output-config-2026-07-01"
"thinking-binding-controls-2026-08-01"
"mid-conversation-system-clear-at-2026-08-21"
"compact-2026-09-04"
"inline-tools-2026-09-15"
"mcp-client-2026-09-15"
"ce-plugins-2026-09-01"
"spend-limit-reads-2026-09-26"
"telemetry-destinations-2026-08-11"
##### Returns
BetaOrganizationTunnel object{ type: "tunnel", id, archived_at, 4 more }
type: "tunnel"
Object type. Always `tunnel` for Tunnels.
defaulttunnel
id: string
ID of the Tunnel.
archived_at: string or null
RFC 3339 datetime string indicating when the Tunnel was archived, or `null` if it is not archived.
formatdate-time
created_at: string
RFC 3339 datetime string indicating when the Tunnel was created.
formatdate-time
display_name: string or null
Human-readable name for the Tunnel (1–255 characters), or `null` if unset.
domain: string
Anthropic-assigned hostname for the Tunnel. MCP server URLs whose host is a subdomain of this value are routed through the Tunnel. Globally unique and never reused, even after the Tunnel is archived.
workspace_id: string or null
ID of the Workspace this Tunnel belongs to. May be `null` for a Tunnel in the default Workspace. A Tunnel never moves to another Workspace.
Get Tunnel
cURL
```python
curl https://api.anthropic.com/v1/organizations/tunnels/$TUNNEL_ID \
-H 'anthropic-version: 2023-06-01' \
-H 'anthropic-beta: mcp-tunnels-2026-05-19' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"id": "tnl_01Hx9Kp2RtQvMn3sWbYdLcF8",
"archived_at": "2024-11-01T23:59:27.427722Z",
"created_at": "2024-10-30T23:58:27.427722Z",
"display_name": "Production",
"domain": "a1b2c3d4.tunnel.anthropic.com",
"type": "tunnel",
"workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"
}
```
##### Returns Examples
Response 200
```python
{
"id": "tnl_01Hx9Kp2RtQvMn3sWbYdLcF8",
"archived_at": "2024-11-01T23:59:27.427722Z",
"created_at": "2024-10-30T23:58:27.427722Z",
"display_name": "Production",
"domain": "a1b2c3d4.tunnel.anthropic.com",
"type": "tunnel",
"workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"
---
## Reveal Tunnel Token - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/mcp_tunnels/reveal_token
Path: 04-API-Reference/Admin/beta-organization-mcp-tunnels-reveal-token.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fmcp_tunnels%2Freveal_token)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
List Tunnels Deprecated
Get Tunnel Deprecated
Archive Tunnel Deprecated
Reveal Tunnel Token Deprecated
Rotate Tunnel Token Deprecated
Tunnel Certificates
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [MCP Tunnels](https://platform.claude.com/docs/en/api/http/beta/organization/mcp_tunnels)
# Reveal Tunnel Token
Copy page
cURL
Deprecated
POST/v1/organizations/tunnels/{tunnel_id}/reveal_token
**Deprecated.** This Admin API endpoint is superseded by `/v1/tunnels` on the Claude API and will be removed after a migration window. New integrations should use [`/v1/tunnels`](../Endpoints/http-beta-tunnels.md) with the `anthropic-beta: mcp-tunnels-2026-06-22` header and a WIF token carrying the `workspace:manage_tunnels` scope. Existing integrations continue to work with the `mcp-tunnels-2026-05-19` header and `org:manage_tunnels` scope during the migration window.
Return the tunnel's current connection token.
The value is fetched live on each call; Anthropic does not store it. Repeated calls return the same value until the token is rotated. Exposed as `POST` so the token does not appear in intermediary access logs.
##### Path parameters
tunnel_id: string
ID of the Tunnel.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"anthropic-beta": array of [AnthropicBeta](../Endpoints/platform-claude-com-http-beta.md#anthropic_beta)
This endpoint is in beta: requests must send `mcp-tunnels-2026-05-19` in this header.
One of the following:
string
"message-batches-2024-09-24"
"prompt-caching-2024-07-31"
"computer-use-2024-10-22"
"computer-use-2025-01-24"
"pdfs-2024-09-25"
"token-counting-2024-11-01"
"token-efficient-tools-2025-02-19"
"output-128k-2025-02-19"
"files-api-2025-04-14"
"mcp-client-2025-04-04"
"mcp-client-2025-11-20"
"dev-full-thinking-2025-05-14"
"interleaved-thinking-2025-05-14"
"code-execution-2025-05-22"
"extended-cache-ttl-2025-04-11"
"context-1m-2025-08-07"
"context-management-2025-06-27"
"model-context-window-exceeded-2025-08-26"
"skills-2025-10-02"
"fast-mode-2026-02-01"
"output-300k-2026-03-24"
"user-profiles-2026-03-24"
"user-profiles-2026-08-18"
"user-profiles-2026-09-04"
"advisor-tool-2026-03-01"
"managed-agents-2026-04-01"
"cache-diagnosis-2026-04-07"
"dreaming-2026-04-21"
"thinking-token-count-2026-05-13"
"server-side-fallback-2026-06-01"
"server-side-fallback-2026-07-01"
"fallback-credit-2026-06-01"
"fallback-credit-2026-07-01"
"agent-memory-2026-07-22"
"mid-conversation-tool-changes-2026-07-01"
"compact-2026-01-12"
"computer-use-2025-11-24"
"mcp-tunnels-2026-06-22"
"structured-outputs-2025-11-13"
"task-budgets-2026-03-13"
"thinking-display-updates-2026-08-18"
"ce-user-management-2026-07-13"
"mid-conversation-output-config-2026-07-01"
"thinking-binding-controls-2026-08-01"
"mid-conversation-system-clear-at-2026-08-21"
"compact-2026-09-04"
"inline-tools-2026-09-15"
"mcp-client-2026-09-15"
"ce-plugins-2026-09-01"
"spend-limit-reads-2026-09-26"
"telemetry-destinations-2026-08-11"
##### Returns
BetaOrganizationTunnelToken object{ type: "tunnel_token", id, tunnel_token }
type: "tunnel_token"
Object type. Always `tunnel_token` for Tunnel Tokens.
defaulttunnel_token
id: string
Stable identifier for the current token value. Changes when the token is rotated.
tunnel_token: string
The tunnel's connection token.
Reveal Tunnel Token
cURL
```python
curl https://api.anthropic.com/v1/organizations/tunnels/$TUNNEL_ID/reveal_token \
-X POST \
-H 'anthropic-version: 2023-06-01' \
-H 'anthropic-beta: mcp-tunnels-2026-05-19' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"id": "ttkn_bb97000eaec162831399ca9b6684a4fdf5be49ace5683057b017aab5c87e19e0",
"tunnel_token": "eyJhIjoiRVhBTVBMRSIsInQiOiJFWEFNUExFIiwicyI6IkVYQU1QTEUifQ==",
"type": "tunnel_token"
}
```
##### Returns Examples
Response 200
```python
{
"id": "ttkn_bb97000eaec162831399ca9b6684a4fdf5be49ace5683057b017aab5c87e19e0",
"tunnel_token": "eyJhIjoiRVhBTVBMRSIsInQiOiJFWEFNUExFIiwicyI6IkVYQU1QTEUifQ==",
---
## Rotate Tunnel Token - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/mcp_tunnels/rotate_token
Path: 04-API-Reference/Admin/beta-organization-mcp-tunnels-rotate-token.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fmcp_tunnels%2Frotate_token)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
List Tunnels Deprecated
Get Tunnel Deprecated
Archive Tunnel Deprecated
Reveal Tunnel Token Deprecated
Rotate Tunnel Token Deprecated
Tunnel Certificates
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [MCP Tunnels](https://platform.claude.com/docs/en/api/http/beta/organization/mcp_tunnels)
# Rotate Tunnel Token
Copy page
cURL
Deprecated
POST/v1/organizations/tunnels/{tunnel_id}/rotate_token
**Deprecated.** This Admin API endpoint is superseded by `/v1/tunnels` on the Claude API and will be removed after a migration window. New integrations should use [`/v1/tunnels`](../Endpoints/http-beta-tunnels.md) with the `anthropic-beta: mcp-tunnels-2026-06-22` header and a WIF token carrying the `workspace:manage_tunnels` scope. Existing integrations continue to work with the `mcp-tunnels-2026-05-19` header and `org:manage_tunnels` scope during the migration window.
Invalidate the tunnel's current token for new connections and return a fresh value.
Established connections are not severed by rotation; a connector restarted after rotation must use the new value. An optional `reason` is captured for operational context.
##### Path parameters
tunnel_id: string
ID of the Tunnel.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"anthropic-beta": array of [AnthropicBeta](../Endpoints/platform-claude-com-http-beta.md#anthropic_beta)
This endpoint is in beta: requests must send `mcp-tunnels-2026-05-19` in this header.
One of the following:
string
"message-batches-2024-09-24"
"prompt-caching-2024-07-31"
"computer-use-2024-10-22"
"computer-use-2025-01-24"
"pdfs-2024-09-25"
"token-counting-2024-11-01"
"token-efficient-tools-2025-02-19"
"output-128k-2025-02-19"
"files-api-2025-04-14"
"mcp-client-2025-04-04"
"mcp-client-2025-11-20"
"dev-full-thinking-2025-05-14"
"interleaved-thinking-2025-05-14"
"code-execution-2025-05-22"
"extended-cache-ttl-2025-04-11"
"context-1m-2025-08-07"
"context-management-2025-06-27"
"model-context-window-exceeded-2025-08-26"
"skills-2025-10-02"
"fast-mode-2026-02-01"
"output-300k-2026-03-24"
"user-profiles-2026-03-24"
"user-profiles-2026-08-18"
"user-profiles-2026-09-04"
"advisor-tool-2026-03-01"
"managed-agents-2026-04-01"
"cache-diagnosis-2026-04-07"
"dreaming-2026-04-21"
"thinking-token-count-2026-05-13"
"server-side-fallback-2026-06-01"
"server-side-fallback-2026-07-01"
"fallback-credit-2026-06-01"
"fallback-credit-2026-07-01"
"agent-memory-2026-07-22"
"mid-conversation-tool-changes-2026-07-01"
"compact-2026-01-12"
"computer-use-2025-11-24"
"mcp-tunnels-2026-06-22"
"structured-outputs-2025-11-13"
"task-budgets-2026-03-13"
"thinking-display-updates-2026-08-18"
"ce-user-management-2026-07-13"
"mid-conversation-output-config-2026-07-01"
"thinking-binding-controls-2026-08-01"
"mid-conversation-system-clear-at-2026-08-21"
"compact-2026-09-04"
"inline-tools-2026-09-15"
"mcp-client-2026-09-15"
"ce-plugins-2026-09-01"
"spend-limit-reads-2026-09-26"
"telemetry-destinations-2026-08-11"
##### Body
reason: optional string or null
Optional free-text reason for the rotation, recorded for audit.
maxLength1024
##### Returns
BetaOrganizationTunnelToken object{ type: "tunnel_token", id, tunnel_token }
type: "tunnel_token"
Object type. Always `tunnel_token` for Tunnel Tokens.
defaulttunnel_token
id: string
Stable identifier for the current token value. Changes when the token is rotated.
tunnel_token: string
The tunnel's connection token.
Rotate Tunnel Token
cURL
```python
curl https://api.anthropic.com/v1/organizations/tunnels/$TUNNEL_ID/rotate_token \
-X POST \
-H 'anthropic-version: 2023-06-01' \
-H 'anthropic-beta: mcp-tunnels-2026-05-19' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"id": "ttkn_bb97000eaec162831399ca9b6684a4fdf5be49ace5683057b017aab5c87e19e0",
"tunnel_token": "eyJhIjoiRVhBTVBMRSIsInQiOiJFWEFNUExFIiwicyI6IkVYQU1QTEUifQ==",
"type": "tunnel_token"
}
```
##### Returns Examples
Response 200
```python
{
"id": "ttkn_bb97000eaec162831399ca9b6684a4fdf5be49ace5683057b017aab5c87e19e0",
"tunnel_token": "eyJhIjoiRVhBTVBMRSIsInQiOiJFWEFNUExFIiwicyI6IkVYQU1QTEUifQ==",
---
## Archive Tunnel Certificate - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/mcp_tunnels/tunnel_certificates/archive
Path: 04-API-Reference/Admin/beta-organization-mcp-tunnels-tunnel-certificates-archive.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fmcp_tunnels%2Ftunnel_certificates%2Farchive)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
List Tunnels Deprecated
Get Tunnel Deprecated
Archive Tunnel Deprecated
Reveal Tunnel Token Deprecated
Rotate Tunnel Token Deprecated
Tunnel Certificates
Create Tunnel Certificate Deprecated
List Tunnel Certificates Deprecated
Get Tunnel Certificate Deprecated
Archive Tunnel Certificate Deprecated
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [MCP Tunnels](https://platform.claude.com/docs/en/api/http/beta/organization/mcp_tunnels)
5. [Tunnel Certificates](https://platform.claude.com/docs/en/api/http/beta/organization/mcp_tunnels/tunnel_certificates)
# Archive Tunnel Certificate
Copy page
cURL
Deprecated
POST/v1/organizations/tunnels/{tunnel_id}/certificates/{certificate_id}/archive
**Deprecated.** This Admin API endpoint is superseded by `/v1/tunnels` on the Claude API and will be removed after a migration window. New integrations should use [`/v1/tunnels`](../Endpoints/http-beta-tunnels.md) with the `anthropic-beta: mcp-tunnels-2026-06-22` header and a WIF token carrying the `workspace:manage_tunnels` scope. Existing integrations continue to work with the `mcp-tunnels-2026-05-19` header and `org:manage_tunnels` scope during the migration window.
Archive a certificate, removing it from the set Anthropic trusts for this tunnel.
The certificate record is retained. Archiving the last non-archived certificate is permitted; the tunnel rejects MCP traffic until a new certificate is added.
##### Path parameters
tunnel_id: string
ID of the Tunnel.
certificate_id: string
ID of the Tunnel Certificate.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"anthropic-beta": array of [AnthropicBeta](../Endpoints/platform-claude-com-http-beta.md#anthropic_beta)
This endpoint is in beta: requests must send `mcp-tunnels-2026-05-19` in this header.
One of the following:
string
"message-batches-2024-09-24"
"prompt-caching-2024-07-31"
"computer-use-2024-10-22"
"computer-use-2025-01-24"
"pdfs-2024-09-25"
"token-counting-2024-11-01"
"token-efficient-tools-2025-02-19"
"output-128k-2025-02-19"
"files-api-2025-04-14"
"mcp-client-2025-04-04"
"mcp-client-2025-11-20"
"dev-full-thinking-2025-05-14"
"interleaved-thinking-2025-05-14"
"code-execution-2025-05-22"
"extended-cache-ttl-2025-04-11"
"context-1m-2025-08-07"
"context-management-2025-06-27"
"model-context-window-exceeded-2025-08-26"
"skills-2025-10-02"
"fast-mode-2026-02-01"
"output-300k-2026-03-24"
"user-profiles-2026-03-24"
"user-profiles-2026-08-18"
"user-profiles-2026-09-04"
"advisor-tool-2026-03-01"
"managed-agents-2026-04-01"
"cache-diagnosis-2026-04-07"
"dreaming-2026-04-21"
"thinking-token-count-2026-05-13"
"server-side-fallback-2026-06-01"
"server-side-fallback-2026-07-01"
"fallback-credit-2026-06-01"
"fallback-credit-2026-07-01"
"agent-memory-2026-07-22"
"mid-conversation-tool-changes-2026-07-01"
"compact-2026-01-12"
"computer-use-2025-11-24"
"mcp-tunnels-2026-06-22"
"structured-outputs-2025-11-13"
"task-budgets-2026-03-13"
"thinking-display-updates-2026-08-18"
"ce-user-management-2026-07-13"
"mid-conversation-output-config-2026-07-01"
"thinking-binding-controls-2026-08-01"
"mid-conversation-system-clear-at-2026-08-21"
"compact-2026-09-04"
"inline-tools-2026-09-15"
"mcp-client-2026-09-15"
"ce-plugins-2026-09-01"
"spend-limit-reads-2026-09-26"
"telemetry-destinations-2026-08-11"
##### Returns
BetaOrganizationTunnelCertificate object{ type: "tunnel_certificate", id, archived_at, 4 more }
type: "tunnel_certificate"
Object type. Always `tunnel_certificate` for Tunnel Certificates.
defaulttunnel_certificate
id: string
ID of the Tunnel Certificate.
archived_at: string or null
RFC 3339 datetime string indicating when the certificate was archived, or `null` if it is not archived.
formatdate-time
created_at: string
RFC 3339 datetime string indicating when the certificate was registered.
formatdate-time
expires_at: string or null
RFC 3339 datetime string indicating when the certificate expires, or `null` if it does not expire.
formatdate-time
fingerprint: string
The certificate's SHA-256 fingerprint, as a lowercase hex string.
tunnel_id: string
ID of the Tunnel this certificate is registered against.
Archive Tunnel Certificate
cURL
```python
curl https://api.anthropic.com/v1/organizations/tunnels/$TUNNEL_ID/certificates/$CERTIFICATE_ID/archive \
-X POST \
-H 'anthropic-version: 2023-06-01' \
-H 'anthropic-beta: mcp-tunnels-2026-05-19' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"id": "tcrt_01JmWq4ZxnBvR7tKpY2sLdH9",
"archived_at": "2024-11-01T23:59:27.427722Z",
"created_at": "2024-10-30T23:58:27.427722Z",
"expires_at": "2024-10-30T23:58:27.427722Z",
"fingerprint": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
"tunnel_id": "tnl_01Hx9Kp2RtQvMn3sWbYdLcF8",
"type": "tunnel_certificate"
}
```
##### Returns Examples
Response 200
```python
{
"id": "tcrt_01JmWq4ZxnBvR7tKpY2sLdH9",
"archived_at": "2024-11-01T23:59:27.427722Z",
"created_at": "2024-10-30T23:58:27.427722Z",
"expires_at": "2024-10-30T23:58:27.427722Z",
"fingerprint": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
"tunnel_id": "tnl_01Hx9Kp2RtQvMn3sWbYdLcF8",
---
## Create Tunnel Certificate - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/mcp_tunnels/tunnel_certificates/create
Path: 04-API-Reference/Admin/beta-organization-mcp-tunnels-tunnel-certificates-create.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fmcp_tunnels%2Ftunnel_certificates%2Fcreate)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
List Tunnels Deprecated
Get Tunnel Deprecated
Archive Tunnel Deprecated
Reveal Tunnel Token Deprecated
Rotate Tunnel Token Deprecated
Tunnel Certificates
Create Tunnel Certificate Deprecated
List Tunnel Certificates Deprecated
Get Tunnel Certificate Deprecated
Archive Tunnel Certificate Deprecated
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [MCP Tunnels](https://platform.claude.com/docs/en/api/http/beta/organization/mcp_tunnels)
5. [Tunnel Certificates](https://platform.claude.com/docs/en/api/http/beta/organization/mcp_tunnels/tunnel_certificates)
# Create Tunnel Certificate
Copy page
cURL
Deprecated
POST/v1/organizations/tunnels/{tunnel_id}/certificates
**Deprecated.** This Admin API endpoint is superseded by `/v1/tunnels` on the Claude API and will be removed after a migration window. New integrations should use [`/v1/tunnels`](../Endpoints/http-beta-tunnels.md) with the `anthropic-beta: mcp-tunnels-2026-06-22` header and a WIF token carrying the `workspace:manage_tunnels` scope. Existing integrations continue to work with the `mcp-tunnels-2026-05-19` header and `org:manage_tunnels` scope during the migration window.
Register a public CA certificate for the tunnel.
Anthropic verifies the gateway's server certificate against this CA when it terminates the inner TLS session. The PEM body must contain exactly one X.509 certificate and no private-key material. A tunnel holds at most two non-archived certificates.
##### Path parameters
tunnel_id: string
ID of the Tunnel.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"anthropic-beta": array of [AnthropicBeta](../Endpoints/platform-claude-com-http-beta.md#anthropic_beta)
This endpoint is in beta: requests must send `mcp-tunnels-2026-05-19` in this header.
One of the following:
string
"message-batches-2024-09-24"
"prompt-caching-2024-07-31"
"computer-use-2024-10-22"
"computer-use-2025-01-24"
"pdfs-2024-09-25"
"token-counting-2024-11-01"
"token-efficient-tools-2025-02-19"
"output-128k-2025-02-19"
"files-api-2025-04-14"
"mcp-client-2025-04-04"
"mcp-client-2025-11-20"
"dev-full-thinking-2025-05-14"
"interleaved-thinking-2025-05-14"
"code-execution-2025-05-22"
"extended-cache-ttl-2025-04-11"
"context-1m-2025-08-07"
"context-management-2025-06-27"
"model-context-window-exceeded-2025-08-26"
"skills-2025-10-02"
"fast-mode-2026-02-01"
"output-300k-2026-03-24"
"user-profiles-2026-03-24"
"user-profiles-2026-08-18"
"user-profiles-2026-09-04"
"advisor-tool-2026-03-01"
"managed-agents-2026-04-01"
"cache-diagnosis-2026-04-07"
"dreaming-2026-04-21"
"thinking-token-count-2026-05-13"
"server-side-fallback-2026-06-01"
"server-side-fallback-2026-07-01"
"fallback-credit-2026-06-01"
"fallback-credit-2026-07-01"
"agent-memory-2026-07-22"
"mid-conversation-tool-changes-2026-07-01"
"compact-2026-01-12"
"computer-use-2025-11-24"
"mcp-tunnels-2026-06-22"
"structured-outputs-2025-11-13"
"task-budgets-2026-03-13"
"thinking-display-updates-2026-08-18"
"ce-user-management-2026-07-13"
"mid-conversation-output-config-2026-07-01"
"thinking-binding-controls-2026-08-01"
"mid-conversation-system-clear-at-2026-08-21"
"compact-2026-09-04"
"inline-tools-2026-09-15"
"mcp-client-2026-09-15"
"ce-plugins-2026-09-01"
"spend-limit-reads-2026-09-26"
"telemetry-destinations-2026-08-11"
##### Body
ca_certificate_pem: string
PEM-encoded X.509 CA certificate. Must contain exactly one certificate and no private-key material.
maxLength8192
##### Returns
BetaOrganizationTunnelCertificate object{ type: "tunnel_certificate", id, archived_at, 4 more }
type: "tunnel_certificate"
Object type. Always `tunnel_certificate` for Tunnel Certificates.
defaulttunnel_certificate
id: string
ID of the Tunnel Certificate.
archived_at: string or null
RFC 3339 datetime string indicating when the certificate was archived, or `null` if it is not archived.
formatdate-time
created_at: string
RFC 3339 datetime string indicating when the certificate was registered.
formatdate-time
expires_at: string or null
RFC 3339 datetime string indicating when the certificate expires, or `null` if it does not expire.
formatdate-time
fingerprint: string
The certificate's SHA-256 fingerprint, as a lowercase hex string.
tunnel_id: string
ID of the Tunnel this certificate is registered against.
Create Tunnel Certificate
cURL
```python
curl https://api.anthropic.com/v1/organizations/tunnels/$TUNNEL_ID/certificates \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H 'anthropic-beta: mcp-tunnels-2026-05-19' \
-H "X-Api-Key: $ANTHROPIC_API_KEY" \
-d '{
"ca_certificate_pem": "-----BEGIN CERTIFICATE-----\nMIIBexampleEXAMPLEexampleEXAMPLEexampleEXAMPLEexampleEXAMPLEexa\n...illustrative placeholder, not a real certificate...\n-----END CERTIFICATE-----\n"
}'
```
Response 200
```python
{
"id": "tcrt_01JmWq4ZxnBvR7tKpY2sLdH9",
"archived_at": "2024-11-01T23:59:27.427722Z",
"created_at": "2024-10-30T23:58:27.427722Z",
"expires_at": "2024-10-30T23:58:27.427722Z",
"fingerprint": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
"tunnel_id": "tnl_01Hx9Kp2RtQvMn3sWbYdLcF8",
"type": "tunnel_certificate"
}
```
##### Returns Examples
Response 200
```python
{
"id": "tcrt_01JmWq4ZxnBvR7tKpY2sLdH9",
"archived_at": "2024-11-01T23:59:27.427722Z",
"created_at": "2024-10-30T23:58:27.427722Z",
"expires_at": "2024-10-30T23:58:27.427722Z",
"fingerprint": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
"tunnel_id": "tnl_01Hx9Kp2RtQvMn3sWbYdLcF8",
---
## List Tunnel Certificates - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/mcp_tunnels/tunnel_certificates/list
Path: 04-API-Reference/Admin/beta-organization-mcp-tunnels-tunnel-certificates-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fmcp_tunnels%2Ftunnel_certificates%2Flist)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
List Tunnels Deprecated
Get Tunnel Deprecated
Archive Tunnel Deprecated
Reveal Tunnel Token Deprecated
Rotate Tunnel Token Deprecated
Tunnel Certificates
Create Tunnel Certificate Deprecated
List Tunnel Certificates Deprecated
Get Tunnel Certificate Deprecated
Archive Tunnel Certificate Deprecated
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [MCP Tunnels](https://platform.claude.com/docs/en/api/http/beta/organization/mcp_tunnels)
5. [Tunnel Certificates](https://platform.claude.com/docs/en/api/http/beta/organization/mcp_tunnels/tunnel_certificates)
# List Tunnel Certificates
Copy page
cURL
Deprecated
GET/v1/organizations/tunnels/{tunnel_id}/certificates
**Deprecated.** This Admin API endpoint is superseded by `/v1/tunnels` on the Claude API and will be removed after a migration window. New integrations should use [`/v1/tunnels`](../Endpoints/http-beta-tunnels.md) with the `anthropic-beta: mcp-tunnels-2026-06-22` header and a WIF token carrying the `workspace:manage_tunnels` scope. Existing integrations continue to work with the `mcp-tunnels-2026-05-19` header and `org:manage_tunnels` scope during the migration window.
List the certificates registered on a tunnel.
Archived certificates are excluded unless `include_archived` is set.
##### Path parameters
tunnel_id: string
ID of the Tunnel.
##### Query parameters
include_archived: optional boolean
Include archived certificates in the results. Archived certificates are excluded by default.
defaultfalse
limit: optional number
Maximum number of certificates to return.
default20
minimum1
maximum1000
page: optional string
A tunnel has at most two active certificates, so this list is not paginated.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"anthropic-beta": array of [AnthropicBeta](../Endpoints/platform-claude-com-http-beta.md#anthropic_beta)
This endpoint is in beta: requests must send `mcp-tunnels-2026-05-19` in this header.
One of the following:
string
"message-batches-2024-09-24"
"prompt-caching-2024-07-31"
"computer-use-2024-10-22"
"computer-use-2025-01-24"
"pdfs-2024-09-25"
"token-counting-2024-11-01"
"token-efficient-tools-2025-02-19"
"output-128k-2025-02-19"
"files-api-2025-04-14"
"mcp-client-2025-04-04"
"mcp-client-2025-11-20"
"dev-full-thinking-2025-05-14"
"interleaved-thinking-2025-05-14"
"code-execution-2025-05-22"
"extended-cache-ttl-2025-04-11"
"context-1m-2025-08-07"
"context-management-2025-06-27"
"model-context-window-exceeded-2025-08-26"
"skills-2025-10-02"
"fast-mode-2026-02-01"
"output-300k-2026-03-24"
"user-profiles-2026-03-24"
"user-profiles-2026-08-18"
"user-profiles-2026-09-04"
"advisor-tool-2026-03-01"
"managed-agents-2026-04-01"
"cache-diagnosis-2026-04-07"
"dreaming-2026-04-21"
"thinking-token-count-2026-05-13"
"server-side-fallback-2026-06-01"
"server-side-fallback-2026-07-01"
"fallback-credit-2026-06-01"
"fallback-credit-2026-07-01"
"agent-memory-2026-07-22"
"mid-conversation-tool-changes-2026-07-01"
"compact-2026-01-12"
"computer-use-2025-11-24"
"mcp-tunnels-2026-06-22"
"structured-outputs-2025-11-13"
"task-budgets-2026-03-13"
"thinking-display-updates-2026-08-18"
"ce-user-management-2026-07-13"
"mid-conversation-output-config-2026-07-01"
"thinking-binding-controls-2026-08-01"
"mid-conversation-system-clear-at-2026-08-21"
"compact-2026-09-04"
"inline-tools-2026-09-15"
"mcp-client-2026-09-15"
"ce-plugins-2026-09-01"
"spend-limit-reads-2026-09-26"
"telemetry-destinations-2026-08-11"
##### Returns
data: array of [BetaOrganizationTunnelCertificate](https://platform.claude.com/docs/en/api/http/beta/organization/mcp_tunnels/tunnel_certificates#beta_organization_tunnel_certificate) { type: "tunnel_certificate", id, archived_at, 4 more }
type: "tunnel_certificate"
Object type. Always `tunnel_certificate` for Tunnel Certificates.
defaulttunnel_certificate
id: string
ID of the Tunnel Certificate.
archived_at: string or null
RFC 3339 datetime string indicating when the certificate was archived, or `null` if it is not archived.
formatdate-time
created_at: string
RFC 3339 datetime string indicating when the certificate was registered.
formatdate-time
expires_at: string or null
RFC 3339 datetime string indicating when the certificate expires, or `null` if it does not expire.
formatdate-time
fingerprint: string
The certificate's SHA-256 fingerprint, as a lowercase hex string.
tunnel_id: string
ID of the Tunnel this certificate is registered against.
next_page: string or null
Opaque cursor for the next page, or `null` if there are no more results.
List Tunnel Certificates
cURL
```python
curl https://api.anthropic.com/v1/organizations/tunnels/$TUNNEL_ID/certificates \
-H 'anthropic-version: 2023-06-01' \
-H 'anthropic-beta: mcp-tunnels-2026-05-19' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"data": [
{
"id": "tcrt_01JmWq4ZxnBvR7tKpY2sLdH9",
"archived_at": "2024-11-01T23:59:27.427722Z",
"created_at": "2024-10-30T23:58:27.427722Z",
"expires_at": "2024-10-30T23:58:27.427722Z",
"fingerprint": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
"tunnel_id": "tnl_01Hx9Kp2RtQvMn3sWbYdLcF8",
"type": "tunnel_certificate"
}
],
"next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo="
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"id": "tcrt_01JmWq4ZxnBvR7tKpY2sLdH9",
"archived_at": "2024-11-01T23:59:27.427722Z",
"created_at": "2024-10-30T23:58:27.427722Z",
"expires_at": "2024-10-30T23:58:27.427722Z",
"fingerprint": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
"tunnel_id": "tnl_01Hx9Kp2RtQvMn3sWbYdLcF8",
"type": "tunnel_certificate"
}
],
"next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo="
---
## Get Tunnel Certificate - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/mcp_tunnels/tunnel_certificates/retrieve
Path: 04-API-Reference/Admin/beta-organization-mcp-tunnels-tunnel-certificates-retrieve.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fmcp_tunnels%2Ftunnel_certificates%2Fretrieve)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
List Tunnels Deprecated
Get Tunnel Deprecated
Archive Tunnel Deprecated
Reveal Tunnel Token Deprecated
Rotate Tunnel Token Deprecated
Tunnel Certificates
Create Tunnel Certificate Deprecated
List Tunnel Certificates Deprecated
Get Tunnel Certificate Deprecated
Archive Tunnel Certificate Deprecated
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [MCP Tunnels](https://platform.claude.com/docs/en/api/http/beta/organization/mcp_tunnels)
5. [Tunnel Certificates](https://platform.claude.com/docs/en/api/http/beta/organization/mcp_tunnels/tunnel_certificates)
# Get Tunnel Certificate
Copy page
cURL
Deprecated
GET/v1/organizations/tunnels/{tunnel_id}/certificates/{certificate_id}
**Deprecated.** This Admin API endpoint is superseded by `/v1/tunnels` on the Claude API and will be removed after a migration window. New integrations should use [`/v1/tunnels`](../Endpoints/http-beta-tunnels.md) with the `anthropic-beta: mcp-tunnels-2026-06-22` header and a WIF token carrying the `workspace:manage_tunnels` scope. Existing integrations continue to work with the `mcp-tunnels-2026-05-19` header and `org:manage_tunnels` scope during the migration window.
Retrieve a single certificate registered on a tunnel by ID.
##### Path parameters
tunnel_id: string
ID of the Tunnel.
certificate_id: string
ID of the Tunnel Certificate.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"anthropic-beta": array of [AnthropicBeta](../Endpoints/platform-claude-com-http-beta.md#anthropic_beta)
This endpoint is in beta: requests must send `mcp-tunnels-2026-05-19` in this header.
One of the following:
string
"message-batches-2024-09-24"
"prompt-caching-2024-07-31"
"computer-use-2024-10-22"
"computer-use-2025-01-24"
"pdfs-2024-09-25"
"token-counting-2024-11-01"
"token-efficient-tools-2025-02-19"
"output-128k-2025-02-19"
"files-api-2025-04-14"
"mcp-client-2025-04-04"
"mcp-client-2025-11-20"
"dev-full-thinking-2025-05-14"
"interleaved-thinking-2025-05-14"
"code-execution-2025-05-22"
"extended-cache-ttl-2025-04-11"
"context-1m-2025-08-07"
"context-management-2025-06-27"
"model-context-window-exceeded-2025-08-26"
"skills-2025-10-02"
"fast-mode-2026-02-01"
"output-300k-2026-03-24"
"user-profiles-2026-03-24"
"user-profiles-2026-08-18"
"user-profiles-2026-09-04"
"advisor-tool-2026-03-01"
"managed-agents-2026-04-01"
"cache-diagnosis-2026-04-07"
"dreaming-2026-04-21"
"thinking-token-count-2026-05-13"
"server-side-fallback-2026-06-01"
"server-side-fallback-2026-07-01"
"fallback-credit-2026-06-01"
"fallback-credit-2026-07-01"
"agent-memory-2026-07-22"
"mid-conversation-tool-changes-2026-07-01"
"compact-2026-01-12"
"computer-use-2025-11-24"
"mcp-tunnels-2026-06-22"
"structured-outputs-2025-11-13"
"task-budgets-2026-03-13"
"thinking-display-updates-2026-08-18"
"ce-user-management-2026-07-13"
"mid-conversation-output-config-2026-07-01"
"thinking-binding-controls-2026-08-01"
"mid-conversation-system-clear-at-2026-08-21"
"compact-2026-09-04"
"inline-tools-2026-09-15"
"mcp-client-2026-09-15"
"ce-plugins-2026-09-01"
"spend-limit-reads-2026-09-26"
"telemetry-destinations-2026-08-11"
##### Returns
BetaOrganizationTunnelCertificate object{ type: "tunnel_certificate", id, archived_at, 4 more }
type: "tunnel_certificate"
Object type. Always `tunnel_certificate` for Tunnel Certificates.
defaulttunnel_certificate
id: string
ID of the Tunnel Certificate.
archived_at: string or null
RFC 3339 datetime string indicating when the certificate was archived, or `null` if it is not archived.
formatdate-time
created_at: string
RFC 3339 datetime string indicating when the certificate was registered.
formatdate-time
expires_at: string or null
RFC 3339 datetime string indicating when the certificate expires, or `null` if it does not expire.
formatdate-time
fingerprint: string
The certificate's SHA-256 fingerprint, as a lowercase hex string.
tunnel_id: string
ID of the Tunnel this certificate is registered against.
Get Tunnel Certificate
cURL
```python
curl https://api.anthropic.com/v1/organizations/tunnels/$TUNNEL_ID/certificates/$CERTIFICATE_ID \
-H 'anthropic-version: 2023-06-01' \
-H 'anthropic-beta: mcp-tunnels-2026-05-19' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"id": "tcrt_01JmWq4ZxnBvR7tKpY2sLdH9",
"archived_at": "2024-11-01T23:59:27.427722Z",
"created_at": "2024-10-30T23:58:27.427722Z",
"expires_at": "2024-10-30T23:58:27.427722Z",
"fingerprint": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
"tunnel_id": "tnl_01Hx9Kp2RtQvMn3sWbYdLcF8",
"type": "tunnel_certificate"
}
```
##### Returns Examples
Response 200
```python
{
"id": "tcrt_01JmWq4ZxnBvR7tKpY2sLdH9",
"archived_at": "2024-11-01T23:59:27.427722Z",
"created_at": "2024-10-30T23:58:27.427722Z",
"expires_at": "2024-10-30T23:58:27.427722Z",
"fingerprint": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
"tunnel_id": "tnl_01Hx9Kp2RtQvMn3sWbYdLcF8",
---
## Tunnel Certificates - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/mcp_tunnels/tunnel_certificates
Path: 04-API-Reference/Admin/beta-organization-mcp-tunnels-tunnel-certificates.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fmcp_tunnels%2Ftunnel_certificates)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
List Tunnels Deprecated
Get Tunnel Deprecated
Archive Tunnel Deprecated
Reveal Tunnel Token Deprecated
Rotate Tunnel Token Deprecated
Tunnel Certificates
Create Tunnel Certificate Deprecated
List Tunnel Certificates Deprecated
Get Tunnel Certificate Deprecated
Archive Tunnel Certificate Deprecated
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [MCP Tunnels](https://platform.claude.com/docs/en/api/http/beta/organization/mcp_tunnels)
# Tunnel Certificates
Copy page
cURL
##### [Create Tunnel Certificate](https://platform.claude.com/docs/en/api/http/beta/organization/mcp_tunnels/tunnel_certificates/create)
Deprecated
POST/v1/organizations/tunnels/{tunnel_id}/certificates
**Deprecated.** This Admin API endpoint is superseded by `/v1/tunnels` on the Claude API and will be removed after a migration window. New integrations should use [`/v1/tunnels`](../Endpoints/http-beta-tunnels.md) with the `anthropic-beta: mcp-tunnels-2026-06-22` header and a WIF token carrying the `workspace:manage_tunnels` scope. Existing integrations continue to work with the `mcp-tunnels-2026-05-19` header and `org:manage_tunnels` scope during the migration window.
##### [List Tunnel Certificates](https://platform.claude.com/docs/en/api/http/beta/organization/mcp_tunnels/tunnel_certificates/list)
Deprecated
GET/v1/organizations/tunnels/{tunnel_id}/certificates
**Deprecated.** This Admin API endpoint is superseded by `/v1/tunnels` on the Claude API and will be removed after a migration window. New integrations should use [`/v1/tunnels`](../Endpoints/http-beta-tunnels.md) with the `anthropic-beta: mcp-tunnels-2026-06-22` header and a WIF token carrying the `workspace:manage_tunnels` scope. Existing integrations continue to work with the `mcp-tunnels-2026-05-19` header and `org:manage_tunnels` scope during the migration window.
##### [Get Tunnel Certificate](https://platform.claude.com/docs/en/api/http/beta/organization/mcp_tunnels/tunnel_certificates/retrieve)
Deprecated
GET/v1/organizations/tunnels/{tunnel_id}/certificates/{certificate_id}
**Deprecated.** This Admin API endpoint is superseded by `/v1/tunnels` on the Claude API and will be removed after a migration window. New integrations should use [`/v1/tunnels`](../Endpoints/http-beta-tunnels.md) with the `anthropic-beta: mcp-tunnels-2026-06-22` header and a WIF token carrying the `workspace:manage_tunnels` scope. Existing integrations continue to work with the `mcp-tunnels-2026-05-19` header and `org:manage_tunnels` scope during the migration window.
##### [Archive Tunnel Certificate](https://platform.claude.com/docs/en/api/http/beta/organization/mcp_tunnels/tunnel_certificates/archive)
Deprecated
POST/v1/organizations/tunnels/{tunnel_id}/certificates/{certificate_id}/archive
**Deprecated.** This Admin API endpoint is superseded by `/v1/tunnels` on the Claude API and will be removed after a migration window. New integrations should use [`/v1/tunnels`](../Endpoints/http-beta-tunnels.md) with the `anthropic-beta: mcp-tunnels-2026-06-22` header and a WIF token carrying the `workspace:manage_tunnels` scope. Existing integrations continue to work with the `mcp-tunnels-2026-05-19` header and `org:manage_tunnels` scope during the migration window.
##### Models
BetaOrganizationTunnelCertificate object{ type: "tunnel_certificate", id, archived_at, 4 more }
type: "tunnel_certificate"
Object type. Always `tunnel_certificate` for Tunnel Certificates.
defaulttunnel_certificate
id: string
ID of the Tunnel Certificate.
archived_at: string or null
RFC 3339 datetime string indicating when the certificate was archived, or `null` if it is not archived.
formatdate-time
created_at: string
RFC 3339 datetime string indicating when the certificate was registered.
formatdate-time
expires_at: string or null
RFC 3339 datetime string indicating when the certificate expires, or `null` if it does not expire.
formatdate-time
fingerprint: string
The certificate's SHA-256 fingerprint, as a lowercase hex string.
tunnel_id: string
ID of the Tunnel this certificate is registered against.
---
## MCP Tunnels - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/mcp_tunnels
Path: 04-API-Reference/Admin/beta-organization-mcp-tunnels.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fmcp_tunnels)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
List Tunnels Deprecated
Get Tunnel Deprecated
Archive Tunnel Deprecated
Reveal Tunnel Token Deprecated
Rotate Tunnel Token Deprecated
Tunnel Certificates
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
# MCP Tunnels
Copy page
cURL
##### [List Tunnels](https://platform.claude.com/docs/en/api/http/beta/organization/mcp_tunnels/list)
Deprecated
GET/v1/organizations/tunnels
**Deprecated.** This Admin API endpoint is superseded by `/v1/tunnels` on the Claude API and will be removed after a migration window. New integrations should use [`/v1/tunnels`](../Endpoints/http-beta-tunnels.md) with the `anthropic-beta: mcp-tunnels-2026-06-22` header and a WIF token carrying the `workspace:manage_tunnels` scope. Existing integrations continue to work with the `mcp-tunnels-2026-05-19` header and `org:manage_tunnels` scope during the migration window.
##### [Get Tunnel](https://platform.claude.com/docs/en/api/http/beta/organization/mcp_tunnels/retrieve)
Deprecated
GET/v1/organizations/tunnels/{tunnel_id}
**Deprecated.** This Admin API endpoint is superseded by `/v1/tunnels` on the Claude API and will be removed after a migration window. New integrations should use [`/v1/tunnels`](../Endpoints/http-beta-tunnels.md) with the `anthropic-beta: mcp-tunnels-2026-06-22` header and a WIF token carrying the `workspace:manage_tunnels` scope. Existing integrations continue to work with the `mcp-tunnels-2026-05-19` header and `org:manage_tunnels` scope during the migration window.
##### [Archive Tunnel](https://platform.claude.com/docs/en/api/http/beta/organization/mcp_tunnels/archive)
Deprecated
POST/v1/organizations/tunnels/{tunnel_id}/archive
**Deprecated.** This Admin API endpoint is superseded by `/v1/tunnels` on the Claude API and will be removed after a migration window. New integrations should use [`/v1/tunnels`](../Endpoints/http-beta-tunnels.md) with the `anthropic-beta: mcp-tunnels-2026-06-22` header and a WIF token carrying the `workspace:manage_tunnels` scope. Existing integrations continue to work with the `mcp-tunnels-2026-05-19` header and `org:manage_tunnels` scope during the migration window.
##### [Reveal Tunnel Token](https://platform.claude.com/docs/en/api/http/beta/organization/mcp_tunnels/reveal_token)
Deprecated
POST/v1/organizations/tunnels/{tunnel_id}/reveal_token
**Deprecated.** This Admin API endpoint is superseded by `/v1/tunnels` on the Claude API and will be removed after a migration window. New integrations should use [`/v1/tunnels`](../Endpoints/http-beta-tunnels.md) with the `anthropic-beta: mcp-tunnels-2026-06-22` header and a WIF token carrying the `workspace:manage_tunnels` scope. Existing integrations continue to work with the `mcp-tunnels-2026-05-19` header and `org:manage_tunnels` scope during the migration window.
##### [Rotate Tunnel Token](https://platform.claude.com/docs/en/api/http/beta/organization/mcp_tunnels/rotate_token)
Deprecated
POST/v1/organizations/tunnels/{tunnel_id}/rotate_token
**Deprecated.** This Admin API endpoint is superseded by `/v1/tunnels` on the Claude API and will be removed after a migration window. New integrations should use [`/v1/tunnels`](../Endpoints/http-beta-tunnels.md) with the `anthropic-beta: mcp-tunnels-2026-06-22` header and a WIF token carrying the `workspace:manage_tunnels` scope. Existing integrations continue to work with the `mcp-tunnels-2026-05-19` header and `org:manage_tunnels` scope during the migration window.
##### Models
BetaOrganizationTunnel object{ type: "tunnel", id, archived_at, 4 more }
type: "tunnel"
Object type. Always `tunnel` for Tunnels.
defaulttunnel
id: string
ID of the Tunnel.
archived_at: string or null
RFC 3339 datetime string indicating when the Tunnel was archived, or `null` if it is not archived.
formatdate-time
created_at: string
RFC 3339 datetime string indicating when the Tunnel was created.
formatdate-time
display_name: string or null
Human-readable name for the Tunnel (1–255 characters), or `null` if unset.
domain: string
Anthropic-assigned hostname for the Tunnel. MCP server URLs whose host is a subdomain of this value are routed through the Tunnel. Globally unique and never reused, even after the Tunnel is archived.
workspace_id: string or null
ID of the Workspace this Tunnel belongs to. May be `null` for a Tunnel in the default Workspace. A Tunnel never moves to another Workspace.
BetaOrganizationTunnelToken object{ type: "tunnel_token", id, tunnel_token }
type: "tunnel_token"
Object type. Always `tunnel_token` for Tunnel Tokens.
defaulttunnel_token
id: string
Stable identifier for the current token value. Changes when the token is rotated.
tunnel_token: string
The tunnel's connection token.
#### MCP Tunnels[Tunnel Certificates](https://platform.claude.com/docs/en/api/http/beta/organization/mcp_tunnels/tunnel_certificates)
##### [Create Tunnel Certificate](https://platform.claude.com/docs/en/api/http/beta/organization/mcp_tunnels/tunnel_certificates/create)
Deprecated
POST/v1/organizations/tunnels/{tunnel_id}/certificates
**Deprecated.** This Admin API endpoint is superseded by `/v1/tunnels` on the Claude API and will be removed after a migration window. New integrations should use [`/v1/tunnels`](../Endpoints/http-beta-tunnels.md) with the `anthropic-beta: mcp-tunnels-2026-06-22` header and a WIF token carrying the `workspace:manage_tunnels` scope. Existing integrations continue to work with the `mcp-tunnels-2026-05-19` header and `org:manage_tunnels` scope during the migration window.
##### [List Tunnel Certificates](https://platform.claude.com/docs/en/api/http/beta/organization/mcp_tunnels/tunnel_certificates/list)
Deprecated
GET/v1/organizations/tunnels/{tunnel_id}/certificates
**Deprecated.** This Admin API endpoint is superseded by `/v1/tunnels` on the Claude API and will be removed after a migration window. New integrations should use [`/v1/tunnels`](../Endpoints/http-beta-tunnels.md) with the `anthropic-beta: mcp-tunnels-2026-06-22` header and a WIF token carrying the `workspace:manage_tunnels` scope. Existing integrations continue to work with the `mcp-tunnels-2026-05-19` header and `org:manage_tunnels` scope during the migration window.
##### [Get Tunnel Certificate](https://platform.claude.com/docs/en/api/http/beta/organization/mcp_tunnels/tunnel_certificates/retrieve)
Deprecated
GET/v1/organizations/tunnels/{tunnel_id}/certificates/{certificate_id}
**Deprecated.** This Admin API endpoint is superseded by `/v1/tunnels` on the Claude API and will be removed after a migration window. New integrations should use [`/v1/tunnels`](../Endpoints/http-beta-tunnels.md) with the `anthropic-beta: mcp-tunnels-2026-06-22` header and a WIF token carrying the `workspace:manage_tunnels` scope. Existing integrations continue to work with the `mcp-tunnels-2026-05-19` header and `org:manage_tunnels` scope during the migration window.
##### [Archive Tunnel Certificate](https://platform.claude.com/docs/en/api/http/beta/organization/mcp_tunnels/tunnel_certificates/archive)
Deprecated
POST/v1/organizations/tunnels/{tunnel_id}/certificates/{certificate_id}/archive
**Deprecated.** This Admin API endpoint is superseded by `/v1/tunnels` on the Claude API and will be removed after a migration window. New integrations should use [`/v1/tunnels`](../Endpoints/http-beta-tunnels.md) with the `anthropic-beta: mcp-tunnels-2026-06-22` header and a WIF token carrying the `workspace:manage_tunnels` scope. Existing integrations continue to work with the `mcp-tunnels-2026-05-19` header and `org:manage_tunnels` scope during the migration window.
---
## List Plugin Marketplaces - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/plugin_marketplaces/list
Path: 04-API-Reference/Admin/beta-organization-plugin-marketplaces-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fplugin_marketplaces%2Flist)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
List Plugin Marketplaces
Get Plugin Marketplace
Update Plugin Marketplace
Validate Plugin Marketplace Repository
Validate Plugin Marketplace Archive
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Plugin Marketplaces](https://platform.claude.com/docs/en/api/http/beta/organization/plugin_marketplaces)
# List Plugin Marketplaces
Copy page
cURL
GET/v1/organizations/plugin_marketplaces
List the plugin marketplaces Plugins live in, newest first: the organization's own and its members' personal ones.
Plugin marketplaces are created, connected to a repository and deleted in claude.ai, not through this API. The organization's library marketplace, the organization-owned `manual` marketplace that uploads go to when no marketplace is named, is created the first time something is put in it and is listed from then on.
**Accepted credentials:** an Admin API key with the `read:plugins` or `read:org_audit` scope, or a Compliance Access Key with the `read:compliance_org_data` scope.
Every request must include the beta header `anthropic-beta: ce-plugins-2026-09-01`. A request without it returns `404`, exactly as if the endpoint did not exist. The Plugins API is in beta and is available to Claude Enterprise organizations only. It is not available to Claude Platform (Claude Console) organizations, or to organizations with HIPAA readiness enabled.
##### Query parameters
limit: optional number
Number of items to return per page.
Defaults to `20`. Ranges from `1` to `1000`.
default20
minimum1
maximum1000
organization_id: optional string
For a `read:org_audit` or `read:compliance_org_data` key created for all of a parent organization's linked organizations: a child organization of that parent to read instead of the organization the key was created in, given as the organization's UUID or its `org_`-prefixed ID. A value that is neither returns a 400; an organization that is not a child of the key's parent, or where the Plugins API is not available, returns a 404. Any other key may pass only its own organization's ID here; another organization returns a 404.
owner_type: optional "organization" or "user"
`organization` for the organization's plugin marketplaces, `user` for members' personal plugin marketplaces.
One of the following:
"organization"
"user"
page: optional string
Optionally set to the `next_page` token from the previous response.
maxLength2048
source: optional "directory" or "github" or "gitlab" or 2 more
Only plugin marketplaces with this `source`: `manual` for those whose Plugins are uploaded; `github`, `gitlab` or `public_git` for those synchronized from a Git repository. `directory` (Anthropic's catalog) is never listed here.
One of the following:
"directory"
"github"
"gitlab"
"manual"
"public_git"
##### Headers
"anthropic-beta": optional array of [AnthropicBeta](../Endpoints/platform-claude-com-http-beta.md#anthropic_beta)
This endpoint is in beta: requests must send `ce-plugins-2026-09-01` in this header.
One of the following:
string
"message-batches-2024-09-24"
"prompt-caching-2024-07-31"
"computer-use-2024-10-22"
"computer-use-2025-01-24"
"pdfs-2024-09-25"
"token-counting-2024-11-01"
"token-efficient-tools-2025-02-19"
"output-128k-2025-02-19"
"files-api-2025-04-14"
"mcp-client-2025-04-04"
"mcp-client-2025-11-20"
"dev-full-thinking-2025-05-14"
"interleaved-thinking-2025-05-14"
"code-execution-2025-05-22"
"extended-cache-ttl-2025-04-11"
"context-1m-2025-08-07"
"context-management-2025-06-27"
"model-context-window-exceeded-2025-08-26"
"skills-2025-10-02"
"fast-mode-2026-02-01"
"output-300k-2026-03-24"
"user-profiles-2026-03-24"
"user-profiles-2026-08-18"
"user-profiles-2026-09-04"
"advisor-tool-2026-03-01"
"managed-agents-2026-04-01"
"cache-diagnosis-2026-04-07"
"dreaming-2026-04-21"
"thinking-token-count-2026-05-13"
"server-side-fallback-2026-06-01"
"server-side-fallback-2026-07-01"
"fallback-credit-2026-06-01"
"fallback-credit-2026-07-01"
"agent-memory-2026-07-22"
"mid-conversation-tool-changes-2026-07-01"
"compact-2026-01-12"
"computer-use-2025-11-24"
"mcp-tunnels-2026-06-22"
"structured-outputs-2025-11-13"
"task-budgets-2026-03-13"
"thinking-display-updates-2026-08-18"
"ce-user-management-2026-07-13"
"mid-conversation-output-config-2026-07-01"
"thinking-binding-controls-2026-08-01"
"mid-conversation-system-clear-at-2026-08-21"
"compact-2026-09-04"
"inline-tools-2026-09-15"
"mcp-client-2026-09-15"
"ce-plugins-2026-09-01"
"spend-limit-reads-2026-09-26"
"telemetry-destinations-2026-08-11"
##### Returns
data: array of [BetaPluginMarketplace](https://platform.claude.com/docs/en/api/http/beta/organization/plugin_marketplaces#beta_plugin_marketplace) { type: "plugin_marketplace", id, created_at, 7 more }
type: "plugin_marketplace"
Always `plugin_marketplace`.
defaultplugin_marketplace
id: string
The plugin marketplace's ID, prefixed `marketplace_`.
created_at: string
RFC 3339.
formatdate-time
default_installation_preference: "auto_install" or "available" or "not_available" or "required" or null
Organization plugin marketplace: the organization-wide setting every Plugin in it with no setting of its own gets. Null for a member's personal plugin marketplace. One of `required`, `auto_install`, `available`, `not_available`; a value this API does not yet name is returned as stored.
One of the following:
"auto_install"
"available"
"not_available"
"required"
last_sync_ended_at: string or null
RFC 3339. When the most recent synchronization attempt to finish did so, whatever its outcome; for a repository plugin marketplace no synchronization has run on yet, when it was created. Null for a plugin marketplace that is not synchronized from a repository.
formatdate-time
last_sync_read_sha: string or null
The commit the last synchronization attempt that reached the repository read, whether or not its content was then accepted (see `sync_status`); an attempt that ends `failed_auth` or `failed_transient` leaves it unchanged. Null until an attempt has first read the repository, and for a plugin marketplace that is not synchronized from a repository.
name: string
Fixed for the plugin marketplace's lifetime.
owner: [BetaPluginOwnerOrganization](https://platform.claude.com/docs/en/api/http/beta/organization/plugins#beta_plugin_owner_organization) or [BetaPluginOwnerUser](https://platform.claude.com/docs/en/api/http/beta/organization/plugins#beta_plugin_owner_user)
The organization, or the member whose personal plugin marketplace it is.
One of the following:
BetaPluginOwnerOrganization object{ type: "organization" }
type: "organization"
The Plugin lives in a plugin marketplace the organization owns.
defaultorganization
BetaPluginOwnerUser object{ type: "user", user_id }
type: "user"
The Plugin lives in one member's personal plugin marketplace.
defaultuser
user_id: string
The member's User ID.
source: "directory" or "github" or "gitlab" or 2 more
Where the plugin marketplace's Plugins come from: `manual` when they are uploaded; `github`, `gitlab` or `public_git` when they are synchronized from the Git repository the owner connected, into which nothing can be uploaded; `directory` is Anthropic's own catalog, which this API does not list. A value this API does not yet name is returned as stored.
One of the following:
"directory"
"github"
"gitlab"
"manual"
"public_git"
sync_status: "failed_auth" or "failed_content" or "failed_limits" or 3 more or null
Outcome of the plugin marketplace's most recent synchronization: one of `success`, `in_progress`, `failed_content`, `failed_transient`, `failed_auth`, `failed_limits`; a value this API does not yet name is returned as stored. Null until a synchronization is first attempted — so always for a `manual` plugin marketplace.
One of the following:
"failed_auth"
"failed_content"
"failed_limits"
"failed_transient"
"in_progress"
"success"
next_page: string or null
Token to provide in as `page` in the subsequent request to retrieve the next page of data.
List Plugin Marketplaces
cURL
```python
curl https://api.anthropic.com/v1/organizations/plugin_marketplaces \
-H 'anthropic-version: 2023-06-01' \
-H 'anthropic-beta: ce-plugins-2026-09-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"data": [
{
"id": "marketplace_01HxQ3v9KpZ2mTn8RwLc4Ys7",
"created_at": "2026-03-14T09:26:53.589793Z",
"default_installation_preference": "available",
"last_sync_ended_at": "2026-03-14T09:26:53.589793Z",
"last_sync_read_sha": "9fceb02d0ae598e95dc970b74767f19372d61af8",
"name": "engineering-tools",
"owner": {
"type": "organization"
},
"source": "github",
"sync_status": "success",
"type": "plugin_marketplace"
}
],
"next_page": "page_MjAyNi0wOS0xNlQxNDowNTowOVo"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"id": "marketplace_01HxQ3v9KpZ2mTn8RwLc4Ys7",
"created_at": "2026-03-14T09:26:53.589793Z",
"default_installation_preference": "available",
"last_sync_ended_at": "2026-03-14T09:26:53.589793Z",
"last_sync_read_sha": "9fceb02d0ae598e95dc970b74767f19372d61af8",
"name": "engineering-tools",
"owner": {
"type": "organization"
},
"source": "github",
"sync_status": "success",
"type": "plugin_marketplace"
}
],
"next_page": "page_MjAyNi0wOS0xNlQxNDowNTowOVo"
---
## Get Plugin Marketplace - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/plugin_marketplaces/retrieve
Path: 04-API-Reference/Admin/beta-organization-plugin-marketplaces-retrieve.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fplugin_marketplaces%2Fretrieve)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
List Plugin Marketplaces
Get Plugin Marketplace
Update Plugin Marketplace
Validate Plugin Marketplace Repository
Validate Plugin Marketplace Archive
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Plugin Marketplaces](https://platform.claude.com/docs/en/api/http/beta/organization/plugin_marketplaces)
# Get Plugin Marketplace
Copy page
cURL
GET/v1/organizations/plugin_marketplaces/{marketplace_id}
Retrieve a plugin marketplace by ID.
**Accepted credentials:** an Admin API key with the `read:plugins` or `read:org_audit` scope, or a Compliance Access Key with the `read:compliance_org_data` scope.
Every request must include the beta header `anthropic-beta: ce-plugins-2026-09-01`. A request without it returns `404`, exactly as if the endpoint did not exist. The Plugins API is in beta and is available to Claude Enterprise organizations only. It is not available to Claude Platform (Claude Console) organizations, or to organizations with HIPAA readiness enabled.
##### Path parameters
marketplace_id: string
ID of the plugin marketplace (prefixed `marketplace_`).
##### Query parameters
organization_id: optional string
For a `read:org_audit` or `read:compliance_org_data` key created for all of a parent organization's linked organizations: a child organization of that parent to read instead of the organization the key was created in, given as the organization's UUID or its `org_`-prefixed ID. A value that is neither returns a 400; an organization that is not a child of the key's parent, or where the Plugins API is not available, returns a 404. Any other key may pass only its own organization's ID here; another organization returns a 404.
##### Headers
"anthropic-beta": optional array of [AnthropicBeta](../Endpoints/platform-claude-com-http-beta.md#anthropic_beta)
This endpoint is in beta: requests must send `ce-plugins-2026-09-01` in this header.
One of the following:
string
"message-batches-2024-09-24"
"prompt-caching-2024-07-31"
"computer-use-2024-10-22"
"computer-use-2025-01-24"
"pdfs-2024-09-25"
"token-counting-2024-11-01"
"token-efficient-tools-2025-02-19"
"output-128k-2025-02-19"
"files-api-2025-04-14"
"mcp-client-2025-04-04"
"mcp-client-2025-11-20"
"dev-full-thinking-2025-05-14"
"interleaved-thinking-2025-05-14"
"code-execution-2025-05-22"
"extended-cache-ttl-2025-04-11"
"context-1m-2025-08-07"
"context-management-2025-06-27"
"model-context-window-exceeded-2025-08-26"
"skills-2025-10-02"
"fast-mode-2026-02-01"
"output-300k-2026-03-24"
"user-profiles-2026-03-24"
"user-profiles-2026-08-18"
"user-profiles-2026-09-04"
"advisor-tool-2026-03-01"
"managed-agents-2026-04-01"
"cache-diagnosis-2026-04-07"
"dreaming-2026-04-21"
"thinking-token-count-2026-05-13"
"server-side-fallback-2026-06-01"
"server-side-fallback-2026-07-01"
"fallback-credit-2026-06-01"
"fallback-credit-2026-07-01"
"agent-memory-2026-07-22"
"mid-conversation-tool-changes-2026-07-01"
"compact-2026-01-12"
"computer-use-2025-11-24"
"mcp-tunnels-2026-06-22"
"structured-outputs-2025-11-13"
"task-budgets-2026-03-13"
"thinking-display-updates-2026-08-18"
"ce-user-management-2026-07-13"
"mid-conversation-output-config-2026-07-01"
"thinking-binding-controls-2026-08-01"
"mid-conversation-system-clear-at-2026-08-21"
"compact-2026-09-04"
"inline-tools-2026-09-15"
"mcp-client-2026-09-15"
"ce-plugins-2026-09-01"
"spend-limit-reads-2026-09-26"
"telemetry-destinations-2026-08-11"
##### Returns
BetaPluginMarketplace object{ type: "plugin_marketplace", id, created_at, 7 more }
Get Plugin Marketplace
cURL
```python
curl https://api.anthropic.com/v1/organizations/plugin_marketplaces/$MARKETPLACE_ID \
-H 'anthropic-version: 2023-06-01' \
-H 'anthropic-beta: ce-plugins-2026-09-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"id": "marketplace_01HxQ3v9KpZ2mTn8RwLc4Ys7",
"created_at": "2026-03-14T09:26:53.589793Z",
"default_installation_preference": "available",
"last_sync_ended_at": "2026-03-14T09:26:53.589793Z",
"last_sync_read_sha": "9fceb02d0ae598e95dc970b74767f19372d61af8",
"name": "engineering-tools",
"owner": {
"type": "organization"
},
"source": "github",
"sync_status": "success",
"type": "plugin_marketplace"
}
```
##### Returns Examples
Response 200
```python
{
"id": "marketplace_01HxQ3v9KpZ2mTn8RwLc4Ys7",
"created_at": "2026-03-14T09:26:53.589793Z",
"default_installation_preference": "available",
"last_sync_ended_at": "2026-03-14T09:26:53.589793Z",
"last_sync_read_sha": "9fceb02d0ae598e95dc970b74767f19372d61af8",
---
## Update Plugin Marketplace - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/plugin_marketplaces/update
Path: 04-API-Reference/Admin/beta-organization-plugin-marketplaces-update.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fplugin_marketplaces%2Fupdate)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
List Plugin Marketplaces
Get Plugin Marketplace
Update Plugin Marketplace
Validate Plugin Marketplace Repository
Validate Plugin Marketplace Archive
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Plugin Marketplaces](https://platform.claude.com/docs/en/api/http/beta/organization/plugin_marketplaces)
# Update Plugin Marketplace
Copy page
cURL
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.
Pass it as `default_installation_preference`. A member's personal marketplace cannot be updated here (403).
**Accepted credentials:** an Admin API key with the `write:plugins` scope.
Every request must include the beta header `anthropic-beta: ce-plugins-2026-09-01`. A request without it returns `404`, exactly as if the endpoint did not exist. The Plugins API is in beta and is available to Claude Enterprise organizations only. It is not available to Claude Platform (Claude Console) organizations, or to organizations with HIPAA readiness enabled.
##### Path parameters
marketplace_id: string
ID of the plugin marketplace (prefixed `marketplace_`).
##### Headers
"anthropic-beta": optional array of [AnthropicBeta](../Endpoints/platform-claude-com-http-beta.md#anthropic_beta)
This endpoint is in beta: requests must send `ce-plugins-2026-09-01` in this header.
One of the following:
string
"message-batches-2024-09-24"
"prompt-caching-2024-07-31"
"computer-use-2024-10-22"
"computer-use-2025-01-24"
"pdfs-2024-09-25"
"token-counting-2024-11-01"
"token-efficient-tools-2025-02-19"
"output-128k-2025-02-19"
"files-api-2025-04-14"
"mcp-client-2025-04-04"
"mcp-client-2025-11-20"
"dev-full-thinking-2025-05-14"
"interleaved-thinking-2025-05-14"
"code-execution-2025-05-22"
"extended-cache-ttl-2025-04-11"
"context-1m-2025-08-07"
"context-management-2025-06-27"
"model-context-window-exceeded-2025-08-26"
"skills-2025-10-02"
"fast-mode-2026-02-01"
"output-300k-2026-03-24"
"user-profiles-2026-03-24"
"user-profiles-2026-08-18"
"user-profiles-2026-09-04"
"advisor-tool-2026-03-01"
"managed-agents-2026-04-01"
"cache-diagnosis-2026-04-07"
"dreaming-2026-04-21"
"thinking-token-count-2026-05-13"
"server-side-fallback-2026-06-01"
"server-side-fallback-2026-07-01"
"fallback-credit-2026-06-01"
"fallback-credit-2026-07-01"
"agent-memory-2026-07-22"
"mid-conversation-tool-changes-2026-07-01"
"compact-2026-01-12"
"computer-use-2025-11-24"
"mcp-tunnels-2026-06-22"
"structured-outputs-2025-11-13"
"task-budgets-2026-03-13"
"thinking-display-updates-2026-08-18"
"ce-user-management-2026-07-13"
"mid-conversation-output-config-2026-07-01"
"thinking-binding-controls-2026-08-01"
"mid-conversation-system-clear-at-2026-08-21"
"compact-2026-09-04"
"inline-tools-2026-09-15"
"mcp-client-2026-09-15"
"ce-plugins-2026-09-01"
"spend-limit-reads-2026-09-26"
"telemetry-destinations-2026-08-11"
##### Body
default_installation_preference: "auto_install" or "available" or "not_available" or "required"
The organization-wide installation setting every Plugin in the marketplace without one of its own gets: one of `required`, `auto_install`, `available`, `not_available`. Once set it can be changed but not removed.
One of the following:
"auto_install"
"available"
"not_available"
"required"
##### Returns
BetaPluginMarketplace object{ type: "plugin_marketplace", id, created_at, 7 more }
Update Plugin Marketplace
cURL
```python
curl https://api.anthropic.com/v1/organizations/plugin_marketplaces/$MARKETPLACE_ID \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H 'anthropic-beta: ce-plugins-2026-09-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY" \
-d '{
"default_installation_preference": "available"
}'
```
Response 200
```python
{
"id": "marketplace_01HxQ3v9KpZ2mTn8RwLc4Ys7",
"created_at": "2026-03-14T09:26:53.589793Z",
"default_installation_preference": "available",
"last_sync_ended_at": "2026-03-14T09:26:53.589793Z",
"last_sync_read_sha": "9fceb02d0ae598e95dc970b74767f19372d61af8",
"name": "engineering-tools",
"owner": {
"type": "organization"
},
"source": "github",
"sync_status": "success",
"type": "plugin_marketplace"
}
```
##### Returns Examples
Response 200
```python
{
"id": "marketplace_01HxQ3v9KpZ2mTn8RwLc4Ys7",
"created_at": "2026-03-14T09:26:53.589793Z",
"default_installation_preference": "available",
"last_sync_ended_at": "2026-03-14T09:26:53.589793Z",
"last_sync_read_sha": "9fceb02d0ae598e95dc970b74767f19372d61af8",
---
## Validate Plugin Marketplace Archive - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/plugin_marketplaces/validate_archive
Path: 04-API-Reference/Admin/beta-organization-plugin-marketplaces-validate-archive.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fplugin_marketplaces%2Fvalidate_archive)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
List Plugin Marketplaces
Get Plugin Marketplace
Update Plugin Marketplace
Validate Plugin Marketplace Repository
Validate Plugin Marketplace Archive
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Plugin Marketplaces](https://platform.claude.com/docs/en/api/http/beta/organization/plugin_marketplaces)
# Validate Plugin Marketplace Archive
Copy page
cURL
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.
To check a public GitHub repository instead, use Validate Plugin Marketplace Repository.
The report says whether `marketplace.json` is well-formed, which plugins a synchronization would skip and why, and which plugins would synchronize only in part, with some files left out. An archive that cannot be read as a marketplace is reported, not refused: the response is a report with `valid: false`. Plugin sources outside the marketplace are fetched anonymously from GitHub, so a private one is reported as not found; a source on any other host is not fetched here, and the report notes that it will be checked when the marketplace actually synchronizes.
Nothing is recorded on the Compliance API activity feed.
For a worked example, see [Validate marketplace content](../Other/manage-claude-plugins-api.md#validate-marketplace-content) in the Plugins API guide.
**Accepted credentials:** an Admin API key with the `read:plugins` or `write:plugins` scope; `read:org_audit` and `read:compliance_org_data` do not grant it.
Every request must include the beta header `anthropic-beta: ce-plugins-2026-09-01`. A request without it returns `404`, exactly as if the endpoint did not exist. The Plugins API is in beta and is available to Claude Enterprise organizations only. It is not available to Claude Platform (Claude Console) organizations, or to organizations with HIPAA readiness enabled.
##### Headers
"anthropic-beta": optional array of [AnthropicBeta](../Endpoints/platform-claude-com-http-beta.md#anthropic_beta)
This endpoint is in beta: requests must send `ce-plugins-2026-09-01` in this header.
One of the following:
string
"message-batches-2024-09-24"
"prompt-caching-2024-07-31"
"computer-use-2024-10-22"
"computer-use-2025-01-24"
"pdfs-2024-09-25"
"token-counting-2024-11-01"
"token-efficient-tools-2025-02-19"
"output-128k-2025-02-19"
"files-api-2025-04-14"
"mcp-client-2025-04-04"
"mcp-client-2025-11-20"
"dev-full-thinking-2025-05-14"
"interleaved-thinking-2025-05-14"
"code-execution-2025-05-22"
"extended-cache-ttl-2025-04-11"
"context-1m-2025-08-07"
"context-management-2025-06-27"
"model-context-window-exceeded-2025-08-26"
"skills-2025-10-02"
"fast-mode-2026-02-01"
"output-300k-2026-03-24"
"user-profiles-2026-03-24"
"user-profiles-2026-08-18"
"user-profiles-2026-09-04"
"advisor-tool-2026-03-01"
"managed-agents-2026-04-01"
"cache-diagnosis-2026-04-07"
"dreaming-2026-04-21"
"thinking-token-count-2026-05-13"
"server-side-fallback-2026-06-01"
"server-side-fallback-2026-07-01"
"fallback-credit-2026-06-01"
"fallback-credit-2026-07-01"
"agent-memory-2026-07-22"
"mid-conversation-tool-changes-2026-07-01"
"compact-2026-01-12"
"computer-use-2025-11-24"
"mcp-tunnels-2026-06-22"
"structured-outputs-2025-11-13"
"task-budgets-2026-03-13"
"thinking-display-updates-2026-08-18"
"ce-user-management-2026-07-13"
"mid-conversation-output-config-2026-07-01"
"thinking-binding-controls-2026-08-01"
"mid-conversation-system-clear-at-2026-08-21"
"compact-2026-09-04"
"inline-tools-2026-09-15"
"mcp-client-2026-09-15"
"ce-plugins-2026-09-01"
"spend-limit-reads-2026-09-26"
"telemetry-destinations-2026-08-11"
##### Body (form-data)
archive: string
A .zip of the marketplace directory (its contents at the root, or wrapped in one folder as a Git host's download produces), sent as a file part with a filename; DEFLATE- or STORE-compressed, at most 32 MB. A part sent without a filename, a second archive part, or any other form field is a 400; a larger archive is a 413.
formatbinary
##### Returns
BetaPluginMarketplaceValidationReport object{ type: "plugin_marketplace_validation_report", commit_sha, manifest_error, 6 more }
The outcome of validating plugin marketplace content: a report, not a stored object, so nothing in it can be retrieved afterwards.
Validate Plugin Marketplace Archive
cURL
```python
curl https://api.anthropic.com/v1/organizations/plugin_marketplaces/validate_archive \
-H 'Content-Type: multipart/form-data' \
-H 'anthropic-version: 2023-06-01' \
-H 'anthropic-beta: ce-plugins-2026-09-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY" \
-F 'archive=@/path/to/archive'
```
Response 200
```python
{
"commit_sha": "9fceb02d0ae598e95dc970b74767f19372d61af8",
"manifest_error": "manifest_error",
"manifest_error_code": "marketplace_sync_manifest_not_found",
"plugin_errors": [
{
"error": "error",
"error_code": "marketplace_sync_plugin_missing_manifest",
"name": "name"
}
],
"plugin_warnings": [
{
"name": "name",
"warnings": [
{
"error_code": "marketplace_sync_zipball_symlink_dangling",
"message": "message"
}
]
}
],
"ref": "main",
"total_plugin_count": 0,
"type": "plugin_marketplace_validation_report",
"valid": false
}
```
##### Returns Examples
Response 200
```python
{
"commit_sha": "9fceb02d0ae598e95dc970b74767f19372d61af8",
"manifest_error": "manifest_error",
"manifest_error_code": "marketplace_sync_manifest_not_found",
"plugin_errors": [
{
"error": "error",
"error_code": "marketplace_sync_plugin_missing_manifest",
"name": "name"
}
],
"plugin_warnings": [
{
"name": "name",
"warnings": [
{
"error_code": "marketplace_sync_zipball_symlink_dangling",
"message": "message"
}
]
}
],
"ref": "main",
"total_plugin_count": 0,
"type": "plugin_marketplace_validation_report",
---
## Validate Plugin Marketplace Repository - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/plugin_marketplaces/validate_repository
Path: 04-API-Reference/Admin/beta-organization-plugin-marketplaces-validate-repository.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fplugin_marketplaces%2Fvalidate_repository)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
List Plugin Marketplaces
Get Plugin Marketplace
Update Plugin Marketplace
Validate Plugin Marketplace Repository
Validate Plugin Marketplace Archive
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Plugin Marketplaces](https://platform.claude.com/docs/en/api/http/beta/organization/plugin_marketplaces)
# Validate Plugin Marketplace Repository
Copy page
cURL
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.
To check a `.zip` of the marketplace directory instead, use Validate Plugin Marketplace Archive.
The report says whether `marketplace.json` is well-formed, which plugins a synchronization would skip and why, and which plugins would synchronize only in part, with some files left out. A repository that is missing, private, or has no such branch or commit is reported, not refused: the response is a report with `valid: false`. Plugin sources outside the marketplace are fetched anonymously from GitHub, so a private one is reported as not found; a source on any other host is not fetched here, and the report notes that it will be checked when the marketplace actually synchronizes.
Nothing is recorded on the Compliance API activity feed.
For a worked example, see [Validate marketplace content](../Other/manage-claude-plugins-api.md#validate-marketplace-content) in the Plugins API guide.
**Accepted credentials:** an Admin API key with the `read:plugins` or `write:plugins` scope; `read:org_audit` and `read:compliance_org_data` do not grant it.
Every request must include the beta header `anthropic-beta: ce-plugins-2026-09-01`. A request without it returns `404`, exactly as if the endpoint did not exist. The Plugins API is in beta and is available to Claude Enterprise organizations only. It is not available to Claude Platform (Claude Console) organizations, or to organizations with HIPAA readiness enabled.
##### Headers
"anthropic-beta": optional array of [AnthropicBeta](../Endpoints/platform-claude-com-http-beta.md#anthropic_beta)
This endpoint is in beta: requests must send `ce-plugins-2026-09-01` in this header.
One of the following:
string
"message-batches-2024-09-24"
"prompt-caching-2024-07-31"
"computer-use-2024-10-22"
"computer-use-2025-01-24"
"pdfs-2024-09-25"
"token-counting-2024-11-01"
"token-efficient-tools-2025-02-19"
"output-128k-2025-02-19"
"files-api-2025-04-14"
"mcp-client-2025-04-04"
"mcp-client-2025-11-20"
"dev-full-thinking-2025-05-14"
"interleaved-thinking-2025-05-14"
"code-execution-2025-05-22"
"extended-cache-ttl-2025-04-11"
"context-1m-2025-08-07"
"context-management-2025-06-27"
"model-context-window-exceeded-2025-08-26"
"skills-2025-10-02"
"fast-mode-2026-02-01"
"output-300k-2026-03-24"
"user-profiles-2026-03-24"
"user-profiles-2026-08-18"
"user-profiles-2026-09-04"
"advisor-tool-2026-03-01"
"managed-agents-2026-04-01"
"cache-diagnosis-2026-04-07"
"dreaming-2026-04-21"
"thinking-token-count-2026-05-13"
"server-side-fallback-2026-06-01"
"server-side-fallback-2026-07-01"
"fallback-credit-2026-06-01"
"fallback-credit-2026-07-01"
"agent-memory-2026-07-22"
"mid-conversation-tool-changes-2026-07-01"
"compact-2026-01-12"
"computer-use-2025-11-24"
"mcp-tunnels-2026-06-22"
"structured-outputs-2025-11-13"
"task-budgets-2026-03-13"
"thinking-display-updates-2026-08-18"
"ce-user-management-2026-07-13"
"mid-conversation-output-config-2026-07-01"
"thinking-binding-controls-2026-08-01"
"mid-conversation-system-clear-at-2026-08-21"
"compact-2026-09-04"
"inline-tools-2026-09-15"
"mcp-client-2026-09-15"
"ce-plugins-2026-09-01"
"spend-limit-reads-2026-09-26"
"telemetry-destinations-2026-08-11"
##### Body
repository_url: string
The `https://` URL of a public repository on github.com that holds the marketplace. Any other host, a URL with credentials in it, or one that does not name a repository is a 400.
minLength1
ref: optional string or null
The branch to validate the tip of, or the full 40-character SHA of the commit to validate. When omitted, the branch a synchronization would read (usually the repository's default branch); if that is not the default branch, the report's `ref` says which branch was read. An empty string, or a value that is neither a branch name nor a 40-character SHA, is a 400.
minLength1
##### Returns
BetaPluginMarketplaceValidationReport object{ type: "plugin_marketplace_validation_report", commit_sha, manifest_error, 6 more }
The outcome of validating plugin marketplace content: a report, not a stored object, so nothing in it can be retrieved afterwards.
Validate Plugin Marketplace Repository
cURL
```python
curl https://api.anthropic.com/v1/organizations/plugin_marketplaces/validate_repository \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H 'anthropic-beta: ce-plugins-2026-09-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY" \
-d '{
"repository_url": "https://github.com/example-org/example-marketplace",
"ref": "main"
}'
```
Response 200
```python
{
"commit_sha": "9fceb02d0ae598e95dc970b74767f19372d61af8",
"manifest_error": "manifest_error",
"manifest_error_code": "marketplace_sync_manifest_not_found",
"plugin_errors": [
{
"error": "error",
"error_code": "marketplace_sync_plugin_missing_manifest",
"name": "name"
}
],
"plugin_warnings": [
{
"name": "name",
"warnings": [
{
"error_code": "marketplace_sync_zipball_symlink_dangling",
"message": "message"
}
]
}
],
"ref": "main",
"total_plugin_count": 0,
"type": "plugin_marketplace_validation_report",
"valid": false
}
```
##### Returns Examples
Response 200
```python
{
"commit_sha": "9fceb02d0ae598e95dc970b74767f19372d61af8",
"manifest_error": "manifest_error",
"manifest_error_code": "marketplace_sync_manifest_not_found",
"plugin_errors": [
{
"error": "error",
"error_code": "marketplace_sync_plugin_missing_manifest",
"name": "name"
}
],
"plugin_warnings": [
{
"name": "name",
"warnings": [
{
"error_code": "marketplace_sync_zipball_symlink_dangling",
"message": "message"
}
]
}
],
"ref": "main",
"total_plugin_count": 0,
"type": "plugin_marketplace_validation_report",
---
## Plugin Marketplaces - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/plugin_marketplaces
Path: 04-API-Reference/Admin/beta-organization-plugin-marketplaces.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fplugin_marketplaces)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
List Plugin Marketplaces
Get Plugin Marketplace
Update Plugin Marketplace
Validate Plugin Marketplace Repository
Validate Plugin Marketplace Archive
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
# Plugin Marketplaces
Copy page
cURL
##### [List Plugin Marketplaces](https://platform.claude.com/docs/en/api/http/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](https://platform.claude.com/docs/en/api/http/beta/organization/plugin_marketplaces/retrieve)
GET/v1/organizations/plugin_marketplaces/{marketplace_id}
Retrieve a plugin marketplace by ID.
##### [Update Plugin Marketplace](https://platform.claude.com/docs/en/api/http/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](https://platform.claude.com/docs/en/api/http/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](https://platform.claude.com/docs/en/api/http/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.
##### Models
BetaPluginMarketplace object{ type: "plugin_marketplace", id, created_at, 7 more }
BetaPluginMarketplaceValidationPluginError object{ error, error_code, name }
error: string
Why the plugin would be skipped by a synchronization.
error_code: string
A stable identifier for the reason — the value to branch on.
name: string
The plugin's name, as its entry in marketplace.json declares it.
BetaPluginMarketplaceValidationPluginWarning object{ error_code, message }
error_code: string
A stable identifier for the kind of warning.
message: string
What would be left out, and why.
BetaPluginMarketplaceValidationPluginWarnings object{ name, warnings }
name: string
The plugin's name, as its entry in marketplace.json declares it.
warnings: array of [BetaPluginMarketplaceValidationPluginWarning](https://platform.claude.com/docs/en/api/http/beta/organization/plugin_marketplaces#beta_plugin_marketplace_validation_plugin_warning) { error_code, message }
The parts of the plugin a synchronization would leave out.
error_code: string
A stable identifier for the kind of warning.
message: string
What would be left out, and why.
BetaPluginMarketplaceValidationReport object{ type: "plugin_marketplace_validation_report", commit_sha, manifest_error, 6 more }
The outcome of validating plugin marketplace content: a report, not a stored object, so nothing in it can be retrieved afterwards.
---
## Create Plugin - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/plugins/create
Path: 04-API-Reference/Admin/beta-organization-plugins-create.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fplugins%2Fcreate)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Create Plugin
Get Plugin
Update Plugin
List Plugins
Delete Plugin
Versions
Installation Settings
Shares
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Plugins](https://platform.claude.com/docs/en/api/http/beta/organization/plugins)
# Create Plugin
Copy page
cURL
POST/v1/organizations/plugins
Create an organization-owned Plugin and its first version by uploading the version's files.
The upload is `multipart/form-data`: the version's files (`files`, each part sent as `files[]`), with an optional `marketplace_id` and `release_notes`. The manifest's `name` becomes the Plugin's `name`, and `display_name`, `description` and `manifest_version` come from the manifest too.
`name` may contain lowercase letters (from any alphabet), digits, and hyphens, up to 64 characters. Uppercase letters, spaces, underscores, and other punctuation are rejected.
The `name` must be unique within the marketplace: a name already taken returns a 409 with `error_code` `plugin_name_taken` and, when a Plugin holds it, that Plugin's ID in `details.plugin_id`. A Plugin going into the organization's library marketplace is also refused with a 409 when one of its skills has the name of an organization skill (a skill an administrator uploaded for the whole organization in claude.ai): `error_code` `skill_name_taken`, with that name in `details.skill_name`; rename the skill, or remove the organization skill in claude.ai. A 503 with `error_code` `registration_pending` means the Plugin and its version were stored (their IDs are in `details`) but are not yet usable in claude.ai: do not retry the create (the retry would return `plugin_name_taken`); create a version on the stored Plugin instead, which completes it.
For a worked example, see [Create a plugin](../Other/manage-claude-plugins-api.md#create-a-plugin) in the Plugins API guide.
**Accepted credentials:** an Admin API key with the `write:plugins` scope.
Every request must include the beta header `anthropic-beta: ce-plugins-2026-09-01`. A request without it returns `404`, exactly as if the endpoint did not exist. The Plugins API is in beta and is available to Claude Enterprise organizations only. It is not available to Claude Platform (Claude Console) organizations, or to organizations with HIPAA readiness enabled.
##### Headers
"anthropic-beta": optional array of [AnthropicBeta](../Endpoints/platform-claude-com-http-beta.md#anthropic_beta)
This endpoint is in beta: requests must send `ce-plugins-2026-09-01` in this header.
One of the following:
string
"message-batches-2024-09-24"
"prompt-caching-2024-07-31"
"computer-use-2024-10-22"
"computer-use-2025-01-24"
"pdfs-2024-09-25"
"token-counting-2024-11-01"
"token-efficient-tools-2025-02-19"
"output-128k-2025-02-19"
"files-api-2025-04-14"
"mcp-client-2025-04-04"
"mcp-client-2025-11-20"
"dev-full-thinking-2025-05-14"
"interleaved-thinking-2025-05-14"
"code-execution-2025-05-22"
"extended-cache-ttl-2025-04-11"
"context-1m-2025-08-07"
"context-management-2025-06-27"
"model-context-window-exceeded-2025-08-26"
"skills-2025-10-02"
"fast-mode-2026-02-01"
"output-300k-2026-03-24"
"user-profiles-2026-03-24"
"user-profiles-2026-08-18"
"user-profiles-2026-09-04"
"advisor-tool-2026-03-01"
"managed-agents-2026-04-01"
"cache-diagnosis-2026-04-07"
"dreaming-2026-04-21"
"thinking-token-count-2026-05-13"
"server-side-fallback-2026-06-01"
"server-side-fallback-2026-07-01"
"fallback-credit-2026-06-01"
"fallback-credit-2026-07-01"
"agent-memory-2026-07-22"
"mid-conversation-tool-changes-2026-07-01"
"compact-2026-01-12"
"computer-use-2025-11-24"
"mcp-tunnels-2026-06-22"
"structured-outputs-2025-11-13"
"task-budgets-2026-03-13"
"thinking-display-updates-2026-08-18"
"ce-user-management-2026-07-13"
"mid-conversation-output-config-2026-07-01"
"thinking-binding-controls-2026-08-01"
"mid-conversation-system-clear-at-2026-08-21"
"compact-2026-09-04"
"inline-tools-2026-09-15"
"mcp-client-2026-09-15"
"ce-plugins-2026-09-01"
"spend-limit-reads-2026-09-26"
"telemetry-destinations-2026-08-11"
##### Body (form-data)
files: array of string
The version's files: one part per file, the part's filename being the file's path within the Plugin (for example `skills/review-pr/SKILL.md`), or a single `.zip` or `.plugin` archive holding them all. On the wire each part is named `files[]`, and a part named plain `files` is not read; with cURL, `-F 'files[]=@SKILL.md;filename=skills/review-pr/SKILL.md'`. The files must include the manifest, `.claude-plugin/plugin.json`.
marketplace_id: optional string
ID of the organization-owned plugin marketplace to create the Plugin in (prefixed `marketplace_`). It must be a `manual` marketplace, one whose Plugins are uploaded rather than synchronized from a repository. When omitted, the Plugin is created in the organization's library marketplace, an organization-owned `manual` marketplace created on first use.
release_notes: optional string
Release notes stored with the version and shown in its version history in claude.ai; up to 5,000 characters.
maxLength5000
##### Returns
BetaPlugin object{ type: "plugin", id, components, 16 more }
Create Plugin
cURL
```python
curl https://api.anthropic.com/v1/organizations/plugins \
-H 'Content-Type: multipart/form-data' \
-H 'anthropic-version: 2023-06-01' \
-H 'anthropic-beta: ce-plugins-2026-09-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY" \
-F 'files[]=@/path/to/file'
```
Response 200
```python
{
"id": "plugin_01JyHfbRkZvD1gW7oTqXc3Ne",
"components": [
{
"description": "description",
"name": "review-pr",
"type": "skill"
}
],
"content_scan": {
"assessment": "warn",
"reason": "credential-exposure",
"status": "completed"
},
"created_at": "2026-03-14T09:26:53.589793Z",
"created_by": {
"email_address": "user@example.com",
"type": "user_actor",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"description": "Reviews pull requests against your team's conventions.",
"display_name": "Code Review Helper",
"latest_version_id": "pluginver_01KaZmQpRsTuVwXyZ2b4c6d8",
"manifest_version": "1.2.0",
"marketplace_id": "marketplace_01HxQ3v9KpZ2mTn8RwLc4Ys7",
"name": "code-review-helper",
"organization_installation_preference": "available",
"organization_installation_preference_inherited": true,
"owner": {
"type": "organization"
},
"reach": "contained",
"served_version_id": "pluginver_01K9wPcHd4Rm2Tx8Vq6Ln3Sb",
"served_version_pinned": true,
"type": "plugin",
"updated_at": "2026-03-14T09:26:53.589793Z"
}
```
##### Returns Examples
Response 200
```python
{
"id": "plugin_01JyHfbRkZvD1gW7oTqXc3Ne",
"components": [
{
"description": "description",
"name": "review-pr",
"type": "skill"
}
],
"content_scan": {
"assessment": "warn",
"reason": "credential-exposure",
"status": "completed"
},
"created_at": "2026-03-14T09:26:53.589793Z",
"created_by": {
"email_address": "user@example.com",
"type": "user_actor",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"description": "Reviews pull requests against your team's conventions.",
"display_name": "Code Review Helper",
"latest_version_id": "pluginver_01KaZmQpRsTuVwXyZ2b4c6d8",
"manifest_version": "1.2.0",
"marketplace_id": "marketplace_01HxQ3v9KpZ2mTn8RwLc4Ys7",
"name": "code-review-helper",
"organization_installation_preference": "available",
"organization_installation_preference_inherited": true,
"owner": {
"type": "organization"
},
"reach": "contained",
"served_version_id": "pluginver_01K9wPcHd4Rm2Tx8Vq6Ln3Sb",
"served_version_pinned": true,
"type": "plugin",
"updated_at": "2026-03-14T09:26:53.589793Z"
---
## Delete Plugin - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/plugins/delete
Path: 04-API-Reference/Admin/beta-organization-plugins-delete.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fplugins%2Fdelete)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Create Plugin
Get Plugin
Update Plugin
List Plugins
Delete Plugin
Versions
Installation Settings
Shares
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Plugins](https://platform.claude.com/docs/en/api/http/beta/organization/plugins)
# Delete Plugin
Copy page
cURL
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.
An organization-owned Plugin's installation settings go with it; a member-owned Plugin's shares are withdrawn and its owner no longer has it.
To take an organization-owned Plugin out of use reversibly, set its organization-wide installation setting to `not_available` instead (and remove or change any group settings, which override it for their members). Only a Plugin in a `manual` marketplace can be deleted here; one synchronized from a repository is removed by removing it from the repository (400).
**Accepted credentials:** an Admin API key with the `write:plugins` scope.
Every request must include the beta header `anthropic-beta: ce-plugins-2026-09-01`. A request without it returns `404`, exactly as if the endpoint did not exist. The Plugins API is in beta and is available to Claude Enterprise organizations only. It is not available to Claude Platform (Claude Console) organizations, or to organizations with HIPAA readiness enabled.
##### Path parameters
plugin_id: string
ID of the Plugin (prefixed `plugin_`).
##### Headers
"anthropic-beta": optional array of [AnthropicBeta](../Endpoints/platform-claude-com-http-beta.md#anthropic_beta)
This endpoint is in beta: requests must send `ce-plugins-2026-09-01` in this header.
One of the following:
string
"message-batches-2024-09-24"
"prompt-caching-2024-07-31"
"computer-use-2024-10-22"
"computer-use-2025-01-24"
"pdfs-2024-09-25"
"token-counting-2024-11-01"
"token-efficient-tools-2025-02-19"
"output-128k-2025-02-19"
"files-api-2025-04-14"
"mcp-client-2025-04-04"
"mcp-client-2025-11-20"
"dev-full-thinking-2025-05-14"
"interleaved-thinking-2025-05-14"
"code-execution-2025-05-22"
"extended-cache-ttl-2025-04-11"
"context-1m-2025-08-07"
"context-management-2025-06-27"
"model-context-window-exceeded-2025-08-26"
"skills-2025-10-02"
"fast-mode-2026-02-01"
"output-300k-2026-03-24"
"user-profiles-2026-03-24"
"user-profiles-2026-08-18"
"user-profiles-2026-09-04"
"advisor-tool-2026-03-01"
"managed-agents-2026-04-01"
"cache-diagnosis-2026-04-07"
"dreaming-2026-04-21"
"thinking-token-count-2026-05-13"
"server-side-fallback-2026-06-01"
"server-side-fallback-2026-07-01"
"fallback-credit-2026-06-01"
"fallback-credit-2026-07-01"
"agent-memory-2026-07-22"
"mid-conversation-tool-changes-2026-07-01"
"compact-2026-01-12"
"computer-use-2025-11-24"
"mcp-tunnels-2026-06-22"
"structured-outputs-2025-11-13"
"task-budgets-2026-03-13"
"thinking-display-updates-2026-08-18"
"ce-user-management-2026-07-13"
"mid-conversation-output-config-2026-07-01"
"thinking-binding-controls-2026-08-01"
"mid-conversation-system-clear-at-2026-08-21"
"compact-2026-09-04"
"inline-tools-2026-09-15"
"mcp-client-2026-09-15"
"ce-plugins-2026-09-01"
"spend-limit-reads-2026-09-26"
"telemetry-destinations-2026-08-11"
##### Returns
BetaDeletedPlugin object{ type: "plugin_deleted", id }
type: "plugin_deleted"
Always `plugin_deleted`.
defaultplugin_deleted
id: string
The deleted Plugin's ID.
Delete Plugin
cURL
```python
curl https://api.anthropic.com/v1/organizations/plugins/$PLUGIN_ID \
-X DELETE \
-H 'anthropic-version: 2023-06-01' \
-H 'anthropic-beta: ce-plugins-2026-09-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"id": "plugin_01JyHfbRkZvD1gW7oTqXc3Ne",
"type": "plugin_deleted"
}
```
##### Returns Examples
Response 200
```python
{
"id": "plugin_01JyHfbRkZvD1gW7oTqXc3Ne",
---
## List Plugin Installation Settings - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/plugins/installation_settings/list
Path: 04-API-Reference/Admin/beta-organization-plugins-installation-settings-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fplugins%2Finstallation_settings%2Flist)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Create Plugin
Get Plugin
Update Plugin
List Plugins
Delete Plugin
Versions
Installation Settings
List Plugin Installation Settings
Set Plugin Installation Setting
Remove Plugin Installation Setting
Shares
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Plugins](https://platform.claude.com/docs/en/api/http/beta/organization/plugins)
5. [Installation Settings](https://platform.claude.com/docs/en/api/http/beta/organization/plugins/installation_settings)
# List Plugin Installation Settings
Copy page
cURL
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.
The list holds the Plugin's own organization-wide setting (absent while the Plugin inherits its marketplace's default) and each RBAC Group's own setting. A member-owned Plugin has shares instead, so this path returns 404 for one.
**Accepted credentials:** an Admin API key with the `read:plugins` or `read:org_audit` scope, or a Compliance Access Key with the `read:compliance_org_data` scope.
Every request must include the beta header `anthropic-beta: ce-plugins-2026-09-01`. A request without it returns `404`, exactly as if the endpoint did not exist. The Plugins API is in beta and is available to Claude Enterprise organizations only. It is not available to Claude Platform (Claude Console) organizations, or to organizations with HIPAA readiness enabled.
##### Path parameters
plugin_id: string
ID of the Plugin (prefixed `plugin_`).
##### Query parameters
limit: optional number
Number of items to return per page.
Defaults to `20`. Ranges from `1` to `100`.
default20
minimum1
maximum100
organization_id: optional string
For a `read:org_audit` or `read:compliance_org_data` key created for all of a parent organization's linked organizations: a child organization of that parent to read instead of the organization the key was created in, given as the organization's UUID or its `org_`-prefixed ID. A value that is neither returns a 400; an organization that is not a child of the key's parent, or where the Plugins API is not available, returns a 404. Any other key may pass only its own organization's ID here; another organization returns a 404.
page: optional string
Optionally set to the `next_page` token from the previous response.
maxLength2048
target_type: optional "organization" or "rbac_group"
Only settings for this kind of target: `organization` (the organization-wide setting) or `rbac_group` (an RBAC Group's).
One of the following:
"organization"
"rbac_group"
##### Headers
"anthropic-beta": optional array of [AnthropicBeta](../Endpoints/platform-claude-com-http-beta.md#anthropic_beta)
This endpoint is in beta: requests must send `ce-plugins-2026-09-01` in this header.
One of the following:
string
"message-batches-2024-09-24"
"prompt-caching-2024-07-31"
"computer-use-2024-10-22"
"computer-use-2025-01-24"
"pdfs-2024-09-25"
"token-counting-2024-11-01"
"token-efficient-tools-2025-02-19"
"output-128k-2025-02-19"
"files-api-2025-04-14"
"mcp-client-2025-04-04"
"mcp-client-2025-11-20"
"dev-full-thinking-2025-05-14"
"interleaved-thinking-2025-05-14"
"code-execution-2025-05-22"
"extended-cache-ttl-2025-04-11"
"context-1m-2025-08-07"
"context-management-2025-06-27"
"model-context-window-exceeded-2025-08-26"
"skills-2025-10-02"
"fast-mode-2026-02-01"
"output-300k-2026-03-24"
"user-profiles-2026-03-24"
"user-profiles-2026-08-18"
"user-profiles-2026-09-04"
"advisor-tool-2026-03-01"
"managed-agents-2026-04-01"
"cache-diagnosis-2026-04-07"
"dreaming-2026-04-21"
"thinking-token-count-2026-05-13"
"server-side-fallback-2026-06-01"
"server-side-fallback-2026-07-01"
"fallback-credit-2026-06-01"
"fallback-credit-2026-07-01"
"agent-memory-2026-07-22"
"mid-conversation-tool-changes-2026-07-01"
"compact-2026-01-12"
"computer-use-2025-11-24"
"mcp-tunnels-2026-06-22"
"structured-outputs-2025-11-13"
"task-budgets-2026-03-13"
"thinking-display-updates-2026-08-18"
"ce-user-management-2026-07-13"
"mid-conversation-output-config-2026-07-01"
"thinking-binding-controls-2026-08-01"
"mid-conversation-system-clear-at-2026-08-21"
"compact-2026-09-04"
"inline-tools-2026-09-15"
"mcp-client-2026-09-15"
"ce-plugins-2026-09-01"
"spend-limit-reads-2026-09-26"
"telemetry-destinations-2026-08-11"
##### Returns
data: array of [BetaPluginInstallationSetting](https://platform.claude.com/docs/en/api/http/beta/organization/plugins/installation_settings#beta_plugin_installation_setting) { type: "plugin_installation_setting", created_at, installation_preference, 3 more }
type: "plugin_installation_setting"
Always `plugin_installation_setting`.
defaultplugin_installation_setting
created_at: string
When the target was first given a setting for this Plugin.
formatdate-time
installation_preference: "auto_install" or "available" or "not_available" or "required"
The setting the target holds for this Plugin. One of `required`, `auto_install`, `available`, `not_available`; a value this API does not yet name is returned as stored.
One of the following:
"auto_install"
"available"
"not_available"
"required"
plugin_id: string
The Plugin's ID.
target: [BetaPluginTargetOrganization](https://platform.claude.com/docs/en/api/http/beta/organization/plugins#beta_plugin_target_organization) or [BetaPluginTargetRBACGroup](https://platform.claude.com/docs/en/api/http/beta/organization/plugins#beta_plugin_target_rbac_group) or [BetaPluginTargetOrganizationMember](https://platform.claude.com/docs/en/api/http/beta/organization/plugins#beta_plugin_target_organization_member)
Whose setting this is: `organization` (the Plugin's own organization-wide setting) or `rbac_group` (one RBAC Group's own setting); `organization_member` does not occur here.
One of the following:
BetaPluginTargetOrganization object{ type: "organization" }
type: "organization"
Every member of the organization.
defaultorganization
BetaPluginTargetRBACGroup object{ type: "rbac_group", rbac_group_id }
type: "rbac_group"
An RBAC Group.
defaultrbac_group
rbac_group_id: string
The RBAC Group's ID.
BetaPluginTargetOrganizationMember object{ type: "organization_member", user_id }
type: "organization_member"
One member of the organization.
defaultorganization_member
user_id: string
The member's User ID.
updated_at: string
When its setting last changed.
formatdate-time
next_page: string or null
Token to provide in as `page` in the subsequent request to retrieve the next page of data.
List Plugin Installation Settings
cURL
```python
curl https://api.anthropic.com/v1/organizations/plugins/$PLUGIN_ID/installation_settings \
-H 'anthropic-version: 2023-06-01' \
-H 'anthropic-beta: ce-plugins-2026-09-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"data": [
{
"created_at": "2026-03-14T09:26:53.589793Z",
"installation_preference": "required",
"plugin_id": "plugin_01JyHfbRkZvD1gW7oTqXc3Ne",
"target": {
"type": "organization"
},
"type": "plugin_installation_setting",
"updated_at": "2026-03-14T09:26:53.589793Z"
}
],
"next_page": "page_MjAyNi0wOS0xNlQxNDowNTowOVo"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"created_at": "2026-03-14T09:26:53.589793Z",
"installation_preference": "required",
"plugin_id": "plugin_01JyHfbRkZvD1gW7oTqXc3Ne",
"target": {
"type": "organization"
},
"type": "plugin_installation_setting",
"updated_at": "2026-03-14T09:26:53.589793Z"
}
],
"next_page": "page_MjAyNi0wOS0xNlQxNDowNTowOVo"
---
## Remove Plugin Installation Setting - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/plugins/installation_settings/remove
Path: 04-API-Reference/Admin/beta-organization-plugins-installation-settings-remove.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fplugins%2Finstallation_settings%2Fremove)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Create Plugin
Get Plugin
Update Plugin
List Plugins
Delete Plugin
Versions
Installation Settings
List Plugin Installation Settings
Set Plugin Installation Setting
Remove Plugin Installation Setting
Shares
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Plugins](https://platform.claude.com/docs/en/api/http/beta/organization/plugins)
5. [Installation Settings](https://platform.claude.com/docs/en/api/http/beta/organization/plugins/installation_settings)
# Remove Plugin Installation Setting
Copy page
cURL
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.
Removing the `organization` target returns the Plugin to its marketplace's default installation setting and leaves the groups' settings in place. Removing a group's setting makes the group's members fall back to the Plugin's organization-wide setting or to the settings of their other groups.
A target that holds no setting of its own returns 404 (a Plugin that already inherits its marketplace's default holds no `organization` setting), and so does a member-owned Plugin.
A removal counts as one of the Plugin's installation-setting writes: send all of those writes one at a time. If several arrive for the same Plugin at the same time, the server handles them one after another and can answer some of them with `503` and `x-should-retry: true` instead of applying them; wait a second or two and send the removal again. A `404` on the repeat means the setting is already gone.
**Accepted credentials:** an Admin API key with the `write:plugins` scope.
Every request must include the beta header `anthropic-beta: ce-plugins-2026-09-01`. A request without it returns `404`, exactly as if the endpoint did not exist. The Plugins API is in beta and is available to Claude Enterprise organizations only. It is not available to Claude Platform (Claude Console) organizations, or to organizations with HIPAA readiness enabled.
##### Path parameters
plugin_id: string
ID of the Plugin (prefixed `plugin_`).
target: string
The target whose own setting is removed: the literal `organization` for the Plugin's organization-wide setting, or an RBAC Group's ID (prefixed `rbac_group_`) for that group's own setting. Removing the `organization` setting returns the Plugin to its marketplace's default.
##### Headers
"anthropic-beta": optional array of [AnthropicBeta](../Endpoints/platform-claude-com-http-beta.md#anthropic_beta)
This endpoint is in beta: requests must send `ce-plugins-2026-09-01` in this header.
One of the following:
string
"message-batches-2024-09-24"
"prompt-caching-2024-07-31"
"computer-use-2024-10-22"
"computer-use-2025-01-24"
"pdfs-2024-09-25"
"token-counting-2024-11-01"
"token-efficient-tools-2025-02-19"
"output-128k-2025-02-19"
"files-api-2025-04-14"
"mcp-client-2025-04-04"
"mcp-client-2025-11-20"
"dev-full-thinking-2025-05-14"
"interleaved-thinking-2025-05-14"
"code-execution-2025-05-22"
"extended-cache-ttl-2025-04-11"
"context-1m-2025-08-07"
"context-management-2025-06-27"
"model-context-window-exceeded-2025-08-26"
"skills-2025-10-02"
"fast-mode-2026-02-01"
"output-300k-2026-03-24"
"user-profiles-2026-03-24"
"user-profiles-2026-08-18"
"user-profiles-2026-09-04"
"advisor-tool-2026-03-01"
"managed-agents-2026-04-01"
"cache-diagnosis-2026-04-07"
"dreaming-2026-04-21"
"thinking-token-count-2026-05-13"
"server-side-fallback-2026-06-01"
"server-side-fallback-2026-07-01"
"fallback-credit-2026-06-01"
"fallback-credit-2026-07-01"
"agent-memory-2026-07-22"
"mid-conversation-tool-changes-2026-07-01"
"compact-2026-01-12"
"computer-use-2025-11-24"
"mcp-tunnels-2026-06-22"
"structured-outputs-2025-11-13"
"task-budgets-2026-03-13"
"thinking-display-updates-2026-08-18"
"ce-user-management-2026-07-13"
"mid-conversation-output-config-2026-07-01"
"thinking-binding-controls-2026-08-01"
"mid-conversation-system-clear-at-2026-08-21"
"compact-2026-09-04"
"inline-tools-2026-09-15"
"mcp-client-2026-09-15"
"ce-plugins-2026-09-01"
"spend-limit-reads-2026-09-26"
"telemetry-destinations-2026-08-11"
##### Returns
BetaDeletedPluginInstallationSetting object{ type: "plugin_installation_setting_deleted", plugin_id, target }
Confirmation that one target's installation setting was removed, naming the Plugin and the target in place of an ID.
Remove Plugin Installation Setting
cURL
```python
curl https://api.anthropic.com/v1/organizations/plugins/$PLUGIN_ID/installation_settings/$TARGET \
-X DELETE \
-H 'anthropic-version: 2023-06-01' \
-H 'anthropic-beta: ce-plugins-2026-09-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"plugin_id": "plugin_01JyHfbRkZvD1gW7oTqXc3Ne",
"target": {
"rbac_group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"type": "rbac_group"
},
"type": "plugin_installation_setting_deleted"
}
```
##### Returns Examples
Response 200
```python
{
"plugin_id": "plugin_01JyHfbRkZvD1gW7oTqXc3Ne",
"target": {
"rbac_group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"type": "rbac_group"
},
"type": "plugin_installation_setting_deleted"
---
## Set Plugin Installation Setting - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/plugins/installation_settings/set
Path: 04-API-Reference/Admin/beta-organization-plugins-installation-settings-set.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fplugins%2Finstallation_settings%2Fset)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Create Plugin
Get Plugin
Update Plugin
List Plugins
Delete Plugin
Versions
Installation Settings
List Plugin Installation Settings
Set Plugin Installation Setting
Remove Plugin Installation Setting
Shares
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Plugins](https://platform.claude.com/docs/en/api/http/beta/organization/plugins)
5. [Installation Settings](https://platform.claude.com/docs/en/api/http/beta/organization/plugins/installation_settings)
# Set Plugin Installation Setting
Copy page
cURL
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.
Writing the value a target already holds of its own changes nothing.
A member-owned Plugin has shares instead of installation settings, so this path returns 404 for one.
Send a Plugin's installation-setting writes one at a time. If several writes for the same Plugin arrive at the same time, the server handles them one after another and can answer some of them with `503` instead of applying them. That `503` carries `x-should-retry: true`, and the write is safe to repeat: wait a second or two, then send it again.
**Accepted credentials:** an Admin API key with the `write:plugins` scope.
Every request must include the beta header `anthropic-beta: ce-plugins-2026-09-01`. A request without it returns `404`, exactly as if the endpoint did not exist. The Plugins API is in beta and is available to Claude Enterprise organizations only. It is not available to Claude Platform (Claude Console) organizations, or to organizations with HIPAA readiness enabled.
##### Path parameters
plugin_id: string
ID of the Plugin (prefixed `plugin_`).
target: string
The target whose setting is written: the literal `organization` for the Plugin's organization-wide setting, or an RBAC Group's ID (prefixed `rbac_group_`) for that group's own setting. Writing the `organization` target stops the Plugin from inheriting its marketplace's default, even when the value written equals that default.
##### Headers
"anthropic-beta": optional array of [AnthropicBeta](../Endpoints/platform-claude-com-http-beta.md#anthropic_beta)
This endpoint is in beta: requests must send `ce-plugins-2026-09-01` in this header.
One of the following:
string
"message-batches-2024-09-24"
"prompt-caching-2024-07-31"
"computer-use-2024-10-22"
"computer-use-2025-01-24"
"pdfs-2024-09-25"
"token-counting-2024-11-01"
"token-efficient-tools-2025-02-19"
"output-128k-2025-02-19"
"files-api-2025-04-14"
"mcp-client-2025-04-04"
"mcp-client-2025-11-20"
"dev-full-thinking-2025-05-14"
"interleaved-thinking-2025-05-14"
"code-execution-2025-05-22"
"extended-cache-ttl-2025-04-11"
"context-1m-2025-08-07"
"context-management-2025-06-27"
"model-context-window-exceeded-2025-08-26"
"skills-2025-10-02"
"fast-mode-2026-02-01"
"output-300k-2026-03-24"
"user-profiles-2026-03-24"
"user-profiles-2026-08-18"
"user-profiles-2026-09-04"
"advisor-tool-2026-03-01"
"managed-agents-2026-04-01"
"cache-diagnosis-2026-04-07"
"dreaming-2026-04-21"
"thinking-token-count-2026-05-13"
"server-side-fallback-2026-06-01"
"server-side-fallback-2026-07-01"
"fallback-credit-2026-06-01"
"fallback-credit-2026-07-01"
"agent-memory-2026-07-22"
"mid-conversation-tool-changes-2026-07-01"
"compact-2026-01-12"
"computer-use-2025-11-24"
"mcp-tunnels-2026-06-22"
"structured-outputs-2025-11-13"
"task-budgets-2026-03-13"
"thinking-display-updates-2026-08-18"
"ce-user-management-2026-07-13"
"mid-conversation-output-config-2026-07-01"
"thinking-binding-controls-2026-08-01"
"mid-conversation-system-clear-at-2026-08-21"
"compact-2026-09-04"
"inline-tools-2026-09-15"
"mcp-client-2026-09-15"
"ce-plugins-2026-09-01"
"spend-limit-reads-2026-09-26"
"telemetry-destinations-2026-08-11"
##### Body
installation_preference: "auto_install" or "available" or "not_available" or "required"
The installation setting the target is to hold for this Plugin: one of `required`, `auto_install`, `available`, `not_available`.
One of the following:
"auto_install"
"available"
"not_available"
"required"
##### Returns
BetaPluginInstallationSetting object{ type: "plugin_installation_setting", created_at, installation_preference, 3 more }
The installation setting an organization-owned Plugin holds for one target. It has no ID of its own: it is addressed by the Plugin's ID and the target.
Set Plugin Installation Setting
cURL
```python
curl https://api.anthropic.com/v1/organizations/plugins/$PLUGIN_ID/installation_settings/$TARGET \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H 'anthropic-beta: ce-plugins-2026-09-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY" \
-d '{
"installation_preference": "required"
}'
```
Response 200
```python
{
"created_at": "2026-03-14T09:26:53.589793Z",
"installation_preference": "required",
"plugin_id": "plugin_01JyHfbRkZvD1gW7oTqXc3Ne",
"target": {
"type": "organization"
},
"type": "plugin_installation_setting",
"updated_at": "2026-03-14T09:26:53.589793Z"
}
```
##### Returns Examples
Response 200
```python
{
"created_at": "2026-03-14T09:26:53.589793Z",
"installation_preference": "required",
"plugin_id": "plugin_01JyHfbRkZvD1gW7oTqXc3Ne",
"target": {
"type": "organization"
},
"type": "plugin_installation_setting",
"updated_at": "2026-03-14T09:26:53.589793Z"
---
## Installation Settings - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/plugins/installation_settings
Path: 04-API-Reference/Admin/beta-organization-plugins-installation-settings.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fplugins%2Finstallation_settings)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Create Plugin
Get Plugin
Update Plugin
List Plugins
Delete Plugin
Versions
Installation Settings
List Plugin Installation Settings
Set Plugin Installation Setting
Remove Plugin Installation Setting
Shares
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Plugins](https://platform.claude.com/docs/en/api/http/beta/organization/plugins)
# Installation Settings
Copy page
cURL
##### [List Plugin Installation Settings](https://platform.claude.com/docs/en/api/http/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](https://platform.claude.com/docs/en/api/http/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](https://platform.claude.com/docs/en/api/http/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.
##### Models
BetaDeletedPluginInstallationSetting object{ type: "plugin_installation_setting_deleted", plugin_id, target }
Confirmation that one target's installation setting was removed, naming the Plugin and the target in place of an ID.
BetaPluginInstallationSetting object{ type: "plugin_installation_setting", created_at, installation_preference, 3 more }
The installation setting an organization-owned Plugin holds for one target. It has no ID of its own: it is addressed by the Plugin's ID and the target.
---
## List Plugins - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/plugins/list
Path: 04-API-Reference/Admin/beta-organization-plugins-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fplugins%2Flist)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Create Plugin
Get Plugin
Update Plugin
List Plugins
Delete Plugin
Versions
Installation Settings
Shares
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Plugins](https://platform.claude.com/docs/en/api/http/beta/organization/plugins)
# List Plugins
Copy page
cURL
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.
Plugins in members' personal marketplaces are listed with the same detail as the organization's own, and their files can be downloaded through the version archive endpoint, which records each such download on the Compliance API activity feed.
**Accepted credentials:** an Admin API key with the `read:plugins` or `read:org_audit` scope, or a Compliance Access Key with the `read:compliance_org_data` scope.
Every request must include the beta header `anthropic-beta: ce-plugins-2026-09-01`. A request without it returns `404`, exactly as if the endpoint did not exist. The Plugins API is in beta and is available to Claude Enterprise organizations only. It is not available to Claude Platform (Claude Console) organizations, or to organizations with HIPAA readiness enabled.
##### Query parameters
"created_at\[gt\]": optional string
RFC 3339 timestamp bound; combine \[gte\], \[gt\], \[lte\], \[lt\].
formatdate-time
"created_at\[gte\]": optional string
RFC 3339 timestamp bound; combine \[gte\], \[gt\], \[lte\], \[lt\].
formatdate-time
"created_at\[lt\]": optional string
RFC 3339 timestamp bound; combine \[gte\], \[gt\], \[lte\], \[lt\].
formatdate-time
"created_at\[lte\]": optional string
RFC 3339 timestamp bound; combine \[gte\], \[gt\], \[lte\], \[lt\].
formatdate-time
limit: optional number
Number of items to return per page.
Defaults to `20`. Ranges from `1` to `100`.
default20
minimum1
maximum100
marketplace_id: optional string
Only Plugins in this plugin marketplace (prefixed `marketplace_`).
organization_id: optional string
For a `read:org_audit` or `read:compliance_org_data` key created for all of a parent organization's linked organizations: a child organization of that parent to read instead of the organization the key was created in, given as the organization's UUID or its `org_`-prefixed ID. A value that is neither returns a 400; an organization that is not a child of the key's parent, or where the Plugins API is not available, returns a 404. Any other key may pass only its own organization's ID here; another organization returns a 404.
owner_type: optional "organization" or "user"
`organization` for Plugins in the organization's plugin marketplaces, `user` for Plugins in members' personal plugin marketplaces.
One of the following:
"organization"
"user"
owner_user_id: optional string
Only Plugins in this member's personal plugin marketplaces (prefixed `user_`); a removed member's ID is accepted.
page: optional string
Optionally set to the `next_page` token from the previous response.
maxLength2048
##### Headers
"anthropic-beta": optional array of [AnthropicBeta](../Endpoints/platform-claude-com-http-beta.md#anthropic_beta)
This endpoint is in beta: requests must send `ce-plugins-2026-09-01` in this header.
One of the following:
string
"message-batches-2024-09-24"
"prompt-caching-2024-07-31"
"computer-use-2024-10-22"
"computer-use-2025-01-24"
"pdfs-2024-09-25"
"token-counting-2024-11-01"
"token-efficient-tools-2025-02-19"
"output-128k-2025-02-19"
"files-api-2025-04-14"
"mcp-client-2025-04-04"
"mcp-client-2025-11-20"
"dev-full-thinking-2025-05-14"
"interleaved-thinking-2025-05-14"
"code-execution-2025-05-22"
"extended-cache-ttl-2025-04-11"
"context-1m-2025-08-07"
"context-management-2025-06-27"
"model-context-window-exceeded-2025-08-26"
"skills-2025-10-02"
"fast-mode-2026-02-01"
"output-300k-2026-03-24"
"user-profiles-2026-03-24"
"user-profiles-2026-08-18"
"user-profiles-2026-09-04"
"advisor-tool-2026-03-01"
"managed-agents-2026-04-01"
"cache-diagnosis-2026-04-07"
"dreaming-2026-04-21"
"thinking-token-count-2026-05-13"
"server-side-fallback-2026-06-01"
"server-side-fallback-2026-07-01"
"fallback-credit-2026-06-01"
"fallback-credit-2026-07-01"
"agent-memory-2026-07-22"
"mid-conversation-tool-changes-2026-07-01"
"compact-2026-01-12"
"computer-use-2025-11-24"
"mcp-tunnels-2026-06-22"
"structured-outputs-2025-11-13"
"task-budgets-2026-03-13"
"thinking-display-updates-2026-08-18"
"ce-user-management-2026-07-13"
"mid-conversation-output-config-2026-07-01"
"thinking-binding-controls-2026-08-01"
"mid-conversation-system-clear-at-2026-08-21"
"compact-2026-09-04"
"inline-tools-2026-09-15"
"mcp-client-2026-09-15"
"ce-plugins-2026-09-01"
"spend-limit-reads-2026-09-26"
"telemetry-destinations-2026-08-11"
##### Returns
data: array of [BetaPlugin](https://platform.claude.com/docs/en/api/http/beta/organization/plugins#beta_plugin) { type: "plugin", id, components, 16 more }
type: "plugin"
Always `plugin`.
defaultplugin
id: string
The Plugin's ID.
components: array of [BetaPluginComponent](https://platform.claude.com/docs/en/api/http/beta/organization/plugins#beta_plugin_component) { type, description, name } or null
What the served version contains; null when not enumerated.
type: "agent" or "cli" or "command" or 3 more
The kind of component.
One of the following:
"agent"
"cli"
"command"
"hook"
"mcp_server"
"skill"
description: string or null
What the component declares about itself; always null for MCP servers, hooks, and CLIs.
name: string
The component's name: a skill's, command's or agent's name, an MCP server's key in the manifest, the event a hook runs on, or a CLI's executable.
content_scan: [BetaPluginContentScan](https://platform.claude.com/docs/en/api/http/beta/organization/plugins#beta_plugin_content_scan) { assessment, reason, status } or null
The served version's content scan; null when it has not been scanned.
assessment: "fail" or "pass" or "unknown" or "warn" or null
The scan's verdict; set only when `status` is `completed`.
One of the following:
"fail"
"pass"
"unknown"
"warn"
reason: string or null
The primary mechanism behind a `warn` or `fail`, such as `credential-exposure` or `guardrail-tampering`; a mechanism this API does not yet name reads as `other`. Null on a `pass`, whenever `assessment` is null, and when no mechanism is reported for the verdict.
status: "completed" or "errored" or "processing"
`processing` while a scan runs, `completed` when it ran to completion, `errored` when it could not run or its outcome cannot be read.
One of the following:
"completed"
"errored"
"processing"
created_at: string
RFC 3339.
formatdate-time
created_by: [BetaPluginUserActor](https://platform.claude.com/docs/en/api/http/beta/organization/plugins#beta_plugin_user_actor) or [BetaPluginAPIActor](https://platform.claude.com/docs/en/api/http/beta/organization/plugins#beta_plugin_api_actor) or null
Who created the Plugin; null when no creator is recorded.
One of the following:
BetaPluginUserActor object{ type: "user_actor", email_address, user_id }
type: "user_actor"
A member of the organization.
defaultuser_actor
email_address: string or null
The member's email address; may be null, for example when they are no longer a member of the organization.
user_id: string
The member's User ID.
BetaPluginAPIActor object{ type: "api_actor", api_key_id }
type: "api_actor"
An Admin API key, in the same form the Compliance API activity feed uses for it.
defaultapi_actor
api_key_id: string
The key's ID.
description: string or null
The served version's description.
display_name: string or null
The served version's display name.
latest_version_id: string
The newest version.
manifest_version: string or null
The version string the served version's manifest declares.
marketplace_id: string
The ID of the plugin marketplace the Plugin lives in.
name: string
Lowercase identifier, unique within its plugin marketplace. Fixed for an organization-owned Plugin's lifetime; a member-owned Plugin's changes when its owner renames it in claude.ai, while its `id` stays the same.
organization_installation_preference: "auto_install" or "available" or "not_available" or "required" or null
Organization-owned Plugin: the organization-wide installation setting every member gets unless an RBAC Group they belong to holds its own — the Plugin's own setting, or its plugin marketplace's default. Null for a member-owned Plugin, which has shares instead. One of `required`, `auto_install`, `available`, `not_available`; a value this API does not yet name is returned as stored.
One of the following:
"auto_install"
"available"
"not_available"
"required"
organization_installation_preference_inherited: boolean or null
Organization-owned Plugin: true while it has no organization-wide setting of its own and `organization_installation_preference` is its plugin marketplace's default. Null for a member-owned Plugin.
owner: [BetaPluginOwnerOrganization](https://platform.claude.com/docs/en/api/http/beta/organization/plugins#beta_plugin_owner_organization) or [BetaPluginOwnerUser](https://platform.claude.com/docs/en/api/http/beta/organization/plugins#beta_plugin_owner_user)
Who owns the Plugin: the organization, or the member whose personal plugin marketplace it lives in.
One of the following:
BetaPluginOwnerOrganization object{ type: "organization" }
type: "organization"
The Plugin lives in a plugin marketplace the organization owns.
defaultorganization
BetaPluginOwnerUser object{ type: "user", user_id }
type: "user"
The Plugin lives in one member's personal plugin marketplace.
defaultuser
user_id: string
The member's User ID.
reach: "contained" or "privileged" or "remote" or null
How far the served version reaches: `remote` when it declares an MCP server or a CLI, `privileged` when it declares a hook, monitor, language server or settings but nothing remote, `contained` otherwise; null when not classifiable.
One of the following:
"contained"
"privileged"
"remote"
served_version_id: string
The version claude.ai serves to members.
served_version_pinned: boolean
False while the served version follows each new version; true once it has been pinned to one.
updated_at: string
RFC 3339. Moves on a new version and on a served-version change; a change to the Plugin's installation settings or shares does not move it.
formatdate-time
next_page: string or null
Token to provide in as `page` in the subsequent request to retrieve the next page of data. A page may hold fewer than `limit` Plugins, even none, while this is set; keep following it until it is null.
List Plugins
cURL
```python
curl https://api.anthropic.com/v1/organizations/plugins \
-H 'anthropic-version: 2023-06-01' \
-H 'anthropic-beta: ce-plugins-2026-09-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"data": [
{
"id": "plugin_01JyHfbRkZvD1gW7oTqXc3Ne",
"components": [
{
"description": "description",
"name": "review-pr",
"type": "skill"
}
],
"content_scan": {
"assessment": "warn",
"reason": "credential-exposure",
"status": "completed"
},
"created_at": "2026-03-14T09:26:53.589793Z",
"created_by": {
"email_address": "user@example.com",
"type": "user_actor",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"description": "Reviews pull requests against your team's conventions.",
"display_name": "Code Review Helper",
"latest_version_id": "pluginver_01KaZmQpRsTuVwXyZ2b4c6d8",
"manifest_version": "1.2.0",
"marketplace_id": "marketplace_01HxQ3v9KpZ2mTn8RwLc4Ys7",
"name": "code-review-helper",
"organization_installation_preference": "available",
"organization_installation_preference_inherited": true,
"owner": {
"type": "organization"
},
"reach": "contained",
"served_version_id": "pluginver_01K9wPcHd4Rm2Tx8Vq6Ln3Sb",
"served_version_pinned": true,
"type": "plugin",
"updated_at": "2026-03-14T09:26:53.589793Z"
}
],
"next_page": "page_MjAyNi0wOS0xNlQxNDowNTowOVo"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"id": "plugin_01JyHfbRkZvD1gW7oTqXc3Ne",
"components": [
{
"description": "description",
"name": "review-pr",
"type": "skill"
}
],
"content_scan": {
"assessment": "warn",
"reason": "credential-exposure",
"status": "completed"
},
"created_at": "2026-03-14T09:26:53.589793Z",
"created_by": {
"email_address": "user@example.com",
"type": "user_actor",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"description": "Reviews pull requests against your team's conventions.",
"display_name": "Code Review Helper",
"latest_version_id": "pluginver_01KaZmQpRsTuVwXyZ2b4c6d8",
"manifest_version": "1.2.0",
"marketplace_id": "marketplace_01HxQ3v9KpZ2mTn8RwLc4Ys7",
"name": "code-review-helper",
"organization_installation_preference": "available",
"organization_installation_preference_inherited": true,
"owner": {
"type": "organization"
},
"reach": "contained",
"served_version_id": "pluginver_01K9wPcHd4Rm2Tx8Vq6Ln3Sb",
"served_version_pinned": true,
"type": "plugin",
"updated_at": "2026-03-14T09:26:53.589793Z"
}
],
"next_page": "page_MjAyNi0wOS0xNlQxNDowNTowOVo"
---
## Get Plugin - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/plugins/retrieve
Path: 04-API-Reference/Admin/beta-organization-plugins-retrieve.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fplugins%2Fretrieve)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Create Plugin
Get Plugin
Update Plugin
List Plugins
Delete Plugin
Versions
Installation Settings
Shares
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Plugins](https://platform.claude.com/docs/en/api/http/beta/organization/plugins)
# Get Plugin
Copy page
cURL
GET/v1/organizations/plugins/{plugin_id}
Retrieve a Plugin by ID.
**Accepted credentials:** an Admin API key with the `read:plugins` or `read:org_audit` scope, or a Compliance Access Key with the `read:compliance_org_data` scope.
Every request must include the beta header `anthropic-beta: ce-plugins-2026-09-01`. A request without it returns `404`, exactly as if the endpoint did not exist. The Plugins API is in beta and is available to Claude Enterprise organizations only. It is not available to Claude Platform (Claude Console) organizations, or to organizations with HIPAA readiness enabled.
##### Path parameters
plugin_id: string
ID of the Plugin (prefixed `plugin_`).
##### Query parameters
organization_id: optional string
For a `read:org_audit` or `read:compliance_org_data` key created for all of a parent organization's linked organizations: a child organization of that parent to read instead of the organization the key was created in, given as the organization's UUID or its `org_`-prefixed ID. A value that is neither returns a 400; an organization that is not a child of the key's parent, or where the Plugins API is not available, returns a 404. Any other key may pass only its own organization's ID here; another organization returns a 404.
##### Headers
"anthropic-beta": optional array of [AnthropicBeta](../Endpoints/platform-claude-com-http-beta.md#anthropic_beta)
This endpoint is in beta: requests must send `ce-plugins-2026-09-01` in this header.
One of the following:
string
"message-batches-2024-09-24"
"prompt-caching-2024-07-31"
"computer-use-2024-10-22"
"computer-use-2025-01-24"
"pdfs-2024-09-25"
"token-counting-2024-11-01"
"token-efficient-tools-2025-02-19"
"output-128k-2025-02-19"
"files-api-2025-04-14"
"mcp-client-2025-04-04"
"mcp-client-2025-11-20"
"dev-full-thinking-2025-05-14"
"interleaved-thinking-2025-05-14"
"code-execution-2025-05-22"
"extended-cache-ttl-2025-04-11"
"context-1m-2025-08-07"
"context-management-2025-06-27"
"model-context-window-exceeded-2025-08-26"
"skills-2025-10-02"
"fast-mode-2026-02-01"
"output-300k-2026-03-24"
"user-profiles-2026-03-24"
"user-profiles-2026-08-18"
"user-profiles-2026-09-04"
"advisor-tool-2026-03-01"
"managed-agents-2026-04-01"
"cache-diagnosis-2026-04-07"
"dreaming-2026-04-21"
"thinking-token-count-2026-05-13"
"server-side-fallback-2026-06-01"
"server-side-fallback-2026-07-01"
"fallback-credit-2026-06-01"
"fallback-credit-2026-07-01"
"agent-memory-2026-07-22"
"mid-conversation-tool-changes-2026-07-01"
"compact-2026-01-12"
"computer-use-2025-11-24"
"mcp-tunnels-2026-06-22"
"structured-outputs-2025-11-13"
"task-budgets-2026-03-13"
"thinking-display-updates-2026-08-18"
"ce-user-management-2026-07-13"
"mid-conversation-output-config-2026-07-01"
"thinking-binding-controls-2026-08-01"
"mid-conversation-system-clear-at-2026-08-21"
"compact-2026-09-04"
"inline-tools-2026-09-15"
"mcp-client-2026-09-15"
"ce-plugins-2026-09-01"
"spend-limit-reads-2026-09-26"
"telemetry-destinations-2026-08-11"
##### Returns
BetaPlugin object{ type: "plugin", id, components, 16 more }
Get Plugin
cURL
```python
curl https://api.anthropic.com/v1/organizations/plugins/$PLUGIN_ID \
-H 'anthropic-version: 2023-06-01' \
-H 'anthropic-beta: ce-plugins-2026-09-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"id": "plugin_01JyHfbRkZvD1gW7oTqXc3Ne",
"components": [
{
"description": "description",
"name": "review-pr",
"type": "skill"
}
],
"content_scan": {
"assessment": "warn",
"reason": "credential-exposure",
"status": "completed"
},
"created_at": "2026-03-14T09:26:53.589793Z",
"created_by": {
"email_address": "user@example.com",
"type": "user_actor",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"description": "Reviews pull requests against your team's conventions.",
"display_name": "Code Review Helper",
"latest_version_id": "pluginver_01KaZmQpRsTuVwXyZ2b4c6d8",
"manifest_version": "1.2.0",
"marketplace_id": "marketplace_01HxQ3v9KpZ2mTn8RwLc4Ys7",
"name": "code-review-helper",
"organization_installation_preference": "available",
"organization_installation_preference_inherited": true,
"owner": {
"type": "organization"
},
"reach": "contained",
"served_version_id": "pluginver_01K9wPcHd4Rm2Tx8Vq6Ln3Sb",
"served_version_pinned": true,
"type": "plugin",
"updated_at": "2026-03-14T09:26:53.589793Z"
}
```
##### Returns Examples
Response 200
```python
{
"id": "plugin_01JyHfbRkZvD1gW7oTqXc3Ne",
"components": [
{
"description": "description",
"name": "review-pr",
"type": "skill"
}
],
"content_scan": {
"assessment": "warn",
"reason": "credential-exposure",
"status": "completed"
},
"created_at": "2026-03-14T09:26:53.589793Z",
"created_by": {
"email_address": "user@example.com",
"type": "user_actor",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"description": "Reviews pull requests against your team's conventions.",
"display_name": "Code Review Helper",
"latest_version_id": "pluginver_01KaZmQpRsTuVwXyZ2b4c6d8",
"manifest_version": "1.2.0",
"marketplace_id": "marketplace_01HxQ3v9KpZ2mTn8RwLc4Ys7",
"name": "code-review-helper",
"organization_installation_preference": "available",
"organization_installation_preference_inherited": true,
"owner": {
"type": "organization"
},
"reach": "contained",
"served_version_id": "pluginver_01K9wPcHd4Rm2Tx8Vq6Ln3Sb",
"served_version_pinned": true,
"type": "plugin",
"updated_at": "2026-03-14T09:26:53.589793Z"
---
## List Plugin Shares - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/plugins/shares/list
Path: 04-API-Reference/Admin/beta-organization-plugins-shares-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fplugins%2Fshares%2Flist)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Create Plugin
Get Plugin
Update Plugin
List Plugins
Delete Plugin
Versions
Installation Settings
Shares
List Plugin Shares
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Plugins](https://platform.claude.com/docs/en/api/http/beta/organization/plugins)
5. [Shares](https://platform.claude.com/docs/en/api/http/beta/organization/plugins/shares)
# List Plugin Shares
Copy page
cURL
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.
Shares are read-only in this API: members give and withdraw them in claude.ai, and who gave a share is recorded on the Compliance API activity feed rather than on the share. An organization-owned Plugin has installation settings instead, so this path returns 404 for one.
**Accepted credentials:** an Admin API key with the `read:plugins` or `read:org_audit` scope, or a Compliance Access Key with the `read:compliance_org_data` scope.
Every request must include the beta header `anthropic-beta: ce-plugins-2026-09-01`. A request without it returns `404`, exactly as if the endpoint did not exist. The Plugins API is in beta and is available to Claude Enterprise organizations only. It is not available to Claude Platform (Claude Console) organizations, or to organizations with HIPAA readiness enabled.
##### Path parameters
plugin_id: string
ID of the Plugin (prefixed `plugin_`).
##### Query parameters
limit: optional number
Number of items to return per page.
Defaults to `20`. Ranges from `1` to `100`.
default20
minimum1
maximum100
organization_id: optional string
For a `read:org_audit` or `read:compliance_org_data` key created for all of a parent organization's linked organizations: a child organization of that parent to read instead of the organization the key was created in, given as the organization's UUID or its `org_`-prefixed ID. A value that is neither returns a 400; an organization that is not a child of the key's parent, or where the Plugins API is not available, returns a 404. Any other key may pass only its own organization's ID here; another organization returns a 404.
page: optional string
Optionally set to the `next_page` token from the previous response.
maxLength2048
target_type: optional "organization" or "organization_member" or "rbac_group"
Only shares with this kind of target: `organization` (every member), `rbac_group` (one RBAC Group), or `organization_member` (one member).
One of the following:
"organization"
"organization_member"
"rbac_group"
##### Headers
"anthropic-beta": optional array of [AnthropicBeta](../Endpoints/platform-claude-com-http-beta.md#anthropic_beta)
This endpoint is in beta: requests must send `ce-plugins-2026-09-01` in this header.
One of the following:
string
"message-batches-2024-09-24"
"prompt-caching-2024-07-31"
"computer-use-2024-10-22"
"computer-use-2025-01-24"
"pdfs-2024-09-25"
"token-counting-2024-11-01"
"token-efficient-tools-2025-02-19"
"output-128k-2025-02-19"
"files-api-2025-04-14"
"mcp-client-2025-04-04"
"mcp-client-2025-11-20"
"dev-full-thinking-2025-05-14"
"interleaved-thinking-2025-05-14"
"code-execution-2025-05-22"
"extended-cache-ttl-2025-04-11"
"context-1m-2025-08-07"
"context-management-2025-06-27"
"model-context-window-exceeded-2025-08-26"
"skills-2025-10-02"
"fast-mode-2026-02-01"
"output-300k-2026-03-24"
"user-profiles-2026-03-24"
"user-profiles-2026-08-18"
"user-profiles-2026-09-04"
"advisor-tool-2026-03-01"
"managed-agents-2026-04-01"
"cache-diagnosis-2026-04-07"
"dreaming-2026-04-21"
"thinking-token-count-2026-05-13"
"server-side-fallback-2026-06-01"
"server-side-fallback-2026-07-01"
"fallback-credit-2026-06-01"
"fallback-credit-2026-07-01"
"agent-memory-2026-07-22"
"mid-conversation-tool-changes-2026-07-01"
"compact-2026-01-12"
"computer-use-2025-11-24"
"mcp-tunnels-2026-06-22"
"structured-outputs-2025-11-13"
"task-budgets-2026-03-13"
"thinking-display-updates-2026-08-18"
"ce-user-management-2026-07-13"
"mid-conversation-output-config-2026-07-01"
"thinking-binding-controls-2026-08-01"
"mid-conversation-system-clear-at-2026-08-21"
"compact-2026-09-04"
"inline-tools-2026-09-15"
"mcp-client-2026-09-15"
"ce-plugins-2026-09-01"
"spend-limit-reads-2026-09-26"
"telemetry-destinations-2026-08-11"
##### Returns
data: array of [BetaPluginShare](https://platform.claude.com/docs/en/api/http/beta/organization/plugins/shares#beta_plugin_share) { type: "plugin_share", granted_at, plugin_id, target }
type: "plugin_share"
Always `plugin_share`.
defaultplugin_share
granted_at: string
When the share was given; a share whose role is later changed in claude.ai is re-granted and carries the time of that change.
formatdate-time
plugin_id: string
The Plugin's ID.
target: [BetaPluginTargetOrganization](https://platform.claude.com/docs/en/api/http/beta/organization/plugins#beta_plugin_target_organization) or [BetaPluginTargetRBACGroup](https://platform.claude.com/docs/en/api/http/beta/organization/plugins#beta_plugin_target_rbac_group) or [BetaPluginTargetOrganizationMember](https://platform.claude.com/docs/en/api/http/beta/organization/plugins#beta_plugin_target_organization_member)
Who the Plugin is shared with: `organization` (every member), `rbac_group` (one RBAC Group), or `organization_member` (one member).
One of the following:
BetaPluginTargetOrganization object{ type: "organization" }
type: "organization"
Every member of the organization.
defaultorganization
BetaPluginTargetRBACGroup object{ type: "rbac_group", rbac_group_id }
type: "rbac_group"
An RBAC Group.
defaultrbac_group
rbac_group_id: string
The RBAC Group's ID.
BetaPluginTargetOrganizationMember object{ type: "organization_member", user_id }
type: "organization_member"
One member of the organization.
defaultorganization_member
user_id: string
The member's User ID.
next_page: string or null
Token to provide in as `page` in the subsequent request to retrieve the next page of data.
List Plugin Shares
cURL
```python
curl https://api.anthropic.com/v1/organizations/plugins/$PLUGIN_ID/shares \
-H 'anthropic-version: 2023-06-01' \
-H 'anthropic-beta: ce-plugins-2026-09-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"data": [
{
"granted_at": "2026-03-14T09:26:53.589793Z",
"plugin_id": "plugin_01JyHfbRkZvD1gW7oTqXc3Ne",
"target": {
"type": "organization"
},
"type": "plugin_share"
}
],
"next_page": "page_MjAyNi0wOS0xNlQxNDowNTowOVo"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"granted_at": "2026-03-14T09:26:53.589793Z",
"plugin_id": "plugin_01JyHfbRkZvD1gW7oTqXc3Ne",
"target": {
"type": "organization"
},
"type": "plugin_share"
}
],
"next_page": "page_MjAyNi0wOS0xNlQxNDowNTowOVo"
---
## Shares - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/plugins/shares
Path: 04-API-Reference/Admin/beta-organization-plugins-shares.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fplugins%2Fshares)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Create Plugin
Get Plugin
Update Plugin
List Plugins
Delete Plugin
Versions
Installation Settings
Shares
List Plugin Shares
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Plugins](https://platform.claude.com/docs/en/api/http/beta/organization/plugins)
# Shares
Copy page
cURL
##### [List Plugin Shares](https://platform.claude.com/docs/en/api/http/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.
##### Models
BetaPluginShare object{ type: "plugin_share", granted_at, plugin_id, target }
One share the owner of a member-owned Plugin has given. Shares are read-only in this API and have no ID of their own; who gave a share is recorded on the Compliance API activity feed, not here.
---
## Update Plugin - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/plugins/update
Path: 04-API-Reference/Admin/beta-organization-plugins-update.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fplugins%2Fupdate)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Create Plugin
Get Plugin
Update Plugin
List Plugins
Delete Plugin
Versions
Installation Settings
Shares
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Plugins](https://platform.claude.com/docs/en/api/http/beta/organization/plugins)
# Update Plugin
Copy page
cURL
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.
Pass the version as `served_version_id`: an earlier one to roll back, a later one to start serving a version that was stored without being served, or the one already served to pin it without changing what is served. No new version is created.
When the organization has content scanning enabled, a version whose scan is still running is refused with a 409 (`error_code` `scan_pending`; retry once the scan finishes) and one whose scan failed, errored or reached no verdict with a 400 (`scan_failed`; a `warn` is accepted). When the Plugin is in the organization's library marketplace, a version other than the one served is also refused with a 409 when one of its skills has a name that an organization skill (one an administrator uploaded for the whole organization in claude.ai) has since taken: `error_code` `skill_name_taken`, with that name in `details.skill_name`. A member-owned Plugin cannot be updated here (403).
This endpoint does not write installation settings; they are written at `/v1/organizations/plugins/{plugin_id}/installation_settings/{target}`.
**Accepted credentials:** an Admin API key with the `write:plugins` scope.
Every request must include the beta header `anthropic-beta: ce-plugins-2026-09-01`. A request without it returns `404`, exactly as if the endpoint did not exist. The Plugins API is in beta and is available to Claude Enterprise organizations only. It is not available to Claude Platform (Claude Console) organizations, or to organizations with HIPAA readiness enabled.
##### Path parameters
plugin_id: string
ID of the Plugin (prefixed `plugin_`).
##### Headers
"anthropic-beta": optional array of [AnthropicBeta](../Endpoints/platform-claude-com-http-beta.md#anthropic_beta)
This endpoint is in beta: requests must send `ce-plugins-2026-09-01` in this header.
One of the following:
string
"message-batches-2024-09-24"
"prompt-caching-2024-07-31"
"computer-use-2024-10-22"
"computer-use-2025-01-24"
"pdfs-2024-09-25"
"token-counting-2024-11-01"
"token-efficient-tools-2025-02-19"
"output-128k-2025-02-19"
"files-api-2025-04-14"
"mcp-client-2025-04-04"
"mcp-client-2025-11-20"
"dev-full-thinking-2025-05-14"
"interleaved-thinking-2025-05-14"
"code-execution-2025-05-22"
"extended-cache-ttl-2025-04-11"
"context-1m-2025-08-07"
"context-management-2025-06-27"
"model-context-window-exceeded-2025-08-26"
"skills-2025-10-02"
"fast-mode-2026-02-01"
"output-300k-2026-03-24"
"user-profiles-2026-03-24"
"user-profiles-2026-08-18"
"user-profiles-2026-09-04"
"advisor-tool-2026-03-01"
"managed-agents-2026-04-01"
"cache-diagnosis-2026-04-07"
"dreaming-2026-04-21"
"thinking-token-count-2026-05-13"
"server-side-fallback-2026-06-01"
"server-side-fallback-2026-07-01"
"fallback-credit-2026-06-01"
"fallback-credit-2026-07-01"
"agent-memory-2026-07-22"
"mid-conversation-tool-changes-2026-07-01"
"compact-2026-01-12"
"computer-use-2025-11-24"
"mcp-tunnels-2026-06-22"
"structured-outputs-2025-11-13"
"task-budgets-2026-03-13"
"thinking-display-updates-2026-08-18"
"ce-user-management-2026-07-13"
"mid-conversation-output-config-2026-07-01"
"thinking-binding-controls-2026-08-01"
"mid-conversation-system-clear-at-2026-08-21"
"compact-2026-09-04"
"inline-tools-2026-09-15"
"mcp-client-2026-09-15"
"ce-plugins-2026-09-01"
"spend-limit-reads-2026-09-26"
"telemetry-destinations-2026-08-11"
##### Body
served_version_id: string
Serve this version of the Plugin (prefixed `pluginver_`) and pin the served version to it; `latest` is not accepted.
##### Returns
BetaPlugin object{ type: "plugin", id, components, 16 more }
Update Plugin
cURL
```python
curl https://api.anthropic.com/v1/organizations/plugins/$PLUGIN_ID \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H 'anthropic-beta: ce-plugins-2026-09-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY" \
-d '{
"served_version_id": "pluginver_01KaZmQpRsTuVwXyZ2b4c6d8"
}'
```
Response 200
```python
{
"id": "plugin_01JyHfbRkZvD1gW7oTqXc3Ne",
"components": [
{
"description": "description",
"name": "review-pr",
"type": "skill"
}
],
"content_scan": {
"assessment": "warn",
"reason": "credential-exposure",
"status": "completed"
},
"created_at": "2026-03-14T09:26:53.589793Z",
"created_by": {
"email_address": "user@example.com",
"type": "user_actor",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"description": "Reviews pull requests against your team's conventions.",
"display_name": "Code Review Helper",
"latest_version_id": "pluginver_01KaZmQpRsTuVwXyZ2b4c6d8",
"manifest_version": "1.2.0",
"marketplace_id": "marketplace_01HxQ3v9KpZ2mTn8RwLc4Ys7",
"name": "code-review-helper",
"organization_installation_preference": "available",
"organization_installation_preference_inherited": true,
"owner": {
"type": "organization"
},
"reach": "contained",
"served_version_id": "pluginver_01K9wPcHd4Rm2Tx8Vq6Ln3Sb",
"served_version_pinned": true,
"type": "plugin",
"updated_at": "2026-03-14T09:26:53.589793Z"
}
```
##### Returns Examples
Response 200
```python
{
"id": "plugin_01JyHfbRkZvD1gW7oTqXc3Ne",
"components": [
{
"description": "description",
"name": "review-pr",
"type": "skill"
}
],
"content_scan": {
"assessment": "warn",
"reason": "credential-exposure",
"status": "completed"
},
"created_at": "2026-03-14T09:26:53.589793Z",
"created_by": {
"email_address": "user@example.com",
"type": "user_actor",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"description": "Reviews pull requests against your team's conventions.",
"display_name": "Code Review Helper",
"latest_version_id": "pluginver_01KaZmQpRsTuVwXyZ2b4c6d8",
"manifest_version": "1.2.0",
"marketplace_id": "marketplace_01HxQ3v9KpZ2mTn8RwLc4Ys7",
"name": "code-review-helper",
"organization_installation_preference": "available",
"organization_installation_preference_inherited": true,
"owner": {
"type": "organization"
},
"reach": "contained",
"served_version_id": "pluginver_01K9wPcHd4Rm2Tx8Vq6Ln3Sb",
"served_version_pinned": true,
"type": "plugin",
"updated_at": "2026-03-14T09:26:53.589793Z"
---
## Create Plugin Version - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/plugins/versions/create
Path: 04-API-Reference/Admin/beta-organization-plugins-versions-create.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fplugins%2Fversions%2Fcreate)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Create Plugin
Get Plugin
Update Plugin
List Plugins
Delete Plugin
Versions
Create Plugin Version
List Plugin Versions
Get Plugin Version
Download Plugin Version Archive
Installation Settings
Shares
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Plugins](https://platform.claude.com/docs/en/api/http/beta/organization/plugins)
5. [Versions](https://platform.claude.com/docs/en/api/http/beta/organization/plugins/versions)
# Create Plugin Version
Copy page
cURL
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.
The upload is the same `multipart/form-data` as creating a Plugin: the version's files (`files`, each part sent as `files[]`) and optional `release_notes`. The uploaded manifest's `name` must equal the Plugin's `name`. Returns the stored version; read the Plugin back to see which version it serves.
Only a Plugin in a `manual` marketplace takes uploads; a Plugin synchronized from a repository gets its versions from the repository. When the Plugin is in the organization's library marketplace, a version that adds a skill with the name of an organization skill (a skill an administrator uploaded for the whole organization in claude.ai) is refused with a 409: `error_code` `skill_name_taken`, with that name in `details.skill_name`. A 503 with `error_code` `registration_pending` means the version was stored but is not yet usable; a later version create on the Plugin completes it.
For a worked example, see [Create a version](../Other/manage-claude-plugins-api.md#create-a-version) in the Plugins API guide.
**Accepted credentials:** an Admin API key with the `write:plugins` scope.
Every request must include the beta header `anthropic-beta: ce-plugins-2026-09-01`. A request without it returns `404`, exactly as if the endpoint did not exist. The Plugins API is in beta and is available to Claude Enterprise organizations only. It is not available to Claude Platform (Claude Console) organizations, or to organizations with HIPAA readiness enabled.
##### Path parameters
plugin_id: string
ID of the Plugin (prefixed `plugin_`).
##### Headers
"anthropic-beta": optional array of [AnthropicBeta](../Endpoints/platform-claude-com-http-beta.md#anthropic_beta)
This endpoint is in beta: requests must send `ce-plugins-2026-09-01` in this header.
One of the following:
string
"message-batches-2024-09-24"
"prompt-caching-2024-07-31"
"computer-use-2024-10-22"
"computer-use-2025-01-24"
"pdfs-2024-09-25"
"token-counting-2024-11-01"
"token-efficient-tools-2025-02-19"
"output-128k-2025-02-19"
"files-api-2025-04-14"
"mcp-client-2025-04-04"
"mcp-client-2025-11-20"
"dev-full-thinking-2025-05-14"
"interleaved-thinking-2025-05-14"
"code-execution-2025-05-22"
"extended-cache-ttl-2025-04-11"
"context-1m-2025-08-07"
"context-management-2025-06-27"
"model-context-window-exceeded-2025-08-26"
"skills-2025-10-02"
"fast-mode-2026-02-01"
"output-300k-2026-03-24"
"user-profiles-2026-03-24"
"user-profiles-2026-08-18"
"user-profiles-2026-09-04"
"advisor-tool-2026-03-01"
"managed-agents-2026-04-01"
"cache-diagnosis-2026-04-07"
"dreaming-2026-04-21"
"thinking-token-count-2026-05-13"
"server-side-fallback-2026-06-01"
"server-side-fallback-2026-07-01"
"fallback-credit-2026-06-01"
"fallback-credit-2026-07-01"
"agent-memory-2026-07-22"
"mid-conversation-tool-changes-2026-07-01"
"compact-2026-01-12"
"computer-use-2025-11-24"
"mcp-tunnels-2026-06-22"
"structured-outputs-2025-11-13"
"task-budgets-2026-03-13"
"thinking-display-updates-2026-08-18"
"ce-user-management-2026-07-13"
"mid-conversation-output-config-2026-07-01"
"thinking-binding-controls-2026-08-01"
"mid-conversation-system-clear-at-2026-08-21"
"compact-2026-09-04"
"inline-tools-2026-09-15"
"mcp-client-2026-09-15"
"ce-plugins-2026-09-01"
"spend-limit-reads-2026-09-26"
"telemetry-destinations-2026-08-11"
##### Body (form-data)
files: array of string
The version's files: one part per file, the part's filename being the file's path within the Plugin (for example `skills/review-pr/SKILL.md`), or a single `.zip` or `.plugin` archive holding them all. On the wire each part is named `files[]`, and a part named plain `files` is not read; with cURL, `-F 'files[]=@SKILL.md;filename=skills/review-pr/SKILL.md'`. The files must include the manifest, `.claude-plugin/plugin.json`.
release_notes: optional string
Release notes stored with the version and shown in its version history in claude.ai; up to 5,000 characters.
maxLength5000
##### Returns
BetaPluginVersion object{ type: "plugin_version", id, components, 9 more }
Create Plugin Version
cURL
```python
curl https://api.anthropic.com/v1/organizations/plugins/$PLUGIN_ID/versions \
-H 'Content-Type: multipart/form-data' \
-H 'anthropic-version: 2023-06-01' \
-H 'anthropic-beta: ce-plugins-2026-09-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY" \
-F 'files[]=@/path/to/file'
```
Response 200
```python
{
"id": "pluginver_01KaZmQpRsTuVwXyZ2b4c6d8",
"components": [
{
"description": "description",
"name": "review-pr",
"type": "skill"
}
],
"content_scan": {
"assessment": "warn",
"reason": "credential-exposure",
"status": "completed"
},
"created_at": "2026-03-14T09:26:53.589793Z",
"created_by": {
"email_address": "user@example.com",
"type": "user_actor",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"description": "Reviews pull requests against your team's conventions.",
"display_name": "Code Review Helper",
"manifest_version": "1.2.0",
"plugin_id": "plugin_01JyHfbRkZvD1gW7oTqXc3Ne",
"reach": "contained",
"release_notes": "Adds a review checklist for database migrations.",
"type": "plugin_version"
}
```
##### Returns Examples
Response 200
```python
{
"id": "pluginver_01KaZmQpRsTuVwXyZ2b4c6d8",
"components": [
{
"description": "description",
"name": "review-pr",
"type": "skill"
}
],
"content_scan": {
"assessment": "warn",
"reason": "credential-exposure",
"status": "completed"
},
"created_at": "2026-03-14T09:26:53.589793Z",
"created_by": {
"email_address": "user@example.com",
"type": "user_actor",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"description": "Reviews pull requests against your team's conventions.",
"display_name": "Code Review Helper",
"manifest_version": "1.2.0",
"plugin_id": "plugin_01JyHfbRkZvD1gW7oTqXc3Ne",
"reach": "contained",
"release_notes": "Adds a review checklist for database migrations.",
---
## Download Plugin Version Archive - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/plugins/versions/download
Path: 04-API-Reference/Admin/beta-organization-plugins-versions-download.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fplugins%2Fversions%2Fdownload)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Create Plugin
Get Plugin
Update Plugin
List Plugins
Delete Plugin
Versions
Create Plugin Version
List Plugin Versions
Get Plugin Version
Download Plugin Version Archive
Installation Settings
Shares
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Plugins](https://platform.claude.com/docs/en/api/http/beta/organization/plugins)
5. [Versions](https://platform.claude.com/docs/en/api/http/beta/organization/plugins/versions)
# Download Plugin Version Archive
Copy page
cURL
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.
The response body is the archive (`Content-Type: application/zip`), sent as an attachment whose filename is derived from the Plugin's name; name saved files from the IDs in the request path, since that filename is not unique.
**Accepted credentials:** an Admin API key with the `read:plugins` or `read:org_audit` scope, or a Compliance Access Key with the `read:compliance_org_data` scope.
Every read scope above (`read:plugins`, `read:org_audit`, and `read:compliance_org_data`) can download the files of plugins in members' personal marketplaces, including files that claude.ai's admin settings do not show, and a `read:org_audit` or `read:compliance_org_data` key created for all of your parent organization's linked organizations can do this in any organization under it that has access to this API, by passing `organization_id`. Each such download records a `claude_plugin_archive_accessed` event on the Compliance API activity feed, identifying the key, the plugin, the version, and the member. Downloads of organization-owned plugins are not recorded.
Every request must include the beta header `anthropic-beta: ce-plugins-2026-09-01`. A request without it returns `404`, exactly as if the endpoint did not exist. The Plugins API is in beta and is available to Claude Enterprise organizations only. It is not available to Claude Platform (Claude Console) organizations, or to organizations with HIPAA readiness enabled.
##### Path parameters
plugin_id: string
ID of the Plugin (prefixed `plugin_`).
version: string
ID of the Plugin Version (prefixed `pluginver_`). `latest` is not accepted here.
##### Query parameters
organization_id: optional string
For a `read:org_audit` or `read:compliance_org_data` key created for all of a parent organization's linked organizations: a child organization of that parent to read instead of the organization the key was created in, given as the organization's UUID or its `org_`-prefixed ID. A value that is neither returns a 400; an organization that is not a child of the key's parent, or where the Plugins API is not available, returns a 404. Any other key may pass only its own organization's ID here; another organization returns a 404.
##### Headers
"anthropic-beta": optional array of [AnthropicBeta](../Endpoints/platform-claude-com-http-beta.md#anthropic_beta)
This endpoint is in beta: requests must send `ce-plugins-2026-09-01` in this header.
One of the following:
string
"message-batches-2024-09-24"
"prompt-caching-2024-07-31"
"computer-use-2024-10-22"
"computer-use-2025-01-24"
"pdfs-2024-09-25"
"token-counting-2024-11-01"
"token-efficient-tools-2025-02-19"
"output-128k-2025-02-19"
"files-api-2025-04-14"
"mcp-client-2025-04-04"
"mcp-client-2025-11-20"
"dev-full-thinking-2025-05-14"
"interleaved-thinking-2025-05-14"
"code-execution-2025-05-22"
"extended-cache-ttl-2025-04-11"
"context-1m-2025-08-07"
"context-management-2025-06-27"
"model-context-window-exceeded-2025-08-26"
"skills-2025-10-02"
"fast-mode-2026-02-01"
"output-300k-2026-03-24"
"user-profiles-2026-03-24"
"user-profiles-2026-08-18"
"user-profiles-2026-09-04"
"advisor-tool-2026-03-01"
"managed-agents-2026-04-01"
"cache-diagnosis-2026-04-07"
"dreaming-2026-04-21"
"thinking-token-count-2026-05-13"
"server-side-fallback-2026-06-01"
"server-side-fallback-2026-07-01"
"fallback-credit-2026-06-01"
"fallback-credit-2026-07-01"
"agent-memory-2026-07-22"
"mid-conversation-tool-changes-2026-07-01"
"compact-2026-01-12"
"computer-use-2025-11-24"
"mcp-tunnels-2026-06-22"
"structured-outputs-2025-11-13"
"task-budgets-2026-03-13"
"thinking-display-updates-2026-08-18"
"ce-user-management-2026-07-13"
"mid-conversation-output-config-2026-07-01"
"thinking-binding-controls-2026-08-01"
"mid-conversation-system-clear-at-2026-08-21"
"compact-2026-09-04"
"inline-tools-2026-09-15"
"mcp-client-2026-09-15"
"ce-plugins-2026-09-01"
"spend-limit-reads-2026-09-26"
"telemetry-destinations-2026-08-11"
Download Plugin Version Archive
cURL
```python
curl https://api.anthropic.com/v1/organizations/plugins/$PLUGIN_ID/versions/$VERSION/content \
-H 'anthropic-version: 2023-06-01' \
-H 'anthropic-beta: ce-plugins-2026-09-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
---
## List Plugin Versions - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/plugins/versions/list
Path: 04-API-Reference/Admin/beta-organization-plugins-versions-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fplugins%2Fversions%2Flist)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Create Plugin
Get Plugin
Update Plugin
List Plugins
Delete Plugin
Versions
Create Plugin Version
List Plugin Versions
Get Plugin Version
Download Plugin Version Archive
Installation Settings
Shares
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Plugins](https://platform.claude.com/docs/en/api/http/beta/organization/plugins)
5. [Versions](https://platform.claude.com/docs/en/api/http/beta/organization/plugins/versions)
# List Plugin Versions
Copy page
cURL
GET/v1/organizations/plugins/{plugin_id}/versions
List a Plugin's versions, newest first.
The first item of the first page is the version the Plugin's `latest_version_id` refers to.
**Accepted credentials:** an Admin API key with the `read:plugins` or `read:org_audit` scope, or a Compliance Access Key with the `read:compliance_org_data` scope.
Every request must include the beta header `anthropic-beta: ce-plugins-2026-09-01`. A request without it returns `404`, exactly as if the endpoint did not exist. The Plugins API is in beta and is available to Claude Enterprise organizations only. It is not available to Claude Platform (Claude Console) organizations, or to organizations with HIPAA readiness enabled.
##### Path parameters
plugin_id: string
ID of the Plugin (prefixed `plugin_`).
##### Query parameters
limit: optional number
Number of items to return per page.
Defaults to `20`. Ranges from `1` to `1000`.
default20
minimum1
maximum1000
organization_id: optional string
For a `read:org_audit` or `read:compliance_org_data` key created for all of a parent organization's linked organizations: a child organization of that parent to read instead of the organization the key was created in, given as the organization's UUID or its `org_`-prefixed ID. A value that is neither returns a 400; an organization that is not a child of the key's parent, or where the Plugins API is not available, returns a 404. Any other key may pass only its own organization's ID here; another organization returns a 404.
page: optional string
Optionally set to the `next_page` token from the previous response.
maxLength2048
##### Headers
"anthropic-beta": optional array of [AnthropicBeta](../Endpoints/platform-claude-com-http-beta.md#anthropic_beta)
This endpoint is in beta: requests must send `ce-plugins-2026-09-01` in this header.
One of the following:
string
"message-batches-2024-09-24"
"prompt-caching-2024-07-31"
"computer-use-2024-10-22"
"computer-use-2025-01-24"
"pdfs-2024-09-25"
"token-counting-2024-11-01"
"token-efficient-tools-2025-02-19"
"output-128k-2025-02-19"
"files-api-2025-04-14"
"mcp-client-2025-04-04"
"mcp-client-2025-11-20"
"dev-full-thinking-2025-05-14"
"interleaved-thinking-2025-05-14"
"code-execution-2025-05-22"
"extended-cache-ttl-2025-04-11"
"context-1m-2025-08-07"
"context-management-2025-06-27"
"model-context-window-exceeded-2025-08-26"
"skills-2025-10-02"
"fast-mode-2026-02-01"
"output-300k-2026-03-24"
"user-profiles-2026-03-24"
"user-profiles-2026-08-18"
"user-profiles-2026-09-04"
"advisor-tool-2026-03-01"
"managed-agents-2026-04-01"
"cache-diagnosis-2026-04-07"
"dreaming-2026-04-21"
"thinking-token-count-2026-05-13"
"server-side-fallback-2026-06-01"
"server-side-fallback-2026-07-01"
"fallback-credit-2026-06-01"
"fallback-credit-2026-07-01"
"agent-memory-2026-07-22"
"mid-conversation-tool-changes-2026-07-01"
"compact-2026-01-12"
"computer-use-2025-11-24"
"mcp-tunnels-2026-06-22"
"structured-outputs-2025-11-13"
"task-budgets-2026-03-13"
"thinking-display-updates-2026-08-18"
"ce-user-management-2026-07-13"
"mid-conversation-output-config-2026-07-01"
"thinking-binding-controls-2026-08-01"
"mid-conversation-system-clear-at-2026-08-21"
"compact-2026-09-04"
"inline-tools-2026-09-15"
"mcp-client-2026-09-15"
"ce-plugins-2026-09-01"
"spend-limit-reads-2026-09-26"
"telemetry-destinations-2026-08-11"
##### Returns
data: array of [BetaPluginVersion](https://platform.claude.com/docs/en/api/http/beta/organization/plugins/versions#beta_plugin_version) { type: "plugin_version", id, components, 9 more }
type: "plugin_version"
Always `plugin_version`.
defaultplugin_version
id: string
The version's ID.
components: array of [BetaPluginComponent](https://platform.claude.com/docs/en/api/http/beta/organization/plugins#beta_plugin_component) { type, description, name } or null
What the version contains; null when not enumerated.
type: "agent" or "cli" or "command" or 3 more
The kind of component.
One of the following:
"agent"
"cli"
"command"
"hook"
"mcp_server"
"skill"
description: string or null
What the component declares about itself; always null for MCP servers, hooks, and CLIs.
name: string
The component's name: a skill's, command's or agent's name, an MCP server's key in the manifest, the event a hook runs on, or a CLI's executable.
content_scan: [BetaPluginContentScan](https://platform.claude.com/docs/en/api/http/beta/organization/plugins#beta_plugin_content_scan) { assessment, reason, status } or null
This version's content scan; null when it has not been scanned.
assessment: "fail" or "pass" or "unknown" or "warn" or null
The scan's verdict; set only when `status` is `completed`.
One of the following:
"fail"
"pass"
"unknown"
"warn"
reason: string or null
The primary mechanism behind a `warn` or `fail`, such as `credential-exposure` or `guardrail-tampering`; a mechanism this API does not yet name reads as `other`. Null on a `pass`, whenever `assessment` is null, and when no mechanism is reported for the verdict.
status: "completed" or "errored" or "processing"
`processing` while a scan runs, `completed` when it ran to completion, `errored` when it could not run or its outcome cannot be read.
One of the following:
"completed"
"errored"
"processing"
created_at: string
RFC 3339.
formatdate-time
created_by: [BetaPluginUserActor](https://platform.claude.com/docs/en/api/http/beta/organization/plugins#beta_plugin_user_actor) or [BetaPluginAPIActor](https://platform.claude.com/docs/en/api/http/beta/organization/plugins#beta_plugin_api_actor) or null
Who uploaded this version; null when not recorded.
One of the following:
BetaPluginUserActor object{ type: "user_actor", email_address, user_id }
type: "user_actor"
A member of the organization.
defaultuser_actor
email_address: string or null
The member's email address; may be null, for example when they are no longer a member of the organization.
user_id: string
The member's User ID.
BetaPluginAPIActor object{ type: "api_actor", api_key_id }
type: "api_actor"
An Admin API key, in the same form the Compliance API activity feed uses for it.
defaultapi_actor
api_key_id: string
The key's ID.
description: string or null
The manifest's description; null when it declares none.
display_name: string or null
The manifest's display name; null when it declares none.
manifest_version: string or null
The version string the manifest declares; null when it declares none.
plugin_id: string
The Plugin's ID.
reach: "contained" or "privileged" or "remote" or null
How far the version reaches: `remote`, `privileged` or `contained`, as on the Plugin; null when not classifiable.
One of the following:
"contained"
"privileged"
"remote"
release_notes: string or null
As supplied with the upload; null when none were supplied.
next_page: string or null
Token to provide in as `page` in the subsequent request to retrieve the next page of data.
List Plugin Versions
cURL
```python
curl https://api.anthropic.com/v1/organizations/plugins/$PLUGIN_ID/versions \
-H 'anthropic-version: 2023-06-01' \
-H 'anthropic-beta: ce-plugins-2026-09-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"data": [
{
"id": "pluginver_01KaZmQpRsTuVwXyZ2b4c6d8",
"components": [
{
"description": "description",
"name": "review-pr",
"type": "skill"
}
],
"content_scan": {
"assessment": "warn",
"reason": "credential-exposure",
"status": "completed"
},
"created_at": "2026-03-14T09:26:53.589793Z",
"created_by": {
"email_address": "user@example.com",
"type": "user_actor",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"description": "Reviews pull requests against your team's conventions.",
"display_name": "Code Review Helper",
"manifest_version": "1.2.0",
"plugin_id": "plugin_01JyHfbRkZvD1gW7oTqXc3Ne",
"reach": "contained",
"release_notes": "Adds a review checklist for database migrations.",
"type": "plugin_version"
}
],
"next_page": "page_MjAyNi0wOS0xNlQxNDowNTowOVo"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"id": "pluginver_01KaZmQpRsTuVwXyZ2b4c6d8",
"components": [
{
"description": "description",
"name": "review-pr",
"type": "skill"
}
],
"content_scan": {
"assessment": "warn",
"reason": "credential-exposure",
"status": "completed"
},
"created_at": "2026-03-14T09:26:53.589793Z",
"created_by": {
"email_address": "user@example.com",
"type": "user_actor",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"description": "Reviews pull requests against your team's conventions.",
"display_name": "Code Review Helper",
"manifest_version": "1.2.0",
"plugin_id": "plugin_01JyHfbRkZvD1gW7oTqXc3Ne",
"reach": "contained",
"release_notes": "Adds a review checklist for database migrations.",
"type": "plugin_version"
}
],
"next_page": "page_MjAyNi0wOS0xNlQxNDowNTowOVo"
---
## Get Plugin Version - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/plugins/versions/retrieve
Path: 04-API-Reference/Admin/beta-organization-plugins-versions-retrieve.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fplugins%2Fversions%2Fretrieve)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Create Plugin
Get Plugin
Update Plugin
List Plugins
Delete Plugin
Versions
Create Plugin Version
List Plugin Versions
Get Plugin Version
Download Plugin Version Archive
Installation Settings
Shares
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Plugins](https://platform.claude.com/docs/en/api/http/beta/organization/plugins)
5. [Versions](https://platform.claude.com/docs/en/api/http/beta/organization/plugins/versions)
# Get Plugin Version
Copy page
cURL
GET/v1/organizations/plugins/{plugin_id}/versions/{version}
Retrieve one version of a Plugin by its ID, or the Plugin's newest version.
**Accepted credentials:** an Admin API key with the `read:plugins` or `read:org_audit` scope, or a Compliance Access Key with the `read:compliance_org_data` scope.
Every request must include the beta header `anthropic-beta: ce-plugins-2026-09-01`. A request without it returns `404`, exactly as if the endpoint did not exist. The Plugins API is in beta and is available to Claude Enterprise organizations only. It is not available to Claude Platform (Claude Console) organizations, or to organizations with HIPAA readiness enabled.
##### Path parameters
plugin_id: string
ID of the Plugin (prefixed `plugin_`).
version: string
ID of the Plugin Version (prefixed `pluginver_`), or `latest` for the newest one.
##### Query parameters
organization_id: optional string
For a `read:org_audit` or `read:compliance_org_data` key created for all of a parent organization's linked organizations: a child organization of that parent to read instead of the organization the key was created in, given as the organization's UUID or its `org_`-prefixed ID. A value that is neither returns a 400; an organization that is not a child of the key's parent, or where the Plugins API is not available, returns a 404. Any other key may pass only its own organization's ID here; another organization returns a 404.
##### Headers
"anthropic-beta": optional array of [AnthropicBeta](../Endpoints/platform-claude-com-http-beta.md#anthropic_beta)
This endpoint is in beta: requests must send `ce-plugins-2026-09-01` in this header.
One of the following:
string
"message-batches-2024-09-24"
"prompt-caching-2024-07-31"
"computer-use-2024-10-22"
"computer-use-2025-01-24"
"pdfs-2024-09-25"
"token-counting-2024-11-01"
"token-efficient-tools-2025-02-19"
"output-128k-2025-02-19"
"files-api-2025-04-14"
"mcp-client-2025-04-04"
"mcp-client-2025-11-20"
"dev-full-thinking-2025-05-14"
"interleaved-thinking-2025-05-14"
"code-execution-2025-05-22"
"extended-cache-ttl-2025-04-11"
"context-1m-2025-08-07"
"context-management-2025-06-27"
"model-context-window-exceeded-2025-08-26"
"skills-2025-10-02"
"fast-mode-2026-02-01"
"output-300k-2026-03-24"
"user-profiles-2026-03-24"
"user-profiles-2026-08-18"
"user-profiles-2026-09-04"
"advisor-tool-2026-03-01"
"managed-agents-2026-04-01"
"cache-diagnosis-2026-04-07"
"dreaming-2026-04-21"
"thinking-token-count-2026-05-13"
"server-side-fallback-2026-06-01"
"server-side-fallback-2026-07-01"
"fallback-credit-2026-06-01"
"fallback-credit-2026-07-01"
"agent-memory-2026-07-22"
"mid-conversation-tool-changes-2026-07-01"
"compact-2026-01-12"
"computer-use-2025-11-24"
"mcp-tunnels-2026-06-22"
"structured-outputs-2025-11-13"
"task-budgets-2026-03-13"
"thinking-display-updates-2026-08-18"
"ce-user-management-2026-07-13"
"mid-conversation-output-config-2026-07-01"
"thinking-binding-controls-2026-08-01"
"mid-conversation-system-clear-at-2026-08-21"
"compact-2026-09-04"
"inline-tools-2026-09-15"
"mcp-client-2026-09-15"
"ce-plugins-2026-09-01"
"spend-limit-reads-2026-09-26"
"telemetry-destinations-2026-08-11"
##### Returns
BetaPluginVersion object{ type: "plugin_version", id, components, 9 more }
Get Plugin Version
cURL
```python
curl https://api.anthropic.com/v1/organizations/plugins/$PLUGIN_ID/versions/$VERSION \
-H 'anthropic-version: 2023-06-01' \
-H 'anthropic-beta: ce-plugins-2026-09-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"id": "pluginver_01KaZmQpRsTuVwXyZ2b4c6d8",
"components": [
{
"description": "description",
"name": "review-pr",
"type": "skill"
}
],
"content_scan": {
"assessment": "warn",
"reason": "credential-exposure",
"status": "completed"
},
"created_at": "2026-03-14T09:26:53.589793Z",
"created_by": {
"email_address": "user@example.com",
"type": "user_actor",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"description": "Reviews pull requests against your team's conventions.",
"display_name": "Code Review Helper",
"manifest_version": "1.2.0",
"plugin_id": "plugin_01JyHfbRkZvD1gW7oTqXc3Ne",
"reach": "contained",
"release_notes": "Adds a review checklist for database migrations.",
"type": "plugin_version"
}
```
##### Returns Examples
Response 200
```python
{
"id": "pluginver_01KaZmQpRsTuVwXyZ2b4c6d8",
"components": [
{
"description": "description",
"name": "review-pr",
"type": "skill"
}
],
"content_scan": {
"assessment": "warn",
"reason": "credential-exposure",
"status": "completed"
},
"created_at": "2026-03-14T09:26:53.589793Z",
"created_by": {
"email_address": "user@example.com",
"type": "user_actor",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"description": "Reviews pull requests against your team's conventions.",
"display_name": "Code Review Helper",
"manifest_version": "1.2.0",
"plugin_id": "plugin_01JyHfbRkZvD1gW7oTqXc3Ne",
"reach": "contained",
"release_notes": "Adds a review checklist for database migrations.",
---
## Versions - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/plugins/versions
Path: 04-API-Reference/Admin/beta-organization-plugins-versions.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fplugins%2Fversions)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Create Plugin
Get Plugin
Update Plugin
List Plugins
Delete Plugin
Versions
Create Plugin Version
List Plugin Versions
Get Plugin Version
Download Plugin Version Archive
Installation Settings
Shares
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Plugins](https://platform.claude.com/docs/en/api/http/beta/organization/plugins)
# Versions
Copy page
cURL
##### [Create Plugin Version](https://platform.claude.com/docs/en/api/http/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](https://platform.claude.com/docs/en/api/http/beta/organization/plugins/versions/list)
GET/v1/organizations/plugins/{plugin_id}/versions
List a Plugin's versions, newest first.
##### [Get Plugin Version](https://platform.claude.com/docs/en/api/http/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](https://platform.claude.com/docs/en/api/http/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.
##### Models
BetaPluginVersion object{ type: "plugin_version", id, components, 9 more }
---
## Plugins - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/plugins
Path: 04-API-Reference/Admin/beta-organization-plugins.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fplugins)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Create Plugin
Get Plugin
Update Plugin
List Plugins
Delete Plugin
Versions
Installation Settings
Shares
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
List organizations
Users
Roles
Settings
Plugins
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
# Plugins
Copy page
cURL
##### [Create Plugin](https://platform.claude.com/docs/en/api/http/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](https://platform.claude.com/docs/en/api/http/beta/organization/plugins/retrieve)
GET/v1/organizations/plugins/{plugin_id}
Retrieve a Plugin by ID.
##### [Update Plugin](https://platform.claude.com/docs/en/api/http/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](https://platform.claude.com/docs/en/api/http/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](https://platform.claude.com/docs/en/api/http/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.
##### Models
BetaDeletedPlugin object{ type: "plugin_deleted", id }
type: "plugin_deleted"
Always `plugin_deleted`.
defaultplugin_deleted
id: string
The deleted Plugin's ID.
BetaPlugin object{ type: "plugin", id, components, 16 more }
BetaPluginAPIActor object{ type: "api_actor", api_key_id }
type: "api_actor"
An Admin API key, in the same form the Compliance API activity feed uses for it.
defaultapi_actor
api_key_id: string
The key's ID.
BetaPluginComponent object{ type, description, name }
type: "agent" or "cli" or "command" or 3 more
The kind of component.
One of the following:
"agent"
"cli"
"command"
"hook"
"mcp_server"
"skill"
description: string or null
What the component declares about itself; always null for MCP servers, hooks, and CLIs.
name: string
The component's name: a skill's, command's or agent's name, an MCP server's key in the manifest, the event a hook runs on, or a CLI's executable.
BetaPluginContentScan object{ assessment, reason, status }
assessment: "fail" or "pass" or "unknown" or "warn" or null
The scan's verdict; set only when `status` is `completed`.
One of the following:
"fail"
"pass"
"unknown"
"warn"
reason: string or null
The primary mechanism behind a `warn` or `fail`, such as `credential-exposure` or `guardrail-tampering`; a mechanism this API does not yet name reads as `other`. Null on a `pass`, whenever `assessment` is null, and when no mechanism is reported for the verdict.
status: "completed" or "errored" or "processing"
`processing` while a scan runs, `completed` when it ran to completion, `errored` when it could not run or its outcome cannot be read.
One of the following:
"completed"
"errored"
"processing"
BetaPluginOwnerOrganization object{ type: "organization" }
type: "organization"
The Plugin lives in a plugin marketplace the organization owns.
defaultorganization
BetaPluginOwnerUser object{ type: "user", user_id }
type: "user"
The Plugin lives in one member's personal plugin marketplace.
defaultuser
user_id: string
The member's User ID.
BetaPluginTargetOrganization object{ type: "organization" }
type: "organization"
Every member of the organization.
defaultorganization
BetaPluginTargetOrganizationMember object{ type: "organization_member", user_id }
type: "organization_member"
One member of the organization.
defaultorganization_member
user_id: string
The member's User ID.
BetaPluginTargetRBACGroup object{ type: "rbac_group", rbac_group_id }
type: "rbac_group"
An RBAC Group.
defaultrbac_group
rbac_group_id: string
The RBAC Group's ID.
BetaPluginUserActor object{ type: "user_actor", email_address, user_id }
type: "user_actor"
A member of the organization.
defaultuser_actor
email_address: string or null
The member's email address; may be null, for example when they are no longer a member of the organization.
user_id: string
The member's User ID.
#### Plugins[Versions](https://platform.claude.com/docs/en/api/http/beta/organization/plugins/versions)
##### [Create Plugin Version](https://platform.claude.com/docs/en/api/http/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](https://platform.claude.com/docs/en/api/http/beta/organization/plugins/versions/list)
GET/v1/organizations/plugins/{plugin_id}/versions
List a Plugin's versions, newest first.
##### [Get Plugin Version](https://platform.claude.com/docs/en/api/http/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](https://platform.claude.com/docs/en/api/http/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.
#### Plugins[Installation Settings](https://platform.claude.com/docs/en/api/http/beta/organization/plugins/installation_settings)
##### [List Plugin Installation Settings](https://platform.claude.com/docs/en/api/http/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](https://platform.claude.com/docs/en/api/http/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](https://platform.claude.com/docs/en/api/http/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.
#### Plugins[Shares](https://platform.claude.com/docs/en/api/http/beta/organization/plugins/shares)
##### [List Plugin Shares](https://platform.claude.com/docs/en/api/http/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.
---
## List Organization Rate Limits - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/rate_limits/list
Path: 04-API-Reference/Admin/beta-organization-rate-limits-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Frate_limits%2Flist)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
List Organization Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Rate Limits](https://platform.claude.com/docs/en/api/http/beta/organization/rate_limits)
# List Organization Rate Limits
Copy page
cURL
GET/v1/organizations/rate_limits
List Messages API rate limits for your organization.
Each entry corresponds to one rate-limit group (either a model family or an API-surface category such as the Message Batches API or the web search tool) and contains the set of limiter values that apply to it.
When `limit` is omitted, every matching entry is returned in a single page; when `limit` truncates the result, follow `next_page` to fetch the remaining entries.
##### Query parameters
group_type: optional "batch" or "files" or "model_group" or 3 more
Filter by group type.
One of the following:
"batch"
"files"
"model_group"
"skills"
"token_count"
"web_search"
limit: optional number
Maximum number of items to return per page. Ranges from `1` to `1000`.
When omitted, every remaining entry is returned in a single page and `next_page` is `null`.
minimum1
maximum1000
model: optional string
Filter to the single entry containing this model. Accepts full model names and aliases. Returns 404 if the model is not found or has no rate limits for this organization.
page: optional string
Opaque cursor from a previous response's `next_page`.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
##### Returns
data: array of [BetaOrganizationRateLimit](https://platform.claude.com/docs/en/api/http/beta/organization/rate_limits#beta_organization_rate_limit) { type: "rate_limit", id, group, 3 more }
Rate-limit entries for the organization, one per group.
type: "rate_limit"
Object type. Always `rate_limit` for organization rate-limit entries.
defaultrate_limit
id: string
Identifier of this rate-limit entry. It is stable within the organization and differs between organizations; the group's own identifier is `group.id`. Pass it as `rate_limit_id` to set a workspace's overrides for this group.
group: [BetaOrganizationRateLimitModelGroup](https://platform.claude.com/docs/en/api/http/beta/organization/rate_limits#beta_organization_rate_limit_model_group) or [BetaOrganizationRateLimitBatchGroup](https://platform.claude.com/docs/en/api/http/beta/organization/rate_limits#beta_organization_rate_limit_batch_group) or [BetaOrganizationRateLimitTokenCountGroup](https://platform.claude.com/docs/en/api/http/beta/organization/rate_limits#beta_organization_rate_limit_token_count_group) or 3 more
The rate-limit group this entry's limits apply to. Its `type` equals `group_type`.
One of the following:
BetaOrganizationRateLimitModelGroup object{ type: "model_group", id, display_name }
type: "model_group"
Always `model_group`: a family of models.
defaultmodel_group
id: string
Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization.
display_name: string
Human-readable name of the model group (for example, `Claude Sonnet 4.x`). For display only; it may change.
BetaOrganizationRateLimitBatchGroup object{ type: "batch", id }
type: "batch"
Always `batch`: the Message Batches API.
defaultbatch
id: string
Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization.
BetaOrganizationRateLimitTokenCountGroup object{ type: "token_count", id }
type: "token_count"
Always `token_count`: the Token Count API.
defaulttoken_count
id: string
Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization.
BetaOrganizationRateLimitFilesGroup object{ type: "files", id }
type: "files"
Always `files`: the Files API.
defaultfiles
id: string
Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization.
BetaOrganizationRateLimitSkillsGroup object{ type: "skills", id }
type: "skills"
Always `skills`: the Skills API.
defaultskills
id: string
Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization.
BetaOrganizationRateLimitWebSearchGroup object{ type: "web_search", id }
type: "web_search"
Always `web_search`: the Messages API web search tool.
defaultweb_search
id: string
Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization.
limits: array of [BetaOrganizationRateLimitValue](https://platform.claude.com/docs/en/api/http/beta/organization/rate_limits#beta_organization_rate_limit_value) { type, value }
The limiter values that apply to this group.
type: string
The limiter type (for example, `requests_per_minute` or `input_tokens_per_minute`).
value: number
The configured limit value for this limiter type.
models: array of string or null
Model names this entry's limits apply to, including aliases. `null` when `group_type` is not `"model_group"`.
group_type: "batch" or "files" or "model_group" or 3 moreDeprecated
Deprecated: use `group.type` instead. The kind of rate-limit group this entry represents. `model_group` entries apply to a family of models (listed in `models`); other values apply to an API-surface category and have `models` set to `null`. Always equal to `group.type`.
Use \`group.type\` instead. \`group_type\` is still returned and always equals \`group.type\`.
One of the following:
"batch"
"files"
"model_group"
"skills"
"token_count"
"web_search"
next_page: string or null
Opaque cursor for the next page of results, or `null` when no entries remain beyond this response.
List Organization Rate Limits
cURL
```python
curl https://api.anthropic.com/v1/organizations/rate_limits \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"data": [
{
"id": "id",
"group": {
"id": "id",
"display_name": "display_name",
"type": "model_group"
},
"group_type": "batch",
"limits": [
{
"type": "type",
"value": 0
}
],
"models": [
"string"
],
"type": "rate_limit"
}
],
"next_page": "next_page"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"id": "id",
"group": {
"id": "id",
"display_name": "display_name",
---
## Rate Limits - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/rate_limits
Path: 04-API-Reference/Admin/beta-organization-rate-limits.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Frate_limits)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
List Organization Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
# Rate Limits
Copy page
cURL
##### [List Organization Rate Limits](https://platform.claude.com/docs/en/api/http/beta/organization/rate_limits/list)
GET/v1/organizations/rate_limits
List Messages API rate limits for your organization.
##### Models
BetaOrganizationRateLimit object{ type: "rate_limit", id, group, 3 more }
BetaOrganizationRateLimitBatchGroup object{ type: "batch", id }
type: "batch"
Always `batch`: the Message Batches API.
defaultbatch
id: string
Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization.
BetaOrganizationRateLimitFilesGroup object{ type: "files", id }
type: "files"
Always `files`: the Files API.
defaultfiles
id: string
Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization.
BetaOrganizationRateLimitModelGroup object{ type: "model_group", id, display_name }
type: "model_group"
Always `model_group`: a family of models.
defaultmodel_group
id: string
Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization.
display_name: string
Human-readable name of the model group (for example, `Claude Sonnet 4.x`). For display only; it may change.
BetaOrganizationRateLimitSkillsGroup object{ type: "skills", id }
type: "skills"
Always `skills`: the Skills API.
defaultskills
id: string
Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization.
BetaOrganizationRateLimitTokenCountGroup object{ type: "token_count", id }
type: "token_count"
Always `token_count`: the Token Count API.
defaulttoken_count
id: string
Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization.
BetaOrganizationRateLimitValue object{ type, value }
type: string
The limiter type (for example, `requests_per_minute` or `input_tokens_per_minute`).
value: number
The configured limit value for this limiter type.
BetaOrganizationRateLimitWebSearchGroup object{ type: "web_search", id }
type: "web_search"
Always `web_search`: the Messages API web search tool.
defaultweb_search
id: string
Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization.
---
## Create RBAC Group - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/rbac_groups/create
Path: 04-API-Reference/Admin/beta-organization-rbac-groups-create.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Frbac_groups%2Fcreate)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
Create RBAC Group
List RBAC Groups
Get RBAC Group
Update RBAC Group
Delete RBAC Group
Members
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [RBAC Groups](https://platform.claude.com/docs/en/api/http/beta/organization/rbac_groups)
# Create RBAC Group
Copy page
cURL
POST/v1/organizations/rbac_groups
Create an RBAC Group in the Claude Enterprise tenant. Groups created via the API have source type `"direct"`.
The RBAC Groups API is available to Claude Enterprise organizations only.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
##### Body
name: string
Name of the RBAC Group. Not uniqueness-enforced.
minLength1
maxLength255
##### Returns
BetaRBACGroup object{ type: "rbac_group", id, created_at, 5 more }
Create RBAC Group
cURL
```python
curl https://api.anthropic.com/v1/organizations/rbac_groups \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY" \
-d '{
"name": "Engineering"
}'
```
Response 200
```python
{
"id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"created_at": "2024-10-30T23:58:27.427722Z",
"name": "Engineering",
"role_ids": [
"rbac_role_016J8xVtKpDq3Wy9ZmN2hR4s"
],
"roles": [
"rbac_role_016J8xVtKpDq3Wy9ZmN2hR4s"
],
"source_type": "direct",
"type": "rbac_group",
"updated_at": "2024-10-30T23:58:27.427722Z"
}
```
##### Returns Examples
Response 200
```python
{
"id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"created_at": "2024-10-30T23:58:27.427722Z",
"name": "Engineering",
"role_ids": [
"rbac_role_016J8xVtKpDq3Wy9ZmN2hR4s"
],
"roles": [
"rbac_role_016J8xVtKpDq3Wy9ZmN2hR4s"
],
"source_type": "direct",
"type": "rbac_group",
"updated_at": "2024-10-30T23:58:27.427722Z"
---
## Delete RBAC Group - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/rbac_groups/delete
Path: 04-API-Reference/Admin/beta-organization-rbac-groups-delete.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Frbac_groups%2Fdelete)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
Create RBAC Group
List RBAC Groups
Get RBAC Group
Update RBAC Group
Delete RBAC Group
Members
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [RBAC Groups](https://platform.claude.com/docs/en/api/http/beta/organization/rbac_groups)
# Delete RBAC Group
Copy page
cURL
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.
The RBAC Groups API is available to Claude Enterprise organizations only.
##### Path parameters
rbac_group_id: string
ID of the RBAC Group.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
##### Returns
type: "rbac_group_deleted"
Deleted object type.
For RBAC Groups, this is always `"rbac_group_deleted"`.
defaultrbac_group_deleted
id: string
ID of the RBAC Group.
Delete RBAC Group
cURL
```python
curl https://api.anthropic.com/v1/organizations/rbac_groups/$RBAC_GROUP_ID \
-X DELETE \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"type": "rbac_group_deleted"
}
```
##### Returns Examples
Response 200
```python
{
"id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
---
## List RBAC Groups - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/rbac_groups/list
Path: 04-API-Reference/Admin/beta-organization-rbac-groups-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Frbac_groups%2Flist)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
Create RBAC Group
List RBAC Groups
Get RBAC Group
Update RBAC Group
Delete RBAC Group
Members
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [RBAC Groups](https://platform.claude.com/docs/en/api/http/beta/organization/rbac_groups)
# List RBAC Groups
Copy page
cURL
GET/v1/organizations/rbac_groups
List RBAC Groups in the Claude Enterprise tenant.
The RBAC Groups API is available to Claude Enterprise organizations only.
##### Query parameters
limit: optional number
Number of items to return per page.
Defaults to `20`. Ranges from `1` to `1000`.
default20
minimum1
maximum1000
page: optional string
Optionally set to the `next_page` token from the previous response.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
##### Returns
data: array of [BetaRBACGroup](https://platform.claude.com/docs/en/api/http/beta/organization/rbac_groups#beta_rbac_group) { type: "rbac_group", id, created_at, 5 more }
type: "rbac_group"
Object type.
For RBAC Groups, this is always `"rbac_group"`.
defaultrbac_group
id: string
ID of the RBAC Group.
created_at: string
RFC 3339 timestamp of when the RBAC Group was created.
formatdate-time
name: string
Name of the RBAC Group. Not uniqueness-enforced.
role_ids: array of string or null
RBAC Role IDs attached to this RBAC Group. Role attachment is managed in the admin settings and is read-only on this API. `null` means role data was temporarily unavailable — retry to distinguish from an empty list.
source_type: "direct" or "scim"
How the RBAC Group was created: `"direct"` for groups created directly (for example, in the organization's admin settings), `"scim"` for groups provisioned by the identity provider.
One of the following:
"direct"
"scim"
updated_at: string
RFC 3339 timestamp of when the RBAC Group was last updated.
formatdate-time
roles: array of string or nullDeprecated
Deprecated: use `role_ids` instead. IDs of the RBAC Roles attached to this RBAC Group; always the same value as `role_ids`, `null` included.
Use \`role_ids\` instead; \`roles\` always has the same value.
has_more: boolean
Indicates if there are more results in the requested page direction.
next_page: string or null
Token to provide in as `page` in the subsequent request to retrieve the next page of data.
List RBAC Groups
cURL
```python
curl https://api.anthropic.com/v1/organizations/rbac_groups \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"data": [
{
"id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"created_at": "2024-10-30T23:58:27.427722Z",
"name": "Engineering",
"role_ids": [
"rbac_role_016J8xVtKpDq3Wy9ZmN2hR4s"
],
"roles": [
"rbac_role_016J8xVtKpDq3Wy9ZmN2hR4s"
],
"source_type": "direct",
"type": "rbac_group",
"updated_at": "2024-10-30T23:58:27.427722Z"
}
],
"has_more": false,
"next_page": "eyJjdXJzb3IiOiAicmJhY19ncm91cF8wMSJ9"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"created_at": "2024-10-30T23:58:27.427722Z",
"name": "Engineering",
"role_ids": [
"rbac_role_016J8xVtKpDq3Wy9ZmN2hR4s"
],
"roles": [
"rbac_role_016J8xVtKpDq3Wy9ZmN2hR4s"
],
"source_type": "direct",
"type": "rbac_group",
"updated_at": "2024-10-30T23:58:27.427722Z"
}
],
"has_more": false,
"next_page": "eyJjdXJzb3IiOiAicmJhY19ncm91cF8wMSJ9"
---
## Add RBAC Group Member - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/rbac_groups/members/add
Path: 04-API-Reference/Admin/beta-organization-rbac-groups-members-add.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Frbac_groups%2Fmembers%2Fadd)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
Create RBAC Group
List RBAC Groups
Get RBAC Group
Update RBAC Group
Delete RBAC Group
Members
List RBAC Group Members
Add RBAC Group Member
Remove RBAC Group Member
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [RBAC Groups](https://platform.claude.com/docs/en/api/http/beta/organization/rbac_groups)
5. [Members](https://platform.claude.com/docs/en/api/http/beta/organization/rbac_groups/members)
# Add RBAC Group Member
Copy page
cURL
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.
The RBAC Groups API is available to Claude Enterprise organizations only.
##### Path parameters
rbac_group_id: string
ID of the RBAC Group.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
##### Body
user_id: string
ID of the User.
##### Returns
BetaRBACGroupMember object{ type: "rbac_group_member", created_at, email, 3 more }
type: "rbac_group_member"
Object type.
For RBAC Group Members, this is always `"rbac_group_member"`.
defaultrbac_group_member
created_at: string
RFC 3339 timestamp of when the User was added to the RBAC Group.
formatdate-time
email: string
Email of the User.
rbac_group_id: string
ID of the RBAC Group.
user_id: string
ID of the User.
group_id: stringDeprecated
Deprecated: use `rbac_group_id` instead. ID of the RBAC Group; always the same value as `rbac_group_id`.
Use \`rbac_group_id\` instead; \`group_id\` always has the same value.
Add RBAC Group Member
cURL
```python
curl https://api.anthropic.com/v1/organizations/rbac_groups/$RBAC_GROUP_ID/members \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY" \
-d '{
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
}'
```
Response 200
```python
{
"created_at": "2024-10-30T23:58:27.427722Z",
"email": "user@emaildomain.com",
"group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"rbac_group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"type": "rbac_group_member",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
}
```
##### Returns Examples
Response 200
```python
{
"created_at": "2024-10-30T23:58:27.427722Z",
"email": "user@emaildomain.com",
"group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"rbac_group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"type": "rbac_group_member",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
---
## Add RBAC Group Member - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/rbac_groups/members/create
Path: 04-API-Reference/Admin/beta-organization-rbac-groups-members-create.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Frbac_groups%2Fmembers%2Fcreate)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
List RBAC Groups
Get RBAC Group
Create RBAC Group
Update RBAC Group
Delete RBAC Group
Members
List RBAC Group Members
Add RBAC Group Member
Remove RBAC Group Member
RBAC Roles
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [RBAC Groups](https://platform.claude.com/docs/en/api/http/beta/organization/rbac_groups)
5. [Members](https://platform.claude.com/docs/en/api/http/beta/organization/rbac_groups/members)
# Add RBAC Group Member
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.
The RBAC Groups API is available to Claude Enterprise organizations only.
##### Path parameters
rbac_group_id: string
ID of the RBAC Group.
##### Body
user_id: string
ID of the User.
##### Returns
BetaRBACGroupMember object{ type: "rbac_group_member", created_at, email, 3 more }
type: "rbac_group_member"
Object type.
For RBAC Group Members, this is always `"rbac_group_member"`.
defaultrbac_group_member
created_at: string
RFC 3339 timestamp of when the User was added to the RBAC Group.
formatdate-time
email: string
Email of the User.
rbac_group_id: string
ID of the RBAC Group.
user_id: string
ID of the User.
group_id: stringDeprecated
Deprecated: use `rbac_group_id` instead. ID of the RBAC Group; always the same value as `rbac_group_id`.
Use \`rbac_group_id\` instead; \`group_id\` always has the same value.
Add RBAC Group Member
cURL
```python
curl https://api.anthropic.com/v1/organizations/rbac_groups/$RBAC_GROUP_ID/members \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY" \
-d '{
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
}'
```
Response 200
```python
{
"created_at": "2024-10-30T23:58:27.427722Z",
"email": "user@emaildomain.com",
"group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"rbac_group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"type": "rbac_group_member",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
}
```
##### Returns Examples
Response 200
```python
{
"created_at": "2024-10-30T23:58:27.427722Z",
"email": "user@emaildomain.com",
"group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"rbac_group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"type": "rbac_group_member",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
---
## Remove RBAC Group Member - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/rbac_groups/members/delete
Path: 04-API-Reference/Admin/beta-organization-rbac-groups-members-delete.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Frbac_groups%2Fmembers%2Fdelete)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
List RBAC Groups
Get RBAC Group
Create RBAC Group
Update RBAC Group
Delete RBAC Group
Members
List RBAC Group Members
Add RBAC Group Member
Remove RBAC Group Member
RBAC Roles
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [RBAC Groups](https://platform.claude.com/docs/en/api/http/beta/organization/rbac_groups)
5. [Members](https://platform.claude.com/docs/en/api/http/beta/organization/rbac_groups/members)
# Remove RBAC Group Member
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.
The RBAC Groups API is available to Claude Enterprise organizations only.
##### Path parameters
rbac_group_id: string
ID of the RBAC Group.
user_id: string
ID of the User.
##### Returns
BetaRBACGroupMemberDeleted object{ type: "rbac_group_member_deleted", group_id, rbac_group_id, user_id }
type: "rbac_group_member_deleted"
Deleted object type. For RBAC Group Members, this is always `"rbac_group_member_deleted"`.
defaultrbac_group_member_deleted
rbac_group_id: string
ID of the RBAC Group.
user_id: string
ID of the User.
group_id: stringDeprecated
Deprecated: use `rbac_group_id` instead. ID of the RBAC Group; always the same value as `rbac_group_id`.
Use \`rbac_group_id\` instead; \`group_id\` always has the same value.
Remove RBAC Group Member
cURL
```python
curl https://api.anthropic.com/v1/organizations/rbac_groups/$RBAC_GROUP_ID/members/$USER_ID \
-X DELETE \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"rbac_group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"type": "rbac_group_member_deleted",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
}
```
##### Returns Examples
Response 200
```python
{
"group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"rbac_group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"type": "rbac_group_member_deleted",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
---
## List RBAC Group Members - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/rbac_groups/members/list
Path: 04-API-Reference/Admin/beta-organization-rbac-groups-members-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Frbac_groups%2Fmembers%2Flist)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
Create RBAC Group
List RBAC Groups
Get RBAC Group
Update RBAC Group
Delete RBAC Group
Members
List RBAC Group Members
Add RBAC Group Member
Remove RBAC Group Member
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [RBAC Groups](https://platform.claude.com/docs/en/api/http/beta/organization/rbac_groups)
5. [Members](https://platform.claude.com/docs/en/api/http/beta/organization/rbac_groups/members)
# List RBAC Group Members
Copy page
cURL
GET/v1/organizations/rbac_groups/{rbac_group_id}/members
List members of an RBAC Group.
The RBAC Groups API is available to Claude Enterprise organizations only.
##### Path parameters
rbac_group_id: string
ID of the RBAC Group.
##### Query parameters
limit: optional number
Number of items to return per page.
Defaults to `20`. Ranges from `1` to `1000`.
default20
minimum1
maximum1000
page: optional string
Optionally set to the `next_page` token from the previous response.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
##### Returns
data: array of [BetaRBACGroupMember](https://platform.claude.com/docs/en/api/http/beta/organization/rbac_groups/members#beta_rbac_group_member) { type: "rbac_group_member", created_at, email, 3 more }
type: "rbac_group_member"
Object type.
For RBAC Group Members, this is always `"rbac_group_member"`.
defaultrbac_group_member
created_at: string
RFC 3339 timestamp of when the User was added to the RBAC Group.
formatdate-time
email: string
Email of the User.
rbac_group_id: string
ID of the RBAC Group.
user_id: string
ID of the User.
group_id: stringDeprecated
Deprecated: use `rbac_group_id` instead. ID of the RBAC Group; always the same value as `rbac_group_id`.
Use \`rbac_group_id\` instead; \`group_id\` always has the same value.
has_more: boolean
Indicates if there are more results in the requested page direction.
next_page: string or null
Token to provide in as `page` in the subsequent request to retrieve the next page of data.
List RBAC Group Members
cURL
```python
curl https://api.anthropic.com/v1/organizations/rbac_groups/$RBAC_GROUP_ID/members \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"data": [
{
"created_at": "2024-10-30T23:58:27.427722Z",
"email": "user@emaildomain.com",
"group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"rbac_group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"type": "rbac_group_member",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
}
],
"has_more": false,
"next_page": "eyJjdXJzb3IiOiAicmJhY19ncm91cF8wMSJ9"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"created_at": "2024-10-30T23:58:27.427722Z",
"email": "user@emaildomain.com",
"group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"rbac_group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"type": "rbac_group_member",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
}
],
"has_more": false,
"next_page": "eyJjdXJzb3IiOiAicmJhY19ncm91cF8wMSJ9"
---
## Remove RBAC Group Member - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/rbac_groups/members/remove
Path: 04-API-Reference/Admin/beta-organization-rbac-groups-members-remove.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Frbac_groups%2Fmembers%2Fremove)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
Create RBAC Group
List RBAC Groups
Get RBAC Group
Update RBAC Group
Delete RBAC Group
Members
List RBAC Group Members
Add RBAC Group Member
Remove RBAC Group Member
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [RBAC Groups](https://platform.claude.com/docs/en/api/http/beta/organization/rbac_groups)
5. [Members](https://platform.claude.com/docs/en/api/http/beta/organization/rbac_groups/members)
# Remove RBAC Group Member
Copy page
cURL
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.
The RBAC Groups API is available to Claude Enterprise organizations only.
##### Path parameters
rbac_group_id: string
ID of the RBAC Group.
user_id: string
ID of the User.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
##### Returns
type: "rbac_group_member_deleted"
Deleted object type. For RBAC Group Members, this is always `"rbac_group_member_deleted"`.
defaultrbac_group_member_deleted
rbac_group_id: string
ID of the RBAC Group.
user_id: string
ID of the User.
group_id: stringDeprecated
Deprecated: use `rbac_group_id` instead. ID of the RBAC Group; always the same value as `rbac_group_id`.
Use \`rbac_group_id\` instead; \`group_id\` always has the same value.
Remove RBAC Group Member
cURL
```python
curl https://api.anthropic.com/v1/organizations/rbac_groups/$RBAC_GROUP_ID/members/$USER_ID \
-X DELETE \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"rbac_group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"type": "rbac_group_member_deleted",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
}
```
##### Returns Examples
Response 200
```python
{
"group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"rbac_group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"type": "rbac_group_member_deleted",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
---
## Members - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/rbac_groups/members
Path: 04-API-Reference/Admin/beta-organization-rbac-groups-members.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Frbac_groups%2Fmembers)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
Create RBAC Group
List RBAC Groups
Get RBAC Group
Update RBAC Group
Delete RBAC Group
Members
List RBAC Group Members
Add RBAC Group Member
Remove RBAC Group Member
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [RBAC Groups](https://platform.claude.com/docs/en/api/http/beta/organization/rbac_groups)
# Members
Copy page
cURL
##### [List RBAC Group Members](https://platform.claude.com/docs/en/api/http/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](https://platform.claude.com/docs/en/api/http/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](https://platform.claude.com/docs/en/api/http/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.
##### Models
BetaRBACGroupMember object{ type: "rbac_group_member", created_at, email, 3 more }
type: "rbac_group_member"
Object type.
For RBAC Group Members, this is always `"rbac_group_member"`.
defaultrbac_group_member
created_at: string
RFC 3339 timestamp of when the User was added to the RBAC Group.
formatdate-time
email: string
Email of the User.
rbac_group_id: string
ID of the RBAC Group.
user_id: string
ID of the User.
group_id: stringDeprecated
Deprecated: use `rbac_group_id` instead. ID of the RBAC Group; always the same value as `rbac_group_id`.
Use \`rbac_group_id\` instead; \`group_id\` always has the same value.
MemberRemoveResponse object{ type: "rbac_group_member_deleted", group_id, rbac_group_id, user_id }
type: "rbac_group_member_deleted"
Deleted object type. For RBAC Group Members, this is always `"rbac_group_member_deleted"`.
defaultrbac_group_member_deleted
rbac_group_id: string
ID of the RBAC Group.
user_id: string
ID of the User.
group_id: stringDeprecated
Deprecated: use `rbac_group_id` instead. ID of the RBAC Group; always the same value as `rbac_group_id`.
Use \`rbac_group_id\` instead; \`group_id\` always has the same value.
---
## Get RBAC Group - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/rbac_groups/retrieve
Path: 04-API-Reference/Admin/beta-organization-rbac-groups-retrieve.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Frbac_groups%2Fretrieve)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
Create RBAC Group
List RBAC Groups
Get RBAC Group
Update RBAC Group
Delete RBAC Group
Members
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [RBAC Groups](https://platform.claude.com/docs/en/api/http/beta/organization/rbac_groups)
# Get RBAC Group
Copy page
cURL
GET/v1/organizations/rbac_groups/{rbac_group_id}
Retrieve an RBAC Group by ID.
The RBAC Groups API is available to Claude Enterprise organizations only.
##### Path parameters
rbac_group_id: string
ID of the RBAC Group.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
##### Returns
BetaRBACGroup object{ type: "rbac_group", id, created_at, 5 more }
Get RBAC Group
cURL
```python
curl https://api.anthropic.com/v1/organizations/rbac_groups/$RBAC_GROUP_ID \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"created_at": "2024-10-30T23:58:27.427722Z",
"name": "Engineering",
"role_ids": [
"rbac_role_016J8xVtKpDq3Wy9ZmN2hR4s"
],
"roles": [
"rbac_role_016J8xVtKpDq3Wy9ZmN2hR4s"
],
"source_type": "direct",
"type": "rbac_group",
"updated_at": "2024-10-30T23:58:27.427722Z"
}
```
##### Returns Examples
Response 200
```python
{
"id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"created_at": "2024-10-30T23:58:27.427722Z",
"name": "Engineering",
"role_ids": [
"rbac_role_016J8xVtKpDq3Wy9ZmN2hR4s"
],
"roles": [
"rbac_role_016J8xVtKpDq3Wy9ZmN2hR4s"
],
"source_type": "direct",
"type": "rbac_group",
"updated_at": "2024-10-30T23:58:27.427722Z"
---
## Update RBAC Group - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/rbac_groups/update
Path: 04-API-Reference/Admin/beta-organization-rbac-groups-update.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Frbac_groups%2Fupdate)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
Create RBAC Group
List RBAC Groups
Get RBAC Group
Update RBAC Group
Delete RBAC Group
Members
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [RBAC Groups](https://platform.claude.com/docs/en/api/http/beta/organization/rbac_groups)
# Update RBAC Group
Copy page
cURL
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.
The RBAC Groups API is available to Claude Enterprise organizations only.
##### Path parameters
rbac_group_id: string
ID of the RBAC Group.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
##### Body
name: optional string or null
Name of the RBAC Group. Not uniqueness-enforced.
minLength1
maxLength255
##### Returns
BetaRBACGroup object{ type: "rbac_group", id, created_at, 5 more }
Update RBAC Group
cURL
```python
curl https://api.anthropic.com/v1/organizations/rbac_groups/$RBAC_GROUP_ID \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY" \
-d '{
"name": "Engineering"
}'
```
Response 200
```python
{
"id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"created_at": "2024-10-30T23:58:27.427722Z",
"name": "Engineering",
"role_ids": [
"rbac_role_016J8xVtKpDq3Wy9ZmN2hR4s"
],
"roles": [
"rbac_role_016J8xVtKpDq3Wy9ZmN2hR4s"
],
"source_type": "direct",
"type": "rbac_group",
"updated_at": "2024-10-30T23:58:27.427722Z"
}
```
##### Returns Examples
Response 200
```python
{
"id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"created_at": "2024-10-30T23:58:27.427722Z",
"name": "Engineering",
"role_ids": [
"rbac_role_016J8xVtKpDq3Wy9ZmN2hR4s"
],
"roles": [
"rbac_role_016J8xVtKpDq3Wy9ZmN2hR4s"
],
"source_type": "direct",
"type": "rbac_group",
"updated_at": "2024-10-30T23:58:27.427722Z"
---
## RBAC Groups - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/rbac_groups
Path: 04-API-Reference/Admin/beta-organization-rbac-groups.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Frbac_groups)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
Create RBAC Group
List RBAC Groups
Get RBAC Group
Update RBAC Group
Delete RBAC Group
Members
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
# RBAC Groups
Copy page
cURL
##### [Create RBAC Group](https://platform.claude.com/docs/en/api/http/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](https://platform.claude.com/docs/en/api/http/beta/organization/rbac_groups/list)
GET/v1/organizations/rbac_groups
List RBAC Groups in the Claude Enterprise tenant.
##### [Get RBAC Group](https://platform.claude.com/docs/en/api/http/beta/organization/rbac_groups/retrieve)
GET/v1/organizations/rbac_groups/{rbac_group_id}
Retrieve an RBAC Group by ID.
##### [Update RBAC Group](https://platform.claude.com/docs/en/api/http/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](https://platform.claude.com/docs/en/api/http/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.
##### Models
BetaRBACGroup object{ type: "rbac_group", id, created_at, 5 more }
RBACGroupDeleteResponse object{ type: "rbac_group_deleted", id }
type: "rbac_group_deleted"
Deleted object type.
For RBAC Groups, this is always `"rbac_group_deleted"`.
defaultrbac_group_deleted
id: string
ID of the RBAC Group.
#### RBAC Groups[Members](https://platform.claude.com/docs/en/api/http/beta/organization/rbac_groups/members)
##### [List RBAC Group Members](https://platform.claude.com/docs/en/api/http/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](https://platform.claude.com/docs/en/api/http/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](https://platform.claude.com/docs/en/api/http/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.
---
## List RBAC Roles - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/rbac_roles/list
Path: 04-API-Reference/Admin/beta-organization-rbac-roles-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Frbac_roles%2Flist)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
List RBAC Roles
Get RBAC Role
Permissions
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [RBAC Roles](https://platform.claude.com/docs/en/api/http/beta/organization/rbac_roles)
# List RBAC Roles
Copy page
cURL
GET/v1/organizations/rbac_roles
List RBAC Roles in the organization.
The RBAC Roles API is available to Claude Enterprise organizations only.
##### Query parameters
limit: optional number
Number of items to return per page.
Defaults to `20`. Ranges from `1` to `1000`.
default20
minimum1
maximum1000
page: optional string
Optionally set to the `next_page` token from the previous response.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
##### Returns
data: array of [BetaRBACRole](https://platform.claude.com/docs/en/api/http/beta/organization/rbac_roles#beta_rbac_role) { type: "rbac_role", id, created_at, 3 more }
type: "rbac_role"
Object type.
For RBAC Roles, this is always `"rbac_role"`.
defaultrbac_role
id: string
ID of the RBAC Role.
created_at: string
RFC 3339 datetime string indicating when the RBAC Role was created.
formatdate-time
display_name: string
Name of the RBAC Role. For a role created by Anthropic, this name can differ from the label claude.ai shows, and Anthropic may change the name. To keep a lasting reference to a role, store its `id`.
updated_at: string
RFC 3339 datetime string indicating when the RBAC Role was last updated.
formatdate-time
name: stringDeprecated
Deprecated: use `display_name` instead. Name of the RBAC Role; always the same value as `display_name`.
Use \`display_name\` instead; \`name\` always has the same value.
has_more: boolean
Indicates whether there are more results beyond this page.
next_page: string or null
Opaque cursor for the next page. Pass as the `page` parameter on the next request.
List RBAC Roles
cURL
```python
curl https://api.anthropic.com/v1/organizations/rbac_roles \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"data": [
{
"id": "rbac_role_016J8xVtKpDq3Wy9ZmN2hR4s",
"created_at": "2024-10-30T23:58:27.427722Z",
"display_name": "Project Editor",
"name": "Project Editor",
"type": "rbac_role",
"updated_at": "2024-10-30T23:58:27.427722Z"
}
],
"has_more": true,
"next_page": "eyJjdXJzb3IiOiAicmJhY19yb2xlXzAxIn0"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"id": "rbac_role_016J8xVtKpDq3Wy9ZmN2hR4s",
"created_at": "2024-10-30T23:58:27.427722Z",
"display_name": "Project Editor",
"name": "Project Editor",
"type": "rbac_role",
"updated_at": "2024-10-30T23:58:27.427722Z"
}
],
"has_more": true,
"next_page": "eyJjdXJzb3IiOiAicmJhY19yb2xlXzAxIn0"
---
## List RBAC Role Permissions - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/rbac_roles/permissions/list
Path: 04-API-Reference/Admin/beta-organization-rbac-roles-permissions-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Frbac_roles%2Fpermissions%2Flist)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
List RBAC Roles
Get RBAC Role
Permissions
List RBAC Role Permissions
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [RBAC Roles](https://platform.claude.com/docs/en/api/http/beta/organization/rbac_roles)
5. [Permissions](https://platform.claude.com/docs/en/api/http/beta/organization/rbac_roles/permissions)
# List RBAC Role Permissions
Copy page
cURL
GET/v1/organizations/rbac_roles/{rbac_role_id}/permissions
List the permissions an RBAC Role grants.
The RBAC Roles API is available to Claude Enterprise organizations only.
##### Path parameters
rbac_role_id: string
ID of the RBAC Role.
##### Query parameters
limit: optional number
Number of items to return per page.
Defaults to `20`. Ranges from `1` to `1000`.
default20
minimum1
maximum1000
page: optional string
Optionally set to the `next_page` token from the previous response.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
##### Returns
data: array of [BetaRBACRolePermission](https://platform.claude.com/docs/en/api/http/beta/organization/rbac_roles/permissions#beta_rbac_role_permission) { type: "rbac_role_permission", action, resource }
type: "rbac_role_permission"
Object type.
For RBAC Role Permissions, this is always `"rbac_role_permission"`.
defaultrbac_role_permission
action: string
Action the permission grants on the resource.
The vocabulary follows the resource: an `organization` grant carries a product-feature entitlement (for example `chat`), an admin-panel permission entitlement (`permission_*`), or a blanket capability-access mode — `capability_access_all` grants every product-feature entitlement, and `capability_access_all_ga` grants the generally-available subset as it stands at permission-check time; neither mode grants model-access entitlements. A consumer enumerating a role's per-feature grants should treat a blanket row as granting every product-feature entitlement it covers, or it will under-report the role's effective access. A `connector_tool` grant carries a tool-access action (`use` or `always_allow`); a `connector_scope` grant carries the scope action `grant` (the role may receive the named OAuth scope when tokens are minted for the connector); `connector` and `all_connectors` grants carry a tool-access action, the scope action, or an authentication-method action (`interactive` or `managed`).
resource: [BetaRBACOrganizationPermissionResource](https://platform.claude.com/docs/en/api/http/beta/organization/rbac_roles/permissions#beta_rbac_organization_permission_resource) or [BetaRBACConnectorToolPermissionResource](https://platform.claude.com/docs/en/api/http/beta/organization/rbac_roles/permissions#beta_rbac_connector_tool_permission_resource) or [BetaRBACConnectorScopePermissionResource](https://platform.claude.com/docs/en/api/http/beta/organization/rbac_roles/permissions#beta_rbac_connector_scope_permission_resource) or 2 more
What the permission applies to.
A tagged union: `type` names the kind of resource and determines which identifier fields are present.
One of the following:
BetaRBACOrganizationPermissionResource object{ type: "organization", organization_id }
type: "organization"
Kind of resource the permission applies to.
defaultorganization
organization_id: string
UUID of the organization the permission applies to.
BetaRBACConnectorToolPermissionResource object{ type: "connector_tool", connector_id, tool_name }
type: "connector_tool"
Kind of resource the permission applies to.
defaultconnector_tool
connector_id: string
ID of the connector the permission applies to.
tool_name: string
Published name of the connector tool the permission applies to.
When the published name contains characters outside `[a-zA-Z0-9_-]` (or collides with a reserved form), it is server-encoded into a stable `{prefix}_{32-hex}` form — a shortened readable prefix of the name plus a hash — from which the published name is not recoverable.
BetaRBACConnectorScopePermissionResource object{ type: "connector_scope", connector_id, scope }
type: "connector_scope"
Kind of resource the permission applies to.
defaultconnector_scope
connector_id: string
ID of the connector the permission applies to.
scope: string
OAuth scope the permission names — the role may receive this scope when tokens are minted for the connector.
Subject to the same encoding rule as `tool_name`: a scope containing characters outside `[a-zA-Z0-9_-]` (or colliding with a reserved form) appears server-encoded in a stable `{prefix}_{32-hex}` form. OAuth scopes routinely contain `:` and `/`, so most appear encoded.
BetaRBACConnectorPermissionResource object{ type: "connector", connector_id }
type: "connector"
Kind of resource the permission applies to.
defaultconnector
connector_id: string
ID of the connector the permission applies to.
BetaRBACAllConnectorsPermissionResource object{ type: "all_connectors" }
type: "all_connectors"
Kind of resource the permission applies to.
defaultall_connectors
has_more: boolean
Indicates whether there are more results beyond this page.
next_page: string or null
Opaque cursor for the next page. Pass as the `page` parameter on the next request.
List RBAC Role Permissions
cURL
```python
curl https://api.anthropic.com/v1/organizations/rbac_roles/$RBAC_ROLE_ID/permissions \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"data": [
{
"action": "use",
"resource": {
"organization_id": "3c4f5e6d-7a8b-49c0-9d1e-2f3a4b5c6d7e",
"type": "organization"
},
"type": "rbac_role_permission"
}
],
"has_more": true,
"next_page": "eyJjdXJzb3IiOiAicmJhY19yb2xlXzAxIn0"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"action": "use",
"resource": {
"organization_id": "3c4f5e6d-7a8b-49c0-9d1e-2f3a4b5c6d7e",
"type": "organization"
},
"type": "rbac_role_permission"
}
],
"has_more": true,
"next_page": "eyJjdXJzb3IiOiAicmJhY19yb2xlXzAxIn0"
---
## Permissions - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/rbac_roles/permissions
Path: 04-API-Reference/Admin/beta-organization-rbac-roles-permissions.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Frbac_roles%2Fpermissions)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
List RBAC Roles
Get RBAC Role
Permissions
List RBAC Role Permissions
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [RBAC Roles](https://platform.claude.com/docs/en/api/http/beta/organization/rbac_roles)
# Permissions
Copy page
cURL
##### [List RBAC Role Permissions](https://platform.claude.com/docs/en/api/http/beta/organization/rbac_roles/permissions/list)
GET/v1/organizations/rbac_roles/{rbac_role_id}/permissions
List the permissions an RBAC Role grants.
##### Models
BetaRBACAllConnectorsPermissionResource object{ type: "all_connectors" }
type: "all_connectors"
Kind of resource the permission applies to.
defaultall_connectors
BetaRBACConnectorPermissionResource object{ type: "connector", connector_id }
type: "connector"
Kind of resource the permission applies to.
defaultconnector
connector_id: string
ID of the connector the permission applies to.
BetaRBACConnectorScopePermissionResource object{ type: "connector_scope", connector_id, scope }
type: "connector_scope"
Kind of resource the permission applies to.
defaultconnector_scope
connector_id: string
ID of the connector the permission applies to.
scope: string
OAuth scope the permission names — the role may receive this scope when tokens are minted for the connector.
Subject to the same encoding rule as `tool_name`: a scope containing characters outside `[a-zA-Z0-9_-]` (or colliding with a reserved form) appears server-encoded in a stable `{prefix}_{32-hex}` form. OAuth scopes routinely contain `:` and `/`, so most appear encoded.
BetaRBACConnectorToolPermissionResource object{ type: "connector_tool", connector_id, tool_name }
type: "connector_tool"
Kind of resource the permission applies to.
defaultconnector_tool
connector_id: string
ID of the connector the permission applies to.
tool_name: string
Published name of the connector tool the permission applies to.
When the published name contains characters outside `[a-zA-Z0-9_-]` (or collides with a reserved form), it is server-encoded into a stable `{prefix}_{32-hex}` form — a shortened readable prefix of the name plus a hash — from which the published name is not recoverable.
BetaRBACOrganizationPermissionResource object{ type: "organization", organization_id }
type: "organization"
Kind of resource the permission applies to.
defaultorganization
organization_id: string
UUID of the organization the permission applies to.
BetaRBACRolePermission object{ type: "rbac_role_permission", action, resource }
---
## Get RBAC Role - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/rbac_roles/retrieve
Path: 04-API-Reference/Admin/beta-organization-rbac-roles-retrieve.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Frbac_roles%2Fretrieve)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
List RBAC Roles
Get RBAC Role
Permissions
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [RBAC Roles](https://platform.claude.com/docs/en/api/http/beta/organization/rbac_roles)
# Get RBAC Role
Copy page
cURL
GET/v1/organizations/rbac_roles/{rbac_role_id}
Retrieve an RBAC Role by ID.
The RBAC Roles API is available to Claude Enterprise organizations only.
##### Path parameters
rbac_role_id: string
ID of the RBAC Role.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
##### Returns
BetaRBACRole object{ type: "rbac_role", id, created_at, 3 more }
type: "rbac_role"
Object type.
For RBAC Roles, this is always `"rbac_role"`.
defaultrbac_role
id: string
ID of the RBAC Role.
created_at: string
RFC 3339 datetime string indicating when the RBAC Role was created.
formatdate-time
display_name: string
Name of the RBAC Role. For a role created by Anthropic, this name can differ from the label claude.ai shows, and Anthropic may change the name. To keep a lasting reference to a role, store its `id`.
updated_at: string
RFC 3339 datetime string indicating when the RBAC Role was last updated.
formatdate-time
name: stringDeprecated
Deprecated: use `display_name` instead. Name of the RBAC Role; always the same value as `display_name`.
Use \`display_name\` instead; \`name\` always has the same value.
Get RBAC Role
cURL
```python
curl https://api.anthropic.com/v1/organizations/rbac_roles/$RBAC_ROLE_ID \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"id": "rbac_role_016J8xVtKpDq3Wy9ZmN2hR4s",
"created_at": "2024-10-30T23:58:27.427722Z",
"display_name": "Project Editor",
"name": "Project Editor",
"type": "rbac_role",
"updated_at": "2024-10-30T23:58:27.427722Z"
}
```
##### Returns Examples
Response 200
```python
{
"id": "rbac_role_016J8xVtKpDq3Wy9ZmN2hR4s",
"created_at": "2024-10-30T23:58:27.427722Z",
"display_name": "Project Editor",
"name": "Project Editor",
"type": "rbac_role",
"updated_at": "2024-10-30T23:58:27.427722Z"
---
## RBAC Roles - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/rbac_roles
Path: 04-API-Reference/Admin/beta-organization-rbac-roles.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Frbac_roles)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
List RBAC Roles
Get RBAC Role
Permissions
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
# RBAC Roles
Copy page
cURL
##### [List RBAC Roles](https://platform.claude.com/docs/en/api/http/beta/organization/rbac_roles/list)
GET/v1/organizations/rbac_roles
List RBAC Roles in the organization.
##### [Get RBAC Role](https://platform.claude.com/docs/en/api/http/beta/organization/rbac_roles/retrieve)
GET/v1/organizations/rbac_roles/{rbac_role_id}
Retrieve an RBAC Role by ID.
##### Models
BetaRBACRole object{ type: "rbac_role", id, created_at, 3 more }
type: "rbac_role"
Object type.
For RBAC Roles, this is always `"rbac_role"`.
defaultrbac_role
id: string
ID of the RBAC Role.
created_at: string
RFC 3339 datetime string indicating when the RBAC Role was created.
formatdate-time
display_name: string
Name of the RBAC Role. For a role created by Anthropic, this name can differ from the label claude.ai shows, and Anthropic may change the name. To keep a lasting reference to a role, store its `id`.
updated_at: string
RFC 3339 datetime string indicating when the RBAC Role was last updated.
formatdate-time
name: stringDeprecated
Deprecated: use `display_name` instead. Name of the RBAC Role; always the same value as `display_name`.
Use \`display_name\` instead; \`name\` always has the same value.
#### RBAC Roles[Permissions](https://platform.claude.com/docs/en/api/http/beta/organization/rbac_roles/permissions)
##### [List RBAC Role Permissions](https://platform.claude.com/docs/en/api/http/beta/organization/rbac_roles/permissions/list)
GET/v1/organizations/rbac_roles/{rbac_role_id}/permissions
List the permissions an RBAC Role grants.
---
## Get Current Organization - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/retrieve
Path: 04-API-Reference/Admin/beta-organization-retrieve.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fretrieve)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
# Get Current Organization
Copy page
cURL
GET/v1/organizations/me
Retrieve information about the organization associated with the authenticated API key.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
##### Returns
BetaOrganization object{ type: "organization", id, name }
type: "organization"
Object type.
For Organizations, this is always `"organization"`.
defaultorganization
id: string
ID of the Organization.
formatuuid
name: string
Name of the Organization.
Get Current Organization
cURL
```python
curl https://api.anthropic.com/v1/organizations/me \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"id": "12345678-1234-5678-1234-567812345678",
"name": "Organization Name",
"type": "organization"
}
```
##### Returns Examples
Response 200
```python
{
"id": "12345678-1234-5678-1234-567812345678",
---
## Archive Service Account - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/service_accounts/archive
Path: 04-API-Reference/Admin/beta-organization-service-accounts-archive.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fservice_accounts%2Farchive)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Create Service Account
List Service Accounts
Get Service Account
Update Service Account
Archive Service Account
Workspaces
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Service Accounts](https://platform.claude.com/docs/en/api/http/beta/organization/service_accounts)
# Archive Service Account
Copy page
cURL
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](../Other/manage-claude-wif-admin-api.md).
Archive a service account.
Idempotent; re-archiving returns the service account with its original `archived_at`. Rejected with 400 if any live (non-archived) federation rule still targets this service account, same as issuer archival; archive those rules first or change their target to another service account.
##### Path parameters
service_account_id: string
ID of the service account to archive.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"anthropic-beta": optional array of [AnthropicBeta](../Endpoints/platform-claude-com-http-beta.md#anthropic_beta)
Optional header to specify the beta version(s) you want to use.
One of the following:
string
"message-batches-2024-09-24"
"prompt-caching-2024-07-31"
"computer-use-2024-10-22"
"computer-use-2025-01-24"
"pdfs-2024-09-25"
"token-counting-2024-11-01"
"token-efficient-tools-2025-02-19"
"output-128k-2025-02-19"
"files-api-2025-04-14"
"mcp-client-2025-04-04"
"mcp-client-2025-11-20"
"dev-full-thinking-2025-05-14"
"interleaved-thinking-2025-05-14"
"code-execution-2025-05-22"
"extended-cache-ttl-2025-04-11"
"context-1m-2025-08-07"
"context-management-2025-06-27"
"model-context-window-exceeded-2025-08-26"
"skills-2025-10-02"
"fast-mode-2026-02-01"
"output-300k-2026-03-24"
"user-profiles-2026-03-24"
"user-profiles-2026-08-18"
"user-profiles-2026-09-04"
"advisor-tool-2026-03-01"
"managed-agents-2026-04-01"
"cache-diagnosis-2026-04-07"
"dreaming-2026-04-21"
"thinking-token-count-2026-05-13"
"server-side-fallback-2026-06-01"
"server-side-fallback-2026-07-01"
"fallback-credit-2026-06-01"
"fallback-credit-2026-07-01"
"agent-memory-2026-07-22"
"mid-conversation-tool-changes-2026-07-01"
"compact-2026-01-12"
"computer-use-2025-11-24"
"mcp-tunnels-2026-06-22"
"structured-outputs-2025-11-13"
"task-budgets-2026-03-13"
"thinking-display-updates-2026-08-18"
"ce-user-management-2026-07-13"
"mid-conversation-output-config-2026-07-01"
"thinking-binding-controls-2026-08-01"
"mid-conversation-system-clear-at-2026-08-21"
"compact-2026-09-04"
"inline-tools-2026-09-15"
"mcp-client-2026-09-15"
"ce-plugins-2026-09-01"
"spend-limit-reads-2026-09-26"
"telemetry-destinations-2026-08-11"
"webhooks-2026-10-07"
##### Returns
BetaServiceAccount object{ type: "service_account", id, archived_at, 8 more }
Named non-human identity within the caller's organization.
A service account is a pure identity: name + org. Authorization lives on whatever references it (federation rules).
Archive Service Account
cURL
```python
curl https://api.anthropic.com/v1/organizations/service_accounts/$SERVICE_ACCOUNT_ID/archive \
-X POST \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"id": "svac_01SDCCSbTxrXDpWc1phhtcfK",
"archived_at": "2019-12-27T18:11:19.117Z",
"archived_by_actor_id": "archived_by_actor_id",
"created_at": "2024-10-30T23:58:27.427722Z",
"created_by_actor_id": "created_by_actor_id",
"description": "description",
"name": "ci-deploy-bot",
"organization_role": "admin",
"type": "service_account",
"updated_at": "2024-10-30T23:58:27.427722Z",
"updated_by_actor_id": "updated_by_actor_id"
}
```
##### Returns Examples
Response 200
```python
{
"id": "svac_01SDCCSbTxrXDpWc1phhtcfK",
"archived_at": "2019-12-27T18:11:19.117Z",
"archived_by_actor_id": "archived_by_actor_id",
"created_at": "2024-10-30T23:58:27.427722Z",
"created_by_actor_id": "created_by_actor_id",
"description": "description",
"name": "ci-deploy-bot",
"organization_role": "admin",
"type": "service_account",
"updated_at": "2024-10-30T23:58:27.427722Z",
"updated_by_actor_id": "updated_by_actor_id"
---
## Create Service Account - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/service_accounts/create
Path: 04-API-Reference/Admin/beta-organization-service-accounts-create.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fservice_accounts%2Fcreate)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Create Service Account
List Service Accounts
Get Service Account
Update Service Account
Archive Service Account
Workspaces
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Service Accounts](https://platform.claude.com/docs/en/api/http/beta/organization/service_accounts)
# Create Service Account
Copy page
cURL
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](../Other/manage-claude-wif-admin-api.md).
Create a service account.
A service account is a named workload identity that federation rules target. `organization_role` is `developer` (default) or `admin`; a rule may only be created or retargeted to grant `org:admin` scope when the target's `organization_role` is `admin`. Creating an `admin`-role service account requires an interactive credential (a user OAuth token or a Console session) — a workload may only create `developer`-role service accounts.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"anthropic-beta": optional array of [AnthropicBeta](../Endpoints/platform-claude-com-http-beta.md#anthropic_beta)
Optional header to specify the beta version(s) you want to use.
One of the following:
string
"message-batches-2024-09-24"
"prompt-caching-2024-07-31"
"computer-use-2024-10-22"
"computer-use-2025-01-24"
"pdfs-2024-09-25"
"token-counting-2024-11-01"
"token-efficient-tools-2025-02-19"
"output-128k-2025-02-19"
"files-api-2025-04-14"
"mcp-client-2025-04-04"
"mcp-client-2025-11-20"
"dev-full-thinking-2025-05-14"
"interleaved-thinking-2025-05-14"
"code-execution-2025-05-22"
"extended-cache-ttl-2025-04-11"
"context-1m-2025-08-07"
"context-management-2025-06-27"
"model-context-window-exceeded-2025-08-26"
"skills-2025-10-02"
"fast-mode-2026-02-01"
"output-300k-2026-03-24"
"user-profiles-2026-03-24"
"user-profiles-2026-08-18"
"user-profiles-2026-09-04"
"advisor-tool-2026-03-01"
"managed-agents-2026-04-01"
"cache-diagnosis-2026-04-07"
"dreaming-2026-04-21"
"thinking-token-count-2026-05-13"
"server-side-fallback-2026-06-01"
"server-side-fallback-2026-07-01"
"fallback-credit-2026-06-01"
"fallback-credit-2026-07-01"
"agent-memory-2026-07-22"
"mid-conversation-tool-changes-2026-07-01"
"compact-2026-01-12"
"computer-use-2025-11-24"
"mcp-tunnels-2026-06-22"
"structured-outputs-2025-11-13"
"task-budgets-2026-03-13"
"thinking-display-updates-2026-08-18"
"ce-user-management-2026-07-13"
"mid-conversation-output-config-2026-07-01"
"thinking-binding-controls-2026-08-01"
"mid-conversation-system-clear-at-2026-08-21"
"compact-2026-09-04"
"inline-tools-2026-09-15"
"mcp-client-2026-09-15"
"ce-plugins-2026-09-01"
"spend-limit-reads-2026-09-26"
"telemetry-destinations-2026-08-11"
"webhooks-2026-10-07"
##### Body
name: string
Slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409.
minLength1
maxLength255
description: optional string or null
Optional free-text description.
maxLength2000
organization_role: optional "admin" or "developer"
Org-level role. Defaults to `developer`.
One of the following:
"admin"
"developer"
##### Returns
BetaServiceAccount object{ type: "service_account", id, archived_at, 8 more }
Named non-human identity within the caller's organization.
A service account is a pure identity: name + org. Authorization lives on whatever references it (federation rules).
Create Service Account
cURL
```python
curl https://api.anthropic.com/v1/organizations/service_accounts \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY" \
-d '{
"name": "ci-deploy-bot"
}'
```
Response 200
```python
{
"id": "svac_01SDCCSbTxrXDpWc1phhtcfK",
"archived_at": "2019-12-27T18:11:19.117Z",
"archived_by_actor_id": "archived_by_actor_id",
"created_at": "2024-10-30T23:58:27.427722Z",
"created_by_actor_id": "created_by_actor_id",
"description": "description",
"name": "ci-deploy-bot",
"organization_role": "admin",
"type": "service_account",
"updated_at": "2024-10-30T23:58:27.427722Z",
"updated_by_actor_id": "updated_by_actor_id"
}
```
##### Returns Examples
Response 200
```python
{
"id": "svac_01SDCCSbTxrXDpWc1phhtcfK",
"archived_at": "2019-12-27T18:11:19.117Z",
"archived_by_actor_id": "archived_by_actor_id",
"created_at": "2024-10-30T23:58:27.427722Z",
"created_by_actor_id": "created_by_actor_id",
"description": "description",
"name": "ci-deploy-bot",
"organization_role": "admin",
"type": "service_account",
"updated_at": "2024-10-30T23:58:27.427722Z",
"updated_by_actor_id": "updated_by_actor_id"
---
## List Service Accounts - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/service_accounts/list
Path: 04-API-Reference/Admin/beta-organization-service-accounts-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fservice_accounts%2Flist)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Create Service Account
List Service Accounts
Get Service Account
Update Service Account
Archive Service Account
Workspaces
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Service Accounts](https://platform.claude.com/docs/en/api/http/beta/organization/service_accounts)
# List Service Accounts
Copy page
cURL
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](../Other/manage-claude-wif-admin-api.md).
List service accounts in the caller's organization.
Results are ordered by creation time, newest first. Use `limit` and the `next_page` cursor to paginate; set `include_archived=true` to include archived service accounts.
##### Query parameters
include_archived: optional boolean
Include archived resources. Defaults to false.
defaultfalse
limit: optional number
Number of results per page.
default20
minimum1
maximum100
page: optional string
Opaque cursor from a previous response's `next_page`.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"anthropic-beta": optional array of [AnthropicBeta](../Endpoints/platform-claude-com-http-beta.md#anthropic_beta)
Optional header to specify the beta version(s) you want to use.
One of the following:
string
"message-batches-2024-09-24"
"prompt-caching-2024-07-31"
"computer-use-2024-10-22"
"computer-use-2025-01-24"
"pdfs-2024-09-25"
"token-counting-2024-11-01"
"token-efficient-tools-2025-02-19"
"output-128k-2025-02-19"
"files-api-2025-04-14"
"mcp-client-2025-04-04"
"mcp-client-2025-11-20"
"dev-full-thinking-2025-05-14"
"interleaved-thinking-2025-05-14"
"code-execution-2025-05-22"
"extended-cache-ttl-2025-04-11"
"context-1m-2025-08-07"
"context-management-2025-06-27"
"model-context-window-exceeded-2025-08-26"
"skills-2025-10-02"
"fast-mode-2026-02-01"
"output-300k-2026-03-24"
"user-profiles-2026-03-24"
"user-profiles-2026-08-18"
"user-profiles-2026-09-04"
"advisor-tool-2026-03-01"
"managed-agents-2026-04-01"
"cache-diagnosis-2026-04-07"
"dreaming-2026-04-21"
"thinking-token-count-2026-05-13"
"server-side-fallback-2026-06-01"
"server-side-fallback-2026-07-01"
"fallback-credit-2026-06-01"
"fallback-credit-2026-07-01"
"agent-memory-2026-07-22"
"mid-conversation-tool-changes-2026-07-01"
"compact-2026-01-12"
"computer-use-2025-11-24"
"mcp-tunnels-2026-06-22"
"structured-outputs-2025-11-13"
"task-budgets-2026-03-13"
"thinking-display-updates-2026-08-18"
"ce-user-management-2026-07-13"
"mid-conversation-output-config-2026-07-01"
"thinking-binding-controls-2026-08-01"
"mid-conversation-system-clear-at-2026-08-21"
"compact-2026-09-04"
"inline-tools-2026-09-15"
"mcp-client-2026-09-15"
"ce-plugins-2026-09-01"
"spend-limit-reads-2026-09-26"
"telemetry-destinations-2026-08-11"
"webhooks-2026-10-07"
##### Returns
data: array of [BetaServiceAccount](https://platform.claude.com/docs/en/api/http/beta/organization/service_accounts#beta_service_account) { type: "service_account", id, archived_at, 8 more }
type: "service_account"
defaultservice_account
id: string
Tagged ID of the service account.
archived_at: string or null
If set, this service account is archived.
formatdate-time
archived_by_actor_id: string or null
Tagged ID (`user_`/`svac_`) of the actor that archived this service account.
created_at: string
When this service account was created.
formatdate-time
created_by_actor_id: string or null
Tagged ID (`user_`/`svac_`) of the actor that created this service account.
description: string or null
Optional free-text description.
name: string
Admin-chosen slug identifier.
organization_role: "admin" or "developer"
Org-level role. A federation rule may only be created or retargeted to grant `org:admin` scope when this is `admin`. A rule granting `org:admin` whose target is later demoted to `developer` is rejected at token exchange. Rules granting `org:admin` are managed in the Console.
One of the following:
"admin"
"developer"
updated_at: string
When this service account was last updated.
formatdate-time
updated_by_actor_id: string or null
Tagged ID (`user_`/`svac_`) of the actor that last updated this service account.
next_page: string or null
Opaque cursor for the next page, or null if no more results.
List Service Accounts
cURL
```python
curl https://api.anthropic.com/v1/organizations/service_accounts \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"data": [
{
"id": "svac_01SDCCSbTxrXDpWc1phhtcfK",
"archived_at": "2019-12-27T18:11:19.117Z",
"archived_by_actor_id": "archived_by_actor_id",
"created_at": "2024-10-30T23:58:27.427722Z",
"created_by_actor_id": "created_by_actor_id",
"description": "description",
"name": "ci-deploy-bot",
"organization_role": "admin",
"type": "service_account",
"updated_at": "2024-10-30T23:58:27.427722Z",
"updated_by_actor_id": "updated_by_actor_id"
}
],
"next_page": "next_page"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"id": "svac_01SDCCSbTxrXDpWc1phhtcfK",
"archived_at": "2019-12-27T18:11:19.117Z",
"archived_by_actor_id": "archived_by_actor_id",
"created_at": "2024-10-30T23:58:27.427722Z",
"created_by_actor_id": "created_by_actor_id",
"description": "description",
"name": "ci-deploy-bot",
"organization_role": "admin",
"type": "service_account",
"updated_at": "2024-10-30T23:58:27.427722Z",
"updated_by_actor_id": "updated_by_actor_id"
---
## Get Service Account - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/service_accounts/retrieve
Path: 04-API-Reference/Admin/beta-organization-service-accounts-retrieve.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fservice_accounts%2Fretrieve)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Create Service Account
List Service Accounts
Get Service Account
Update Service Account
Archive Service Account
Workspaces
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Service Accounts](https://platform.claude.com/docs/en/api/http/beta/organization/service_accounts)
# Get Service Account
Copy page
cURL
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](../Other/manage-claude-wif-admin-api.md).
Retrieve a service account by its ID (`svac_...`).
##### Path parameters
service_account_id: string
ID of the service account.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"anthropic-beta": optional array of [AnthropicBeta](../Endpoints/platform-claude-com-http-beta.md#anthropic_beta)
Optional header to specify the beta version(s) you want to use.
One of the following:
string
"message-batches-2024-09-24"
"prompt-caching-2024-07-31"
"computer-use-2024-10-22"
"computer-use-2025-01-24"
"pdfs-2024-09-25"
"token-counting-2024-11-01"
"token-efficient-tools-2025-02-19"
"output-128k-2025-02-19"
"files-api-2025-04-14"
"mcp-client-2025-04-04"
"mcp-client-2025-11-20"
"dev-full-thinking-2025-05-14"
"interleaved-thinking-2025-05-14"
"code-execution-2025-05-22"
"extended-cache-ttl-2025-04-11"
"context-1m-2025-08-07"
"context-management-2025-06-27"
"model-context-window-exceeded-2025-08-26"
"skills-2025-10-02"
"fast-mode-2026-02-01"
"output-300k-2026-03-24"
"user-profiles-2026-03-24"
"user-profiles-2026-08-18"
"user-profiles-2026-09-04"
"advisor-tool-2026-03-01"
"managed-agents-2026-04-01"
"cache-diagnosis-2026-04-07"
"dreaming-2026-04-21"
"thinking-token-count-2026-05-13"
"server-side-fallback-2026-06-01"
"server-side-fallback-2026-07-01"
"fallback-credit-2026-06-01"
"fallback-credit-2026-07-01"
"agent-memory-2026-07-22"
"mid-conversation-tool-changes-2026-07-01"
"compact-2026-01-12"
"computer-use-2025-11-24"
"mcp-tunnels-2026-06-22"
"structured-outputs-2025-11-13"
"task-budgets-2026-03-13"
"thinking-display-updates-2026-08-18"
"ce-user-management-2026-07-13"
"mid-conversation-output-config-2026-07-01"
"thinking-binding-controls-2026-08-01"
"mid-conversation-system-clear-at-2026-08-21"
"compact-2026-09-04"
"inline-tools-2026-09-15"
"mcp-client-2026-09-15"
"ce-plugins-2026-09-01"
"spend-limit-reads-2026-09-26"
"telemetry-destinations-2026-08-11"
"webhooks-2026-10-07"
##### Returns
BetaServiceAccount object{ type: "service_account", id, archived_at, 8 more }
Named non-human identity within the caller's organization.
A service account is a pure identity: name + org. Authorization lives on whatever references it (federation rules).
Get Service Account
cURL
```python
curl https://api.anthropic.com/v1/organizations/service_accounts/$SERVICE_ACCOUNT_ID \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"id": "svac_01SDCCSbTxrXDpWc1phhtcfK",
"archived_at": "2019-12-27T18:11:19.117Z",
"archived_by_actor_id": "archived_by_actor_id",
"created_at": "2024-10-30T23:58:27.427722Z",
"created_by_actor_id": "created_by_actor_id",
"description": "description",
"name": "ci-deploy-bot",
"organization_role": "admin",
"type": "service_account",
"updated_at": "2024-10-30T23:58:27.427722Z",
"updated_by_actor_id": "updated_by_actor_id"
}
```
##### Returns Examples
Response 200
```python
{
"id": "svac_01SDCCSbTxrXDpWc1phhtcfK",
"archived_at": "2019-12-27T18:11:19.117Z",
"archived_by_actor_id": "archived_by_actor_id",
"created_at": "2024-10-30T23:58:27.427722Z",
"created_by_actor_id": "created_by_actor_id",
"description": "description",
"name": "ci-deploy-bot",
"organization_role": "admin",
"type": "service_account",
"updated_at": "2024-10-30T23:58:27.427722Z",
"updated_by_actor_id": "updated_by_actor_id"
---
## Update Service Account - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/service_accounts/update
Path: 04-API-Reference/Admin/beta-organization-service-accounts-update.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fservice_accounts%2Fupdate)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Create Service Account
List Service Accounts
Get Service Account
Update Service Account
Archive Service Account
Workspaces
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Service Accounts](https://platform.claude.com/docs/en/api/http/beta/organization/service_accounts)
# Update Service Account
Copy page
cURL
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](../Other/manage-claude-wif-admin-api.md).
Update a service account.
Only `description` and `organization_role` are mutable; `name` cannot be changed. Archived service accounts cannot be updated; this returns 400. Setting `organization_role` to `admin` (even when unchanged) requires an interactive credential (a user OAuth token or a Console session).
##### Path parameters
service_account_id: string
ID of the service account to update.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"anthropic-beta": optional array of [AnthropicBeta](../Endpoints/platform-claude-com-http-beta.md#anthropic_beta)
Optional header to specify the beta version(s) you want to use.
One of the following:
string
"message-batches-2024-09-24"
"prompt-caching-2024-07-31"
"computer-use-2024-10-22"
"computer-use-2025-01-24"
"pdfs-2024-09-25"
"token-counting-2024-11-01"
"token-efficient-tools-2025-02-19"
"output-128k-2025-02-19"
"files-api-2025-04-14"
"mcp-client-2025-04-04"
"mcp-client-2025-11-20"
"dev-full-thinking-2025-05-14"
"interleaved-thinking-2025-05-14"
"code-execution-2025-05-22"
"extended-cache-ttl-2025-04-11"
"context-1m-2025-08-07"
"context-management-2025-06-27"
"model-context-window-exceeded-2025-08-26"
"skills-2025-10-02"
"fast-mode-2026-02-01"
"output-300k-2026-03-24"
"user-profiles-2026-03-24"
"user-profiles-2026-08-18"
"user-profiles-2026-09-04"
"advisor-tool-2026-03-01"
"managed-agents-2026-04-01"
"cache-diagnosis-2026-04-07"
"dreaming-2026-04-21"
"thinking-token-count-2026-05-13"
"server-side-fallback-2026-06-01"
"server-side-fallback-2026-07-01"
"fallback-credit-2026-06-01"
"fallback-credit-2026-07-01"
"agent-memory-2026-07-22"
"mid-conversation-tool-changes-2026-07-01"
"compact-2026-01-12"
"computer-use-2025-11-24"
"mcp-tunnels-2026-06-22"
"structured-outputs-2025-11-13"
"task-budgets-2026-03-13"
"thinking-display-updates-2026-08-18"
"ce-user-management-2026-07-13"
"mid-conversation-output-config-2026-07-01"
"thinking-binding-controls-2026-08-01"
"mid-conversation-system-clear-at-2026-08-21"
"compact-2026-09-04"
"inline-tools-2026-09-15"
"mcp-client-2026-09-15"
"ce-plugins-2026-09-01"
"spend-limit-reads-2026-09-26"
"telemetry-destinations-2026-08-11"
"webhooks-2026-10-07"
##### Body
description: optional string or null
Replaces the description. Omit to leave unchanged; send `null` to clear (the field is stored as an empty string).
maxLength2000
organization_role: optional "admin" or "developer" or null
Replaces the org-level role. Omit or send `null` to leave unchanged.
One of the following:
"admin"
"developer"
##### Returns
BetaServiceAccount object{ type: "service_account", id, archived_at, 8 more }
Named non-human identity within the caller's organization.
A service account is a pure identity: name + org. Authorization lives on whatever references it (federation rules).
Update Service Account
cURL
```python
curl https://api.anthropic.com/v1/organizations/service_accounts/$SERVICE_ACCOUNT_ID \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY" \
-d '{}'
```
Response 200
```python
{
"id": "svac_01SDCCSbTxrXDpWc1phhtcfK",
"archived_at": "2019-12-27T18:11:19.117Z",
"archived_by_actor_id": "archived_by_actor_id",
"created_at": "2024-10-30T23:58:27.427722Z",
"created_by_actor_id": "created_by_actor_id",
"description": "description",
"name": "ci-deploy-bot",
"organization_role": "admin",
"type": "service_account",
"updated_at": "2024-10-30T23:58:27.427722Z",
"updated_by_actor_id": "updated_by_actor_id"
}
```
##### Returns Examples
Response 200
```python
{
"id": "svac_01SDCCSbTxrXDpWc1phhtcfK",
"archived_at": "2019-12-27T18:11:19.117Z",
"archived_by_actor_id": "archived_by_actor_id",
"created_at": "2024-10-30T23:58:27.427722Z",
"created_by_actor_id": "created_by_actor_id",
"description": "description",
"name": "ci-deploy-bot",
"organization_role": "admin",
"type": "service_account",
"updated_at": "2024-10-30T23:58:27.427722Z",
"updated_by_actor_id": "updated_by_actor_id"
---
## Add Workspace To Service Account - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/service_accounts/workspaces/add
Path: 04-API-Reference/Admin/beta-organization-service-accounts-workspaces-add.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fservice_accounts%2Fworkspaces%2Fadd)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Create Service Account
List Service Accounts
Get Service Account
Update Service Account
Archive Service Account
Workspaces
Add Workspace To Service Account
List Workspaces For Service Account
Remove Workspace From Service Account
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Service Accounts](https://platform.claude.com/docs/en/api/http/beta/organization/service_accounts)
5. [Workspaces](https://platform.claude.com/docs/en/api/http/beta/organization/service_accounts/workspaces)
# Add Workspace To Service Account
Copy page
cURL
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](../Other/manage-claude-wif-admin-api.md).
Add a service account to a workspace with the given `workspace_role`.
Mirror of `POST /workspaces/{workspace_id}/service_accounts`, addressed from the service-account side; both create the same membership. If the service account is already an explicit member of the workspace, its `workspace_role` is replaced with the value supplied here. Archived workspaces return 400. Archived service accounts cannot be added and are rejected.
##### Path parameters
service_account_id: string
ID of the service account.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"anthropic-beta": optional array of [AnthropicBeta](../Endpoints/platform-claude-com-http-beta.md#anthropic_beta)
Optional header to specify the beta version(s) you want to use.
One of the following:
string
"message-batches-2024-09-24"
"prompt-caching-2024-07-31"
"computer-use-2024-10-22"
"computer-use-2025-01-24"
"pdfs-2024-09-25"
"token-counting-2024-11-01"
"token-efficient-tools-2025-02-19"
"output-128k-2025-02-19"
"files-api-2025-04-14"
"mcp-client-2025-04-04"
"mcp-client-2025-11-20"
"dev-full-thinking-2025-05-14"
"interleaved-thinking-2025-05-14"
"code-execution-2025-05-22"
"extended-cache-ttl-2025-04-11"
"context-1m-2025-08-07"
"context-management-2025-06-27"
"model-context-window-exceeded-2025-08-26"
"skills-2025-10-02"
"fast-mode-2026-02-01"
"output-300k-2026-03-24"
"user-profiles-2026-03-24"
"user-profiles-2026-08-18"
"user-profiles-2026-09-04"
"advisor-tool-2026-03-01"
"managed-agents-2026-04-01"
"cache-diagnosis-2026-04-07"
"dreaming-2026-04-21"
"thinking-token-count-2026-05-13"
"server-side-fallback-2026-06-01"
"server-side-fallback-2026-07-01"
"fallback-credit-2026-06-01"
"fallback-credit-2026-07-01"
"agent-memory-2026-07-22"
"mid-conversation-tool-changes-2026-07-01"
"compact-2026-01-12"
"computer-use-2025-11-24"
"mcp-tunnels-2026-06-22"
"structured-outputs-2025-11-13"
"task-budgets-2026-03-13"
"thinking-display-updates-2026-08-18"
"ce-user-management-2026-07-13"
"mid-conversation-output-config-2026-07-01"
"thinking-binding-controls-2026-08-01"
"mid-conversation-system-clear-at-2026-08-21"
"compact-2026-09-04"
"inline-tools-2026-09-15"
"mcp-client-2026-09-15"
"ce-plugins-2026-09-01"
"spend-limit-reads-2026-09-26"
"telemetry-destinations-2026-08-11"
"webhooks-2026-10-07"
##### Body
workspace_id: string
Tagged workspace ID to add the service account to.
workspace_role: [BetaNoBillingWorkspaceRole](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces#beta_no_billing_workspace_role)
Role to assign to the service account in this workspace.
One of the following:
"workspace_admin"
"workspace_developer"
"workspace_restricted_developer"
"workspace_user"
##### Returns
BetaServiceAccountWorkspaceMember object{ type: "service_account_workspace_member", created_by_actor_id, implicit, 3 more }
type: "service_account_workspace_member"
defaultservice_account_workspace_member
created_by_actor_id: string or null
Tagged ID (`user_...`/`svac_...`) of the actor who created this membership.
implicit: boolean or null
True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed.
service_account_id: string
Tagged service account ID (`svac_...`).
workspace_id: string
Tagged workspace ID (`wrkspc_...`).
workspace_role: [BetaWorkspaceRole](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces#beta_workspace_role)
Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role.
One of the following:
"workspace_admin"
"workspace_billing"
"workspace_developer"
"workspace_restricted_developer"
"workspace_user"
Add Workspace To Service Account
cURL
```python
curl https://api.anthropic.com/v1/organizations/service_accounts/$SERVICE_ACCOUNT_ID/workspaces \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY" \
-d '{
"workspace_id": "workspace_id",
"workspace_role": "workspace_admin"
}'
```
Response 200
```python
{
"created_by_actor_id": "created_by_actor_id",
"implicit": true,
"service_account_id": "service_account_id",
"type": "service_account_workspace_member",
"workspace_id": "workspace_id",
"workspace_role": "workspace_admin"
}
```
##### Returns Examples
Response 200
```python
{
"created_by_actor_id": "created_by_actor_id",
"implicit": true,
"service_account_id": "service_account_id",
"type": "service_account_workspace_member",
"workspace_id": "workspace_id",
"workspace_role": "workspace_admin"
---
## List Workspaces For Service Account - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/service_accounts/workspaces/list
Path: 04-API-Reference/Admin/beta-organization-service-accounts-workspaces-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fservice_accounts%2Fworkspaces%2Flist)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Create Service Account
List Service Accounts
Get Service Account
Update Service Account
Archive Service Account
Workspaces
Add Workspace To Service Account
List Workspaces For Service Account
Remove Workspace From Service Account
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Service Accounts](https://platform.claude.com/docs/en/api/http/beta/organization/service_accounts)
5. [Workspaces](https://platform.claude.com/docs/en/api/http/beta/organization/service_accounts/workspaces)
# List Workspaces For Service Account
Copy page
cURL
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](../Other/manage-claude-wif-admin-api.md).
List the workspaces a service account is a member of.
Each entry includes the service account's `workspace_role` in that workspace. Use `limit` and the `next_page` cursor to paginate. When the service account has no explicit default-workspace membership, the implicit (`implicit: true`) membership is returned as the first entry on the first page; with `limit=1` the first page may return up to 2 entries (the implicit entry plus one explicit membership) so a pagination cursor can be derived. Memberships are returned only while the service account is active. Without a `page` cursor, an archived service account returns an empty list. A `page` cursor that does not match an active membership returns a 400 invalid-request error. A cursor stops matching when the membership is removed, the workspace is deleted, or the service account is archived. Restart pagination from the first page to recover.
##### Path parameters
service_account_id: string
ID of the service account.
##### Query parameters
limit: optional number
Number of results per page.
default20
minimum1
maximum100
page: optional string
Opaque cursor from a previous response's `next_page`.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"anthropic-beta": optional array of [AnthropicBeta](../Endpoints/platform-claude-com-http-beta.md#anthropic_beta)
Optional header to specify the beta version(s) you want to use.
One of the following:
string
"message-batches-2024-09-24"
"prompt-caching-2024-07-31"
"computer-use-2024-10-22"
"computer-use-2025-01-24"
"pdfs-2024-09-25"
"token-counting-2024-11-01"
"token-efficient-tools-2025-02-19"
"output-128k-2025-02-19"
"files-api-2025-04-14"
"mcp-client-2025-04-04"
"mcp-client-2025-11-20"
"dev-full-thinking-2025-05-14"
"interleaved-thinking-2025-05-14"
"code-execution-2025-05-22"
"extended-cache-ttl-2025-04-11"
"context-1m-2025-08-07"
"context-management-2025-06-27"
"model-context-window-exceeded-2025-08-26"
"skills-2025-10-02"
"fast-mode-2026-02-01"
"output-300k-2026-03-24"
"user-profiles-2026-03-24"
"user-profiles-2026-08-18"
"user-profiles-2026-09-04"
"advisor-tool-2026-03-01"
"managed-agents-2026-04-01"
"cache-diagnosis-2026-04-07"
"dreaming-2026-04-21"
"thinking-token-count-2026-05-13"
"server-side-fallback-2026-06-01"
"server-side-fallback-2026-07-01"
"fallback-credit-2026-06-01"
"fallback-credit-2026-07-01"
"agent-memory-2026-07-22"
"mid-conversation-tool-changes-2026-07-01"
"compact-2026-01-12"
"computer-use-2025-11-24"
"mcp-tunnels-2026-06-22"
"structured-outputs-2025-11-13"
"task-budgets-2026-03-13"
"thinking-display-updates-2026-08-18"
"ce-user-management-2026-07-13"
"mid-conversation-output-config-2026-07-01"
"thinking-binding-controls-2026-08-01"
"mid-conversation-system-clear-at-2026-08-21"
"compact-2026-09-04"
"inline-tools-2026-09-15"
"mcp-client-2026-09-15"
"ce-plugins-2026-09-01"
"spend-limit-reads-2026-09-26"
"telemetry-destinations-2026-08-11"
"webhooks-2026-10-07"
##### Returns
data: array of [BetaServiceAccountWorkspaceMember](https://platform.claude.com/docs/en/api/http/beta/organization/service_accounts#beta_service_account_workspace_member) { type: "service_account_workspace_member", created_by_actor_id, implicit, 3 more }
type: "service_account_workspace_member"
defaultservice_account_workspace_member
created_by_actor_id: string or null
Tagged ID (`user_...`/`svac_...`) of the actor who created this membership.
implicit: boolean or null
True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed.
service_account_id: string
Tagged service account ID (`svac_...`).
workspace_id: string
Tagged workspace ID (`wrkspc_...`).
workspace_role: [BetaWorkspaceRole](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces#beta_workspace_role)
Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role.
One of the following:
"workspace_admin"
"workspace_billing"
"workspace_developer"
"workspace_restricted_developer"
"workspace_user"
next_page: string or null
Opaque cursor for the next page, or null if no more results.
List Workspaces For Service Account
cURL
```python
curl https://api.anthropic.com/v1/organizations/service_accounts/$SERVICE_ACCOUNT_ID/workspaces \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"data": [
{
"created_by_actor_id": "created_by_actor_id",
"implicit": true,
"service_account_id": "service_account_id",
"type": "service_account_workspace_member",
"workspace_id": "workspace_id",
"workspace_role": "workspace_admin"
}
],
"next_page": "next_page"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"created_by_actor_id": "created_by_actor_id",
"implicit": true,
"service_account_id": "service_account_id",
"type": "service_account_workspace_member",
"workspace_id": "workspace_id",
"workspace_role": "workspace_admin"
---
## Remove Workspace From Service Account - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/service_accounts/workspaces/remove
Path: 04-API-Reference/Admin/beta-organization-service-accounts-workspaces-remove.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fservice_accounts%2Fworkspaces%2Fremove)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Create Service Account
List Service Accounts
Get Service Account
Update Service Account
Archive Service Account
Workspaces
Add Workspace To Service Account
List Workspaces For Service Account
Remove Workspace From Service Account
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Service Accounts](https://platform.claude.com/docs/en/api/http/beta/organization/service_accounts)
5. [Workspaces](https://platform.claude.com/docs/en/api/http/beta/organization/service_accounts/workspaces)
# Remove Workspace From Service Account
Copy page
cURL
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](../Other/manage-claude-wif-admin-api.md).
Remove a service account from a workspace.
Mirror of `DELETE /workspaces/{workspace_id}/service_accounts/{service_account_id}`, addressed from the service-account side. Removal is idempotent (returns 200 even if the membership was already removed). A DELETE against the implicit default-workspace membership returns 200 but is a no-op and the membership persists; deleting an explicit default-workspace row reverts to the implicit `workspace_user` membership. Archived workspaces return 400.
##### Path parameters
service_account_id: string
ID of the service account.
workspace_id: string
ID of the workspace.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"anthropic-beta": optional array of [AnthropicBeta](../Endpoints/platform-claude-com-http-beta.md#anthropic_beta)
Optional header to specify the beta version(s) you want to use.
One of the following:
string
"message-batches-2024-09-24"
"prompt-caching-2024-07-31"
"computer-use-2024-10-22"
"computer-use-2025-01-24"
"pdfs-2024-09-25"
"token-counting-2024-11-01"
"token-efficient-tools-2025-02-19"
"output-128k-2025-02-19"
"files-api-2025-04-14"
"mcp-client-2025-04-04"
"mcp-client-2025-11-20"
"dev-full-thinking-2025-05-14"
"interleaved-thinking-2025-05-14"
"code-execution-2025-05-22"
"extended-cache-ttl-2025-04-11"
"context-1m-2025-08-07"
"context-management-2025-06-27"
"model-context-window-exceeded-2025-08-26"
"skills-2025-10-02"
"fast-mode-2026-02-01"
"output-300k-2026-03-24"
"user-profiles-2026-03-24"
"user-profiles-2026-08-18"
"user-profiles-2026-09-04"
"advisor-tool-2026-03-01"
"managed-agents-2026-04-01"
"cache-diagnosis-2026-04-07"
"dreaming-2026-04-21"
"thinking-token-count-2026-05-13"
"server-side-fallback-2026-06-01"
"server-side-fallback-2026-07-01"
"fallback-credit-2026-06-01"
"fallback-credit-2026-07-01"
"agent-memory-2026-07-22"
"mid-conversation-tool-changes-2026-07-01"
"compact-2026-01-12"
"computer-use-2025-11-24"
"mcp-tunnels-2026-06-22"
"structured-outputs-2025-11-13"
"task-budgets-2026-03-13"
"thinking-display-updates-2026-08-18"
"ce-user-management-2026-07-13"
"mid-conversation-output-config-2026-07-01"
"thinking-binding-controls-2026-08-01"
"mid-conversation-system-clear-at-2026-08-21"
"compact-2026-09-04"
"inline-tools-2026-09-15"
"mcp-client-2026-09-15"
"ce-plugins-2026-09-01"
"spend-limit-reads-2026-09-26"
"telemetry-destinations-2026-08-11"
"webhooks-2026-10-07"
##### Returns
type: "service_account_workspace_member_deleted"
defaultservice_account_workspace_member_deleted
service_account_id: string
Tagged service account ID (`svac_...`) named in the delete request. Removal is idempotent; see the endpoint description for the implicit-membership no-op.
workspace_id: string
Tagged workspace ID (`wrkspc_...`) named in the delete request.
Remove Workspace From Service Account
cURL
```python
curl https://api.anthropic.com/v1/organizations/service_accounts/$SERVICE_ACCOUNT_ID/workspaces/$WORKSPACE_ID \
-X DELETE \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"service_account_id": "service_account_id",
"type": "service_account_workspace_member_deleted",
"workspace_id": "workspace_id"
}
```
##### Returns Examples
Response 200
```python
{
"service_account_id": "service_account_id",
"type": "service_account_workspace_member_deleted",
"workspace_id": "workspace_id"
---
## Workspaces - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/service_accounts/workspaces
Path: 04-API-Reference/Admin/beta-organization-service-accounts-workspaces.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fservice_accounts%2Fworkspaces)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Create Service Account
List Service Accounts
Get Service Account
Update Service Account
Archive Service Account
Workspaces
Add Workspace To Service Account
List Workspaces For Service Account
Remove Workspace From Service Account
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Service Accounts](https://platform.claude.com/docs/en/api/http/beta/organization/service_accounts)
# Workspaces
Copy page
cURL
##### [Add Workspace To Service Account](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [List Workspaces For Service Account](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [Remove Workspace From Service Account](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### Models
WorkspaceRemoveResponse object{ type: "service_account_workspace_member_deleted", service_account_id, workspace_id }
type: "service_account_workspace_member_deleted"
defaultservice_account_workspace_member_deleted
service_account_id: string
Tagged service account ID (`svac_...`) named in the delete request. Removal is idempotent; see the endpoint description for the implicit-membership no-op.
workspace_id: string
Tagged workspace ID (`wrkspc_...`) named in the delete request.
---
## Service Accounts - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/service_accounts
Path: 04-API-Reference/Admin/beta-organization-service-accounts.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fservice_accounts)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Create Service Account
List Service Accounts
Get Service Account
Update Service Account
Archive Service Account
Workspaces
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
# Service Accounts
Copy page
cURL
##### [Create Service Account](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [List Service Accounts](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [Get Service Account](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [Update Service Account](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [Archive Service Account](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### Models
BetaServiceAccount object{ type: "service_account", id, archived_at, 8 more }
Named non-human identity within the caller's organization.
A service account is a pure identity: name + org. Authorization lives on whatever references it (federation rules).
BetaServiceAccountWorkspaceMember object{ type: "service_account_workspace_member", created_by_actor_id, implicit, 3 more }
type: "service_account_workspace_member"
defaultservice_account_workspace_member
created_by_actor_id: string or null
Tagged ID (`user_...`/`svac_...`) of the actor who created this membership.
implicit: boolean or null
True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed.
service_account_id: string
Tagged service account ID (`svac_...`).
workspace_id: string
Tagged workspace ID (`wrkspc_...`).
workspace_role: [BetaWorkspaceRole](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces#beta_workspace_role)
Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role.
One of the following:
"workspace_admin"
"workspace_billing"
"workspace_developer"
"workspace_restricted_developer"
"workspace_user"
#### Service Accounts[Workspaces](https://platform.claude.com/docs/en/api/http/beta/organization/service_accounts/workspaces)
##### [Add Workspace To Service Account](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [List Workspaces For Service Account](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [Remove Workspace From Service Account](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
---
## Set Spend Limit - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/spend_limits/create
Path: 04-API-Reference/Admin/beta-organization-spend-limits-create.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fspend_limits%2Fcreate)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
Set Spend Limit
Get Spend Limit
Delete Spend Limit
List Effective Spend Limits
Increase Requests
RBAC Groups
RBAC Roles
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Spend Limits](https://platform.claude.com/docs/en/api/http/beta/organization/spend_limits)
# Set Spend Limit
POST/v1/organizations/spend_limits
Set a spend limit.
Upsert keyed on (scope, period): setting a limit that already exists overwrites it in place. A Claude Enterprise organization sets `user` limits. Its seat-tier, group, and organization-level defaults are configured in claude.ai. A Claude Console organization sets `organization` and `workspace` limits, which are monthly and always carry an amount. Setting those limits is in an early access preview. To request access, contact your Anthropic account team.
##### Body
amount: string or null
Limit amount as a non-negative integer decimal string in the minor unit of the organization's billing currency (cents for USD): "50000" is \$500.00. `null` sets an explicit no-limit override for this scope and `period` only — each period resolves independently, so caps for other periods still apply.
scope: User or Organization or Workspace
What the limit applies to. Claude Enterprise organizations set `user` limits. Claude Console organizations set `organization` and `workspace` limits. Any other combination returns 400. Setting `organization` and `workspace` limits through the API is in an early access preview. To request access, contact your Anthropic account team.
One of the following:
User object{ type: "user", user_id }
Scope selecting a single member of the organization.
type: "user"
Scope type. Always `user` for this scope.
defaultuser
user_id: string
Tagged ID of the member the spend limit applies to.
Organization object{ type: "organization" }
type: "organization"
defaultorganization
Workspace object{ type: "workspace", workspace_id }
Scope selecting one workspace of a Claude Console organization.
type: "workspace"
Scope type. Always `workspace` for this scope.
defaultworkspace
workspace_id: string
Tagged ID of the workspace the spend limit applies to.
period: optional "daily" or "monthly" or "weekly"
One of the following:
"daily"
"monthly"
"weekly"
##### Returns
BetaSpendLimit object{ type: "spend_limit", id, amount, 5 more }
A configured spend limit: a cap on metered spend for one scope and period.
Set Spend Limit
cURL
```python
curl https://api.anthropic.com/v1/organizations/spend_limits \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY" \
-d '{
"amount": "50000",
"scope": {
"type": "user",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"period": "monthly"
}'
```
Response 200
```python
{
"id": "id",
"amount": "50000",
"created_at": "2019-12-27T18:11:19.117Z",
"currency": "USD",
"period": "monthly",
"scope": {
"type": "user",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"type": "spend_limit",
"updated_at": "2019-12-27T18:11:19.117Z"
}
```
##### Returns Examples
Response 200
```python
{
"id": "id",
"amount": "50000",
"created_at": "2019-12-27T18:11:19.117Z",
"currency": "USD",
"period": "monthly",
"scope": {
"type": "user",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"type": "spend_limit",
"updated_at": "2019-12-27T18:11:19.117Z"
---
## Delete Spend Limit - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/spend_limits/delete
Path: 04-API-Reference/Admin/beta-organization-spend-limits-delete.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fspend_limits%2Fdelete)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
Set Spend Limit
Get Spend Limit
Delete Spend Limit
List Spend Limits
Effective
Increase Requests
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Spend Limits](https://platform.claude.com/docs/en/api/http/beta/organization/spend_limits)
# Delete Spend Limit
Copy page
cURL
DELETE/v1/organizations/spend_limits/{spend_limit_id}
Delete a spend limit.
For a Claude Enterprise organization, this deletes a per-user override, and the member falls back to any inherited spend limit at that period. Its seat-tier, group, and organization-level rows cannot be deleted via this endpoint. A Claude Console organization deletes its organization and workspace limits, but not its `usage_tier` limit. Deleting organization and workspace limits through the API is in an early access preview.
##### Path parameters
spend_limit_id: string
ID of the Spend Limit.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
##### Returns
type: "spend_limit_deleted"
defaultspend_limit_deleted
id: string
Delete Spend Limit
cURL
```python
curl https://api.anthropic.com/v1/organizations/spend_limits/$SPEND_LIMIT_ID \
-X DELETE \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
---
## List Effective Spend Limits - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/spend_limits/effective/list
Path: 04-API-Reference/Admin/beta-organization-spend-limits-effective-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fspend_limits%2Feffective%2Flist)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
Set Spend Limit
Get Spend Limit
Delete Spend Limit
List Spend Limits
Effective
List Effective Spend Limits
Increase Requests
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Spend Limits](https://platform.claude.com/docs/en/api/http/beta/organization/spend_limits)
5. [Effective](https://platform.claude.com/docs/en/api/http/beta/organization/spend_limits/effective)
# List Effective Spend Limits
Copy page
cURL
GET/v1/organizations/spend_limits/effective
List each member's effective spend limit and period-to-date spend.
Returns one row per (member, period) the member resolves a spend limit for, with the `source` scope the spend limit was inherited from. Paginates by member, so a member's periods never split across pages. Supported for Claude Enterprise organizations only, not for Claude Console organizations.
##### Query parameters
limit: optional number
Maximum number of members per page. A member's period rows never split across pages, so a page may carry more rows than this. Defaults to `20`.
default20
minimum1
maximum1000
page: optional string
Opaque cursor from a previous response's `next_page` field.
period: optional array of "daily" or "monthly" or "weekly"
Restrict the report to these limit periods. Omit to return one row per period each member resolves a spend limit for.
maxItems3
One of the following:
"daily"
"monthly"
"weekly"
user_ids: optional array of string
Restrict the report to these members, by tagged user ID (`user_...`). At most 100 entries.
maxItems100
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
##### Returns
data: array of [BetaSpendSummary](https://platform.claude.com/docs/en/api/http/beta/organization/spend_limits#beta_spend_summary) { actor, amount, currency, 5 more }
actor: [BetaSpendLimitUserActor](https://platform.claude.com/docs/en/api/http/beta/organization/spend_limits#beta_spend_limit_user_actor) or [BetaSpendLimitScopedAPIKeyActor](https://platform.claude.com/docs/en/api/http/beta/organization/spend_limits#beta_spend_limit_scoped_api_key_actor)
One of the following:
BetaSpendLimitUserActor object{ type: "user_actor", deleted, email_address, 2 more }
A user within the organization. `name` and `email_address` are null when the underlying account is unavailable or has been deleted; `deleted` is true only for deleted accounts.
type: "user_actor"
Actor type. Always `user_actor`.
defaultuser_actor
deleted: boolean
True only when the underlying account has been deleted.
defaultfalse
email_address: string or null
The user's email address. Null when the account is unavailable or has been deleted.
name: string or null
The user's current display name. Null when the account is unavailable, has been deleted, or has no name set.
user_id: string
Tagged ID of the user.
BetaSpendLimitScopedAPIKeyActor object{ type: "scoped_api_key_actor", scoped_api_key_id }
A scoped Admin API key acting on behalf of the organization.
type: "scoped_api_key_actor"
defaultscoped_api_key_actor
scoped_api_key_id: string
amount: string or null
Effective limit amount as a non-negative integer decimal string in the minor unit of `currency` (cents for USD). `null` means no limit applies for this row's `period` — each period resolves independently, so another period may still cap this member.
currency: string
ISO 4217 code of the organization's billing currency; the unit for `amount` and `period_to_date_spend`.
period: [BetaSpendLimitPeriod](https://platform.claude.com/docs/en/api/http/beta/organization/spend_limits#beta_spend_limit_period)
Period this row's effective limit and spend are reported for.
One of the following:
"daily"
"monthly"
"weekly"
period_to_date_spend: string
The member's spend so far in the current period, as a non-negative decimal string in the minor unit of `currency` (cents for USD). May carry fractional minor units up to three decimal places (e.g. `"12050.5"`) — metered usage is not rounded to whole cents. Reads as `"0"` when the spend reading is temporarily unavailable.
scope: [BetaSpendLimitUserScope](https://platform.claude.com/docs/en/api/http/beta/organization/spend_limits#beta_spend_limit_user_scope) or [BetaSpendLimitSeatTierScope](https://platform.claude.com/docs/en/api/http/beta/organization/spend_limits#beta_spend_limit_seat_tier_scope) or [BetaSpendLimitRBACGroupScope](https://platform.claude.com/docs/en/api/http/beta/organization/spend_limits#beta_spend_limit_rbac_group_scope) or 4 more
One of the following:
BetaSpendLimitUserScope object{ type: "user", user_id }
Scope selecting a single member of the organization.
type: "user"
Scope type. Always `user` for this scope.
defaultuser
user_id: string
Tagged ID of the member the spend limit applies to.
BetaSpendLimitSeatTierScope object{ type: "seat_tier", seat_tier }
type: "seat_tier"
defaultseat_tier
seat_tier: string
BetaSpendLimitRBACGroupScope object{ type: "rbac_group", rbac_group_id }
type: "rbac_group"
defaultrbac_group
rbac_group_id: string
BetaSpendLimitOrganizationServiceScope object{ type: "organization_service", service }
type: "organization_service"
defaultorganization_service
service: string
BetaSpendLimitOrganizationScope object{ type: "organization" }
type: "organization"
defaultorganization
BetaSpendLimitWorkspaceScope object{ type: "workspace", workspace_id }
Scope selecting one workspace of a Claude Console organization.
type: "workspace"
Scope type. Always `workspace` for this scope.
defaultworkspace
workspace_id: string
Tagged ID of the workspace the spend limit applies to.
BetaSpendLimitUsageTierScope object{ type: "usage_tier" }
Scope of the monthly spend cap Anthropic sets for a Claude Console organization from its usage tier, or a higher cap Anthropic granted the organization. Read-only; its `created_at` and `updated_at` are the organization's creation time, so `amount` can change while `updated_at` stays the same.
type: "usage_tier"
Scope type. Always `usage_tier` for this scope.
defaultusage_tier
source: [BetaSpendLimitUserScope](https://platform.claude.com/docs/en/api/http/beta/organization/spend_limits#beta_spend_limit_user_scope) or [BetaSpendLimitSeatTierScope](https://platform.claude.com/docs/en/api/http/beta/organization/spend_limits#beta_spend_limit_seat_tier_scope) or [BetaSpendLimitRBACGroupScope](https://platform.claude.com/docs/en/api/http/beta/organization/spend_limits#beta_spend_limit_rbac_group_scope) or 4 more
One of the following:
BetaSpendLimitUserScope object{ type: "user", user_id }
Scope selecting a single member of the organization.
type: "user"
Scope type. Always `user` for this scope.
defaultuser
user_id: string
Tagged ID of the member the spend limit applies to.
BetaSpendLimitSeatTierScope object{ type: "seat_tier", seat_tier }
type: "seat_tier"
defaultseat_tier
seat_tier: string
BetaSpendLimitRBACGroupScope object{ type: "rbac_group", rbac_group_id }
type: "rbac_group"
defaultrbac_group
rbac_group_id: string
BetaSpendLimitOrganizationServiceScope object{ type: "organization_service", service }
type: "organization_service"
defaultorganization_service
service: string
BetaSpendLimitOrganizationScope object{ type: "organization" }
type: "organization"
defaultorganization
BetaSpendLimitWorkspaceScope object{ type: "workspace", workspace_id }
Scope selecting one workspace of a Claude Console organization.
type: "workspace"
Scope type. Always `workspace` for this scope.
defaultworkspace
workspace_id: string
Tagged ID of the workspace the spend limit applies to.
BetaSpendLimitUsageTierScope object{ type: "usage_tier" }
Scope of the monthly spend cap Anthropic sets for a Claude Console organization from its usage tier, or a higher cap Anthropic granted the organization. Read-only; its `created_at` and `updated_at` are the organization's creation time, so `amount` can change while `updated_at` stays the same.
type: "usage_tier"
Scope type. Always `usage_tier` for this scope.
defaultusage_tier
spend_limit_id: string
next_page: string or null
List Effective Spend Limits
cURL
```python
curl https://api.anthropic.com/v1/organizations/spend_limits/effective \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"data": [
{
"actor": {
"deleted": true,
"email_address": "email_address",
"name": "name",
"type": "user_actor",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"amount": "50000",
"currency": "USD",
"period": "daily",
"period_to_date_spend": "12050.5",
"scope": {
"type": "user",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"source": {
"type": "user",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"spend_limit_id": "spend_limit_id"
}
],
"next_page": "next_page"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"actor": {
"deleted": true,
"email_address": "email_address",
"name": "name",
"type": "user_actor",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"amount": "50000",
"currency": "USD",
"period": "daily",
"period_to_date_spend": "12050.5",
"scope": {
"type": "user",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"source": {
"type": "user",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"spend_limit_id": "spend_limit_id"
---
## Effective - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/spend_limits/effective
Path: 04-API-Reference/Admin/beta-organization-spend-limits-effective.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fspend_limits%2Feffective)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
Set Spend Limit
Get Spend Limit
Delete Spend Limit
List Spend Limits
Effective
List Effective Spend Limits
Increase Requests
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Spend Limits](https://platform.claude.com/docs/en/api/http/beta/organization/spend_limits)
# Effective
Copy page
cURL
##### [List Effective Spend Limits](https://platform.claude.com/docs/en/api/http/beta/organization/spend_limits/effective/list)
GET/v1/organizations/spend_limits/effective
List each member's effective spend limit and period-to-date spend.
---
## Approve Spend Limit Increase Request - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/spend_limits/increase_requests/approve
Path: 04-API-Reference/Admin/beta-organization-spend-limits-increase-requests-approve.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fspend_limits%2Fincrease_requests%2Fapprove)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
Set Spend Limit
Get Spend Limit
Delete Spend Limit
List Spend Limits
Effective
Increase Requests
List Spend Limit Increase Requests
Get Spend Limit Increase Request
Approve Spend Limit Increase Request
Deny Spend Limit Increase Request
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Spend Limits](https://platform.claude.com/docs/en/api/http/beta/organization/spend_limits)
5. [Increase Requests](https://platform.claude.com/docs/en/api/http/beta/organization/spend_limits/increase_requests)
# Approve Spend Limit Increase Request
Copy page
cURL
POST/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}/approve
Approve a pending spend limit increase request.
Writes a per-user spend limit at `amount` for the requester and transitions the request to `approved`. `period` defaults to the period the member was blocked on. Anthropic emails the requester unless `suppress_notification` is set.
##### Path parameters
spend_limit_increase_request_id: string
ID of the spend limit increase request.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
##### Body
amount: string
New per-user spend limit as a non-negative integer decimal string (minor units).
period: optional [BetaSpendLimitPeriod](https://platform.claude.com/docs/en/api/http/beta/organization/spend_limits#beta_spend_limit_period) or null
One of the following:
"daily"
"monthly"
"weekly"
suppress_notification: optional boolean
##### Returns
type: "spend_limit_increase_request"
defaultspend_limit_increase_request
id: string
actor: [BetaSpendLimitUserActor](https://platform.claude.com/docs/en/api/http/beta/organization/spend_limits#beta_spend_limit_user_actor) or [BetaSpendLimitScopedAPIKeyActor](https://platform.claude.com/docs/en/api/http/beta/organization/spend_limits#beta_spend_limit_scoped_api_key_actor)
One of the following:
BetaSpendLimitUserActor object{ type: "user_actor", deleted, email_address, 2 more }
A user within the organization. `name` and `email_address` are null when the underlying account is unavailable or has been deleted; `deleted` is true only for deleted accounts.
type: "user_actor"
Actor type. Always `user_actor`.
defaultuser_actor
deleted: boolean
True only when the underlying account has been deleted.
defaultfalse
email_address: string or null
The user's email address. Null when the account is unavailable or has been deleted.
name: string or null
The user's current display name. Null when the account is unavailable, has been deleted, or has no name set.
user_id: string
Tagged ID of the user.
BetaSpendLimitScopedAPIKeyActor object{ type: "scoped_api_key_actor", scoped_api_key_id }
A scoped Admin API key acting on behalf of the organization.
type: "scoped_api_key_actor"
defaultscoped_api_key_actor
scoped_api_key_id: string
created_at: string
formatdate-time
period: [BetaSpendLimitPeriod](https://platform.claude.com/docs/en/api/http/beta/organization/spend_limits#beta_spend_limit_period)
One of the following:
"daily"
"monthly"
"weekly"
resolved_at: string or null
formatdate-time
resolved_by: [BetaSpendLimitUserActor](https://platform.claude.com/docs/en/api/http/beta/organization/spend_limits#beta_spend_limit_user_actor) or [BetaSpendLimitScopedAPIKeyActor](https://platform.claude.com/docs/en/api/http/beta/organization/spend_limits#beta_spend_limit_scoped_api_key_actor) or null
One of the following:
BetaSpendLimitUserActor object{ type: "user_actor", deleted, email_address, 2 more }
A user within the organization. `name` and `email_address` are null when the underlying account is unavailable or has been deleted; `deleted` is true only for deleted accounts.
type: "user_actor"
Actor type. Always `user_actor`.
defaultuser_actor
deleted: boolean
True only when the underlying account has been deleted.
defaultfalse
email_address: string or null
The user's email address. Null when the account is unavailable or has been deleted.
name: string or null
The user's current display name. Null when the account is unavailable, has been deleted, or has no name set.
user_id: string
Tagged ID of the user.
BetaSpendLimitScopedAPIKeyActor object{ type: "scoped_api_key_actor", scoped_api_key_id }
A scoped Admin API key acting on behalf of the organization.
type: "scoped_api_key_actor"
defaultscoped_api_key_actor
scoped_api_key_id: string
spend_limit: [BetaSpendLimit](https://platform.claude.com/docs/en/api/http/beta/organization/spend_limits#beta_spend_limit) { type: "spend_limit", id, amount, 6 more }
A configured spend limit: a cap on metered spend for one scope and period.
spend_summary: [BetaSpendSummary](https://platform.claude.com/docs/en/api/http/beta/organization/spend_limits#beta_spend_summary) { actor, amount, currency, 5 more } or null
Per-member effective-limit report row (`GET /spend_limits/effective`).
status: [BetaSpendLimitIncreaseRequestStatus](https://platform.claude.com/docs/en/api/http/beta/organization/spend_limits/increase_requests#beta_spend_limit_increase_request_status)
One of the following:
"approved"
"denied"
"pending"
Approve Spend Limit Increase Request
cURL
```python
curl https://api.anthropic.com/v1/organizations/spend_limit_increase_requests/$SPEND_LIMIT_INCREASE_REQUEST_ID/approve \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY" \
-d '{
"amount": "50000",
"period": "monthly"
}'
```
Response 200
```python
{
"id": "id",
"actor": {
"deleted": true,
"email_address": "email_address",
"name": "name",
"type": "user_actor",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"created_at": "2019-12-27T18:11:19.117Z",
"period": "daily",
"resolved_at": "2019-12-27T18:11:19.117Z",
"resolved_by": {
"deleted": true,
"email_address": "email_address",
"name": "name",
"type": "user_actor",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"spend_limit": {
"id": "id",
"amount": "50000",
"created_at": "2019-12-27T18:11:19.117Z",
"currency": "USD",
"is_enabled": true,
"period": "daily",
"scope": {
"type": "user",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"type": "spend_limit",
"updated_at": "2019-12-27T18:11:19.117Z"
},
"spend_summary": {
"actor": {
"deleted": true,
"email_address": "email_address",
"name": "name",
"type": "user_actor",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"amount": "50000",
"currency": "USD",
"period": "daily",
"period_to_date_spend": "12050.5",
"scope": {
"type": "user",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"source": {
"type": "user",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"spend_limit_id": "spend_limit_id"
},
"status": "approved",
"type": "spend_limit_increase_request"
}
```
##### Returns Examples
Response 200
```python
{
"id": "id",
"actor": {
"deleted": true,
"email_address": "email_address",
"name": "name",
"type": "user_actor",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"created_at": "2019-12-27T18:11:19.117Z",
"period": "daily",
"resolved_at": "2019-12-27T18:11:19.117Z",
"resolved_by": {
"deleted": true,
"email_address": "email_address",
"name": "name",
"type": "user_actor",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"spend_limit": {
"id": "id",
"amount": "50000",
"created_at": "2019-12-27T18:11:19.117Z",
"currency": "USD",
"is_enabled": true,
"period": "daily",
"scope": {
"type": "user",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"type": "spend_limit",
"updated_at": "2019-12-27T18:11:19.117Z"
},
"spend_summary": {
"actor": {
"deleted": true,
"email_address": "email_address",
"name": "name",
"type": "user_actor",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"amount": "50000",
"currency": "USD",
"period": "daily",
"period_to_date_spend": "12050.5",
"scope": {
"type": "user",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"source": {
"type": "user",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"spend_limit_id": "spend_limit_id"
},
"status": "approved",
"type": "spend_limit_increase_request"
---
## Deny Spend Limit Increase Request - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/spend_limits/increase_requests/deny
Path: 04-API-Reference/Admin/beta-organization-spend-limits-increase-requests-deny.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fspend_limits%2Fincrease_requests%2Fdeny)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
Set Spend Limit
Get Spend Limit
Delete Spend Limit
List Spend Limits
Effective
Increase Requests
List Spend Limit Increase Requests
Get Spend Limit Increase Request
Approve Spend Limit Increase Request
Deny Spend Limit Increase Request
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Spend Limits](https://platform.claude.com/docs/en/api/http/beta/organization/spend_limits)
5. [Increase Requests](https://platform.claude.com/docs/en/api/http/beta/organization/spend_limits/increase_requests)
# Deny Spend Limit Increase Request
Copy page
cURL
POST/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}/deny
Deny a pending spend limit increase request.
Idempotent on `denied`; denying an already-`approved` request returns 400. Anthropic emails the requester unless `suppress_notification` is set.
##### Path parameters
spend_limit_increase_request_id: string
ID of the spend limit increase request.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
##### Body
suppress_notification: optional boolean
##### Returns
BetaSpendLimitIncreaseRequest object{ type: "spend_limit_increase_request", id, actor, 6 more }
Deny Spend Limit Increase Request
cURL
```python
curl https://api.anthropic.com/v1/organizations/spend_limit_increase_requests/$SPEND_LIMIT_INCREASE_REQUEST_ID/deny \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY" \
-d '{}'
```
Response 200
```python
{
"id": "id",
"actor": {
"deleted": true,
"email_address": "email_address",
"name": "name",
"type": "user_actor",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"created_at": "2019-12-27T18:11:19.117Z",
"period": "daily",
"resolved_at": "2019-12-27T18:11:19.117Z",
"resolved_by": {
"deleted": true,
"email_address": "email_address",
"name": "name",
"type": "user_actor",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"spend_summary": {
"actor": {
"deleted": true,
"email_address": "email_address",
"name": "name",
"type": "user_actor",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"amount": "50000",
"currency": "USD",
"period": "daily",
"period_to_date_spend": "12050.5",
"scope": {
"type": "user",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"source": {
"type": "user",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"spend_limit_id": "spend_limit_id"
},
"status": "approved",
"type": "spend_limit_increase_request"
}
```
##### Returns Examples
Response 200
```python
{
"id": "id",
"actor": {
"deleted": true,
"email_address": "email_address",
"name": "name",
"type": "user_actor",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"created_at": "2019-12-27T18:11:19.117Z",
"period": "daily",
"resolved_at": "2019-12-27T18:11:19.117Z",
"resolved_by": {
"deleted": true,
"email_address": "email_address",
"name": "name",
"type": "user_actor",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"spend_summary": {
"actor": {
"deleted": true,
"email_address": "email_address",
"name": "name",
"type": "user_actor",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"amount": "50000",
"currency": "USD",
"period": "daily",
"period_to_date_spend": "12050.5",
"scope": {
"type": "user",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"source": {
"type": "user",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"spend_limit_id": "spend_limit_id"
},
"status": "approved",
"type": "spend_limit_increase_request"
---
## List Spend Limit Increase Requests - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/spend_limits/increase_requests/list
Path: 04-API-Reference/Admin/beta-organization-spend-limits-increase-requests-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fspend_limits%2Fincrease_requests%2Flist)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
Set Spend Limit
Get Spend Limit
Delete Spend Limit
List Spend Limits
Effective
Increase Requests
List Spend Limit Increase Requests
Get Spend Limit Increase Request
Approve Spend Limit Increase Request
Deny Spend Limit Increase Request
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Spend Limits](https://platform.claude.com/docs/en/api/http/beta/organization/spend_limits)
5. [Increase Requests](https://platform.claude.com/docs/en/api/http/beta/organization/spend_limits/increase_requests)
# List Spend Limit Increase Requests
Copy page
cURL
GET/v1/organizations/spend_limit_increase_requests
List spend limit increase requests, most recent first.
Pending requests include a live `spend_summary` for the requester. Requests whose requester is no longer a member are excluded.
##### Query parameters
actor_ids: optional array of string
Filter by requester, as `user_...` tagged IDs.
limit: optional number
default20
minimum1
maximum1000
page: optional string
Opaque cursor from a previous response's `next_page`.
status: optional array of [BetaSpendLimitIncreaseRequestStatus](https://platform.claude.com/docs/en/api/http/beta/organization/spend_limits/increase_requests#beta_spend_limit_increase_request_status)
Filter by status. Omit to return all.
One of the following:
"approved"
"denied"
"pending"
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
##### Returns
data: array of [BetaSpendLimitIncreaseRequest](https://platform.claude.com/docs/en/api/http/beta/organization/spend_limits/increase_requests#beta_spend_limit_increase_request) { type: "spend_limit_increase_request", id, actor, 6 more }
type: "spend_limit_increase_request"
defaultspend_limit_increase_request
id: string
actor: [BetaSpendLimitUserActor](https://platform.claude.com/docs/en/api/http/beta/organization/spend_limits#beta_spend_limit_user_actor) or [BetaSpendLimitScopedAPIKeyActor](https://platform.claude.com/docs/en/api/http/beta/organization/spend_limits#beta_spend_limit_scoped_api_key_actor)
One of the following:
BetaSpendLimitUserActor object{ type: "user_actor", deleted, email_address, 2 more }
A user within the organization. `name` and `email_address` are null when the underlying account is unavailable or has been deleted; `deleted` is true only for deleted accounts.
type: "user_actor"
Actor type. Always `user_actor`.
defaultuser_actor
deleted: boolean
True only when the underlying account has been deleted.
defaultfalse
email_address: string or null
The user's email address. Null when the account is unavailable or has been deleted.
name: string or null
The user's current display name. Null when the account is unavailable, has been deleted, or has no name set.
user_id: string
Tagged ID of the user.
BetaSpendLimitScopedAPIKeyActor object{ type: "scoped_api_key_actor", scoped_api_key_id }
A scoped Admin API key acting on behalf of the organization.
type: "scoped_api_key_actor"
defaultscoped_api_key_actor
scoped_api_key_id: string
created_at: string
formatdate-time
period: [BetaSpendLimitPeriod](https://platform.claude.com/docs/en/api/http/beta/organization/spend_limits#beta_spend_limit_period)
One of the following:
"daily"
"monthly"
"weekly"
resolved_at: string or null
formatdate-time
resolved_by: [BetaSpendLimitUserActor](https://platform.claude.com/docs/en/api/http/beta/organization/spend_limits#beta_spend_limit_user_actor) or [BetaSpendLimitScopedAPIKeyActor](https://platform.claude.com/docs/en/api/http/beta/organization/spend_limits#beta_spend_limit_scoped_api_key_actor) or null
One of the following:
BetaSpendLimitUserActor object{ type: "user_actor", deleted, email_address, 2 more }
A user within the organization. `name` and `email_address` are null when the underlying account is unavailable or has been deleted; `deleted` is true only for deleted accounts.
type: "user_actor"
Actor type. Always `user_actor`.
defaultuser_actor
deleted: boolean
True only when the underlying account has been deleted.
defaultfalse
email_address: string or null
The user's email address. Null when the account is unavailable or has been deleted.
name: string or null
The user's current display name. Null when the account is unavailable, has been deleted, or has no name set.
user_id: string
Tagged ID of the user.
BetaSpendLimitScopedAPIKeyActor object{ type: "scoped_api_key_actor", scoped_api_key_id }
A scoped Admin API key acting on behalf of the organization.
type: "scoped_api_key_actor"
defaultscoped_api_key_actor
scoped_api_key_id: string
spend_summary: [BetaSpendSummary](https://platform.claude.com/docs/en/api/http/beta/organization/spend_limits#beta_spend_summary) { actor, amount, currency, 5 more } or null
Per-member effective-limit report row (`GET /spend_limits/effective`).
status: [BetaSpendLimitIncreaseRequestStatus](https://platform.claude.com/docs/en/api/http/beta/organization/spend_limits/increase_requests#beta_spend_limit_increase_request_status)
One of the following:
"approved"
"denied"
"pending"
next_page: string or null
List Spend Limit Increase Requests
cURL
```python
curl https://api.anthropic.com/v1/organizations/spend_limit_increase_requests \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"data": [
{
"id": "id",
"actor": {
"deleted": true,
"email_address": "email_address",
"name": "name",
"type": "user_actor",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"created_at": "2019-12-27T18:11:19.117Z",
"period": "daily",
"resolved_at": "2019-12-27T18:11:19.117Z",
"resolved_by": {
"deleted": true,
"email_address": "email_address",
"name": "name",
"type": "user_actor",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"spend_summary": {
"actor": {
"deleted": true,
"email_address": "email_address",
"name": "name",
"type": "user_actor",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"amount": "50000",
"currency": "USD",
"period": "daily",
"period_to_date_spend": "12050.5",
"scope": {
"type": "user",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"source": {
"type": "user",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"spend_limit_id": "spend_limit_id"
},
"status": "approved",
"type": "spend_limit_increase_request"
}
],
"next_page": "next_page"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"id": "id",
"actor": {
"deleted": true,
"email_address": "email_address",
"name": "name",
"type": "user_actor",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"created_at": "2019-12-27T18:11:19.117Z",
"period": "daily",
"resolved_at": "2019-12-27T18:11:19.117Z",
"resolved_by": {
"deleted": true,
"email_address": "email_address",
"name": "name",
"type": "user_actor",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"spend_summary": {
"actor": {
"deleted": true,
"email_address": "email_address",
"name": "name",
"type": "user_actor",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"amount": "50000",
"currency": "USD",
"period": "daily",
"period_to_date_spend": "12050.5",
"scope": {
"type": "user",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"source": {
"type": "user",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"spend_limit_id": "spend_limit_id"
},
"status": "approved",
"type": "spend_limit_increase_request"
---
## Get Spend Limit Increase Request - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/spend_limits/increase_requests/retrieve
Path: 04-API-Reference/Admin/beta-organization-spend-limits-increase-requests-retrieve.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fspend_limits%2Fincrease_requests%2Fretrieve)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
Set Spend Limit
Get Spend Limit
Delete Spend Limit
List Spend Limits
Effective
Increase Requests
List Spend Limit Increase Requests
Get Spend Limit Increase Request
Approve Spend Limit Increase Request
Deny Spend Limit Increase Request
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Spend Limits](https://platform.claude.com/docs/en/api/http/beta/organization/spend_limits)
5. [Increase Requests](https://platform.claude.com/docs/en/api/http/beta/organization/spend_limits/increase_requests)
# Get Spend Limit Increase Request
Copy page
cURL
GET/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}
Retrieve a spend limit increase request.
While `pending`, the response includes a live `spend_summary` for the requester at the request's period.
##### Path parameters
spend_limit_increase_request_id: string
ID of the spend limit increase request.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
##### Returns
BetaSpendLimitIncreaseRequest object{ type: "spend_limit_increase_request", id, actor, 6 more }
Get Spend Limit Increase Request
cURL
```python
curl https://api.anthropic.com/v1/organizations/spend_limit_increase_requests/$SPEND_LIMIT_INCREASE_REQUEST_ID \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"id": "id",
"actor": {
"deleted": true,
"email_address": "email_address",
"name": "name",
"type": "user_actor",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"created_at": "2019-12-27T18:11:19.117Z",
"period": "daily",
"resolved_at": "2019-12-27T18:11:19.117Z",
"resolved_by": {
"deleted": true,
"email_address": "email_address",
"name": "name",
"type": "user_actor",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"spend_summary": {
"actor": {
"deleted": true,
"email_address": "email_address",
"name": "name",
"type": "user_actor",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"amount": "50000",
"currency": "USD",
"period": "daily",
"period_to_date_spend": "12050.5",
"scope": {
"type": "user",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"source": {
"type": "user",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"spend_limit_id": "spend_limit_id"
},
"status": "approved",
"type": "spend_limit_increase_request"
}
```
##### Returns Examples
Response 200
```python
{
"id": "id",
"actor": {
"deleted": true,
"email_address": "email_address",
"name": "name",
"type": "user_actor",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"created_at": "2019-12-27T18:11:19.117Z",
"period": "daily",
"resolved_at": "2019-12-27T18:11:19.117Z",
"resolved_by": {
"deleted": true,
"email_address": "email_address",
"name": "name",
"type": "user_actor",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"spend_summary": {
"actor": {
"deleted": true,
"email_address": "email_address",
"name": "name",
"type": "user_actor",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"amount": "50000",
"currency": "USD",
"period": "daily",
"period_to_date_spend": "12050.5",
"scope": {
"type": "user",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"source": {
"type": "user",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"spend_limit_id": "spend_limit_id"
},
"status": "approved",
"type": "spend_limit_increase_request"
---
## Increase Requests - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/spend_limits/increase_requests
Path: 04-API-Reference/Admin/beta-organization-spend-limits-increase-requests.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fspend_limits%2Fincrease_requests)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
Set Spend Limit
Get Spend Limit
Delete Spend Limit
List Spend Limits
Effective
Increase Requests
List Spend Limit Increase Requests
Get Spend Limit Increase Request
Approve Spend Limit Increase Request
Deny Spend Limit Increase Request
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Spend Limits](https://platform.claude.com/docs/en/api/http/beta/organization/spend_limits)
# Increase Requests
Copy page
cURL
##### [List Spend Limit Increase Requests](https://platform.claude.com/docs/en/api/http/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](https://platform.claude.com/docs/en/api/http/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](https://platform.claude.com/docs/en/api/http/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](https://platform.claude.com/docs/en/api/http/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.
##### Models
BetaSpendLimitIncreaseRequest object{ type: "spend_limit_increase_request", id, actor, 6 more }
BetaSpendLimitIncreaseRequestStatus = "approved" or "denied" or "pending"
One of the following:
"approved"
"denied"
"pending"
IncreaseRequestApproveResponse object{ type: "spend_limit_increase_request", id, actor, 7 more }
---
## List Effective Spend Limits - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/spend_limits/list_effective
Path: 04-API-Reference/Admin/beta-organization-spend-limits-list-effective.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fspend_limits%2Flist_effective)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
Set Spend Limit
Get Spend Limit
Delete Spend Limit
List Effective Spend Limits
Increase Requests
RBAC Groups
RBAC Roles
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Spend Limits](https://platform.claude.com/docs/en/api/http/beta/organization/spend_limits)
# List Effective Spend Limits
GET/v1/organizations/spend_limits/effective
List each member's effective spend limit and period-to-date spend.
Returns one row per (member, period) the member resolves a spend limit for, with the `source` scope the spend limit was inherited from. Paginates by member, so a member's periods never split across pages.
##### Query parameters
limit: optional number
Maximum number of members per page. A member's period rows never split across pages, so a page may carry more rows than this. Defaults to `20`.
default20
minimum1
maximum1000
page: optional string
Opaque cursor from a previous response's `next_page` field.
period: optional array of "daily" or "monthly" or "weekly"
Restrict the report to these limit periods. Omit to return one row per period each member resolves a spend limit for.
maxItems3
One of the following:
"daily"
"monthly"
"weekly"
user_ids: optional array of string
Restrict the report to these members, by tagged user ID (`user_...`). At most 100 entries.
maxItems100
##### Returns
data: array of [BetaSpendSummary](https://platform.claude.com/docs/en/api/http/beta/organization/spend_limits#beta_spend_summary) { actor, amount, currency, 5 more }
actor: UserActor or ScopedAPIKeyActor
One of the following:
UserActor object{ type: "user_actor", deleted, email_address, 2 more }
A user within the organization. `name` and `email_address` are null when the underlying account is unavailable or has been deleted; `deleted` is true only for deleted accounts.
type: "user_actor"
Actor type. Always `user_actor`.
defaultuser_actor
deleted: boolean
True only when the underlying account has been deleted.
defaultfalse
email_address: string or null
The user's email address. Null when the account is unavailable or has been deleted.
name: string or null
The user's current display name. Null when the account is unavailable, has been deleted, or has no name set.
user_id: string
Tagged ID of the user.
ScopedAPIKeyActor object{ type: "scoped_api_key_actor", scoped_api_key_id }
A scoped Admin API key acting on behalf of the organization.
type: "scoped_api_key_actor"
defaultscoped_api_key_actor
scoped_api_key_id: string
amount: string or null
Effective limit amount as a non-negative integer decimal string in the minor unit of `currency` (cents for USD). `null` means no limit applies for this row's `period` — each period resolves independently, so another period may still cap this member.
currency: string
ISO 4217 code of the organization's billing currency; the unit for `amount` and `period_to_date_spend`.
period: "daily" or "monthly" or "weekly"
Period this row's effective limit and spend are reported for.
One of the following:
"daily"
"monthly"
"weekly"
period_to_date_spend: string
The member's spend so far in the current period, as a non-negative decimal string in the minor unit of `currency` (cents for USD). May carry fractional minor units up to three decimal places (e.g. `"12050.5"`) — metered usage is not rounded to whole cents. Reads as `"0"` when the spend reading is temporarily unavailable.
scope: User or SeatTier or RBACGroup or 3 more
One of the following:
User object{ type: "user", user_id }
Scope selecting a single member of the organization.
type: "user"
Scope type. Always `user` for this scope.
defaultuser
user_id: string
Tagged ID of the member the spend limit applies to.
SeatTier object{ type: "seat_tier", seat_tier }
type: "seat_tier"
defaultseat_tier
seat_tier: string
RBACGroup object{ type: "rbac_group", rbac_group_id }
type: "rbac_group"
defaultrbac_group
rbac_group_id: string
OrganizationService object{ type: "organization_service", service }
type: "organization_service"
defaultorganization_service
service: string
Organization object{ type: "organization" }
type: "organization"
defaultorganization
Workspace object{ type: "workspace", workspace_id }
Scope selecting one workspace of a Claude Console organization.
type: "workspace"
Scope type. Always `workspace` for this scope.
defaultworkspace
workspace_id: string
Tagged ID of the workspace the spend limit applies to.
source: User or SeatTier or RBACGroup or 3 more
One of the following:
User object{ type: "user", user_id }
Scope selecting a single member of the organization.
type: "user"
Scope type. Always `user` for this scope.
defaultuser
user_id: string
Tagged ID of the member the spend limit applies to.
SeatTier object{ type: "seat_tier", seat_tier }
type: "seat_tier"
defaultseat_tier
seat_tier: string
RBACGroup object{ type: "rbac_group", rbac_group_id }
type: "rbac_group"
defaultrbac_group
rbac_group_id: string
OrganizationService object{ type: "organization_service", service }
type: "organization_service"
defaultorganization_service
service: string
Organization object{ type: "organization" }
type: "organization"
defaultorganization
Workspace object{ type: "workspace", workspace_id }
Scope selecting one workspace of a Claude Console organization.
type: "workspace"
Scope type. Always `workspace` for this scope.
defaultworkspace
workspace_id: string
Tagged ID of the workspace the spend limit applies to.
spend_limit_id: string
next_page: string or null
List Effective Spend Limits
cURL
```python
curl https://api.anthropic.com/v1/organizations/spend_limits/effective \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"data": [
{
"actor": {
"deleted": true,
"email_address": "email_address",
"name": "name",
"type": "user_actor",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"amount": "50000",
"currency": "USD",
"period": "monthly",
"period_to_date_spend": "12050.5",
"scope": {
"type": "user",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"source": {
"type": "user",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"spend_limit_id": "spend_limit_id"
}
],
"next_page": "next_page"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"actor": {
"deleted": true,
"email_address": "email_address",
"name": "name",
"type": "user_actor",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"amount": "50000",
"currency": "USD",
"period": "monthly",
"period_to_date_spend": "12050.5",
"scope": {
"type": "user",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"source": {
"type": "user",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"spend_limit_id": "spend_limit_id"
---
## List Spend Limits - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/spend_limits/list
Path: 04-API-Reference/Admin/beta-organization-spend-limits-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fspend_limits%2Flist)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
Set Spend Limit
Get Spend Limit
Delete Spend Limit
List Spend Limits
Effective
Increase Requests
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Spend Limits](https://platform.claude.com/docs/en/api/http/beta/organization/spend_limits)
# List Spend Limits
Copy page
cURL
GET/v1/organizations/spend_limits
List the organization's spend limits.
Limits are grouped by scope type, in the order `organization`, `seat_tier`, `rbac_group`, `organization_service`, `user`; within a type they come in a fixed order that is not creation order. Supported for Claude Enterprise organizations only, not for Claude Console organizations.
##### Query parameters
limit: optional number
Maximum number of limits per page. Defaults to `20`.
default20
minimum1
maximum1000
page: optional string
Opaque cursor from a previous response's `next_page` field.
scope_type: optional array of "organization" or "organization_service" or "rbac_group" or 3 more
Return only limits with these scope types. Omit for all.
maxItems100
One of the following:
"organization"
"organization_service"
"rbac_group"
"seat_tier"
"user"
"workspace"
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"anthropic-beta": optional array of [AnthropicBeta](../Endpoints/platform-claude-com-http-beta.md#anthropic_beta)
This endpoint is in beta: requests must send `spend-limit-reads-2026-09-26` in this header.
One of the following:
string
"message-batches-2024-09-24"
"prompt-caching-2024-07-31"
"computer-use-2024-10-22"
"computer-use-2025-01-24"
"pdfs-2024-09-25"
"token-counting-2024-11-01"
"token-efficient-tools-2025-02-19"
"output-128k-2025-02-19"
"files-api-2025-04-14"
"mcp-client-2025-04-04"
"mcp-client-2025-11-20"
"dev-full-thinking-2025-05-14"
"interleaved-thinking-2025-05-14"
"code-execution-2025-05-22"
"extended-cache-ttl-2025-04-11"
"context-1m-2025-08-07"
"context-management-2025-06-27"
"model-context-window-exceeded-2025-08-26"
"skills-2025-10-02"
"fast-mode-2026-02-01"
"output-300k-2026-03-24"
"user-profiles-2026-03-24"
"user-profiles-2026-08-18"
"user-profiles-2026-09-04"
"advisor-tool-2026-03-01"
"managed-agents-2026-04-01"
"cache-diagnosis-2026-04-07"
"dreaming-2026-04-21"
"thinking-token-count-2026-05-13"
"server-side-fallback-2026-06-01"
"server-side-fallback-2026-07-01"
"fallback-credit-2026-06-01"
"fallback-credit-2026-07-01"
"agent-memory-2026-07-22"
"mid-conversation-tool-changes-2026-07-01"
"compact-2026-01-12"
"computer-use-2025-11-24"
"mcp-tunnels-2026-06-22"
"structured-outputs-2025-11-13"
"task-budgets-2026-03-13"
"thinking-display-updates-2026-08-18"
"ce-user-management-2026-07-13"
"mid-conversation-output-config-2026-07-01"
"thinking-binding-controls-2026-08-01"
"mid-conversation-system-clear-at-2026-08-21"
"compact-2026-09-04"
"inline-tools-2026-09-15"
"mcp-client-2026-09-15"
"ce-plugins-2026-09-01"
"spend-limit-reads-2026-09-26"
"telemetry-destinations-2026-08-11"
##### Returns
data: array of [BetaSpendLimit](https://platform.claude.com/docs/en/api/http/beta/organization/spend_limits#beta_spend_limit) { type: "spend_limit", id, amount, 6 more }
type: "spend_limit"
Object type. Always `spend_limit`.
defaultspend_limit
id: string
Unique tagged ID of the spend limit (`spl_...`).
amount: string or null
Limit amount as a non-negative integer decimal string in the minor unit of `currency` (cents for USD): "50000" is \$500.00. `null` means no numeric cap is configured at this scope — see the effective report for whether a limit applies.
created_at: string
RFC 3339 datetime at which the spend limit was created.
formatdate-time
currency: string
ISO 4217 code of the organization's billing currency; the unit for `amount`.
is_enabled: boolean
Read-only. `false` when extra usage is switched off for this organization (`organization` limit); `amount` is kept and applies again when it's switched back on. Always `true` for other limits.
period: [BetaSpendLimitPeriod](https://platform.claude.com/docs/en/api/http/beta/organization/spend_limits#beta_spend_limit_period)
Length of the window the limit resets over. `amount` caps spend within each period.
One of the following:
"daily"
"monthly"
"weekly"
scope: [BetaSpendLimitUserScope](https://platform.claude.com/docs/en/api/http/beta/organization/spend_limits#beta_spend_limit_user_scope) or [BetaSpendLimitSeatTierScope](https://platform.claude.com/docs/en/api/http/beta/organization/spend_limits#beta_spend_limit_seat_tier_scope) or [BetaSpendLimitRBACGroupScope](https://platform.claude.com/docs/en/api/http/beta/organization/spend_limits#beta_spend_limit_rbac_group_scope) or 4 more
What the limit applies to. A tagged union on `type`; each variant carries the identifier for its scope.
One of the following:
BetaSpendLimitUserScope object{ type: "user", user_id }
Scope selecting a single member of the organization.
type: "user"
Scope type. Always `user` for this scope.
defaultuser
user_id: string
Tagged ID of the member the spend limit applies to.
BetaSpendLimitSeatTierScope object{ type: "seat_tier", seat_tier }
type: "seat_tier"
defaultseat_tier
seat_tier: string
BetaSpendLimitRBACGroupScope object{ type: "rbac_group", rbac_group_id }
type: "rbac_group"
defaultrbac_group
rbac_group_id: string
BetaSpendLimitOrganizationServiceScope object{ type: "organization_service", service }
type: "organization_service"
defaultorganization_service
service: string
BetaSpendLimitOrganizationScope object{ type: "organization" }
type: "organization"
defaultorganization
BetaSpendLimitWorkspaceScope object{ type: "workspace", workspace_id }
Scope selecting one workspace of a Claude Console organization.
type: "workspace"
Scope type. Always `workspace` for this scope.
defaultworkspace
workspace_id: string
Tagged ID of the workspace the spend limit applies to.
BetaSpendLimitUsageTierScope object{ type: "usage_tier" }
Scope of the monthly spend cap Anthropic sets for a Claude Console organization from its usage tier, or a higher cap Anthropic granted the organization. Read-only; its `created_at` and `updated_at` are the organization's creation time, so `amount` can change while `updated_at` stays the same.
type: "usage_tier"
Scope type. Always `usage_tier` for this scope.
defaultusage_tier
updated_at: string
RFC 3339 datetime at which the spend limit was last modified.
formatdate-time
next_page: string or null
List Spend Limits
cURL
```python
curl https://api.anthropic.com/v1/organizations/spend_limits \
-H 'anthropic-version: 2023-06-01' \
-H 'anthropic-beta: spend-limit-reads-2026-09-26' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"data": [
{
"id": "id",
"amount": "50000",
"created_at": "2019-12-27T18:11:19.117Z",
"currency": "USD",
"is_enabled": true,
"period": "daily",
"scope": {
"type": "user",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"type": "spend_limit",
"updated_at": "2019-12-27T18:11:19.117Z"
}
],
"next_page": "next_page"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"id": "id",
"amount": "50000",
"created_at": "2019-12-27T18:11:19.117Z",
"currency": "USD",
"is_enabled": true,
"period": "daily",
"scope": {
"type": "user",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"type": "spend_limit",
"updated_at": "2019-12-27T18:11:19.117Z"
---
## Get Spend Limit - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/spend_limits/retrieve
Path: 04-API-Reference/Admin/beta-organization-spend-limits-retrieve.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fspend_limits%2Fretrieve)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
Set Spend Limit
Get Spend Limit
Delete Spend Limit
List Spend Limits
Effective
Increase Requests
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Spend Limits](https://platform.claude.com/docs/en/api/http/beta/organization/spend_limits)
# Get Spend Limit
Copy page
cURL
GET/v1/organizations/spend_limits/{spend_limit_id}
Retrieve a spend limit by ID.
##### Path parameters
spend_limit_id: string
ID of the Spend Limit.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
##### Returns
BetaSpendLimit object{ type: "spend_limit", id, amount, 6 more }
A configured spend limit: a cap on metered spend for one scope and period.
Get Spend Limit
cURL
```python
curl https://api.anthropic.com/v1/organizations/spend_limits/$SPEND_LIMIT_ID \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"id": "id",
"amount": "50000",
"created_at": "2019-12-27T18:11:19.117Z",
"currency": "USD",
"is_enabled": true,
"period": "daily",
"scope": {
"type": "user",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"type": "spend_limit",
"updated_at": "2019-12-27T18:11:19.117Z"
}
```
##### Returns Examples
Response 200
```python
{
"id": "id",
"amount": "50000",
"created_at": "2019-12-27T18:11:19.117Z",
"currency": "USD",
"is_enabled": true,
"period": "daily",
"scope": {
"type": "user",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"type": "spend_limit",
"updated_at": "2019-12-27T18:11:19.117Z"
---
## Set Spend Limit - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/spend_limits/set
Path: 04-API-Reference/Admin/beta-organization-spend-limits-set.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fspend_limits%2Fset)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
Set Spend Limit
Get Spend Limit
Delete Spend Limit
List Spend Limits
Effective
Increase Requests
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Spend Limits](https://platform.claude.com/docs/en/api/http/beta/organization/spend_limits)
# Set Spend Limit
Copy page
cURL
POST/v1/organizations/spend_limits
Set a spend limit.
Upsert keyed on (scope, period): setting a limit that already exists overwrites it in place. A Claude Enterprise organization sets `user` limits. Its seat-tier, group, and organization-level defaults are configured in claude.ai. A Claude Console organization sets `organization` and `workspace` limits, which are monthly and always carry an amount. Setting those limits is in an early access preview. To request access, contact your Anthropic account team.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"anthropic-beta": optional array of [AnthropicBeta](../Endpoints/platform-claude-com-http-beta.md#anthropic_beta)
Optional header to specify the beta version(s) you want to use.
One of the following:
string
"message-batches-2024-09-24"
"prompt-caching-2024-07-31"
"computer-use-2024-10-22"
"computer-use-2025-01-24"
"pdfs-2024-09-25"
"token-counting-2024-11-01"
"token-efficient-tools-2025-02-19"
"output-128k-2025-02-19"
"files-api-2025-04-14"
"mcp-client-2025-04-04"
"mcp-client-2025-11-20"
"dev-full-thinking-2025-05-14"
"interleaved-thinking-2025-05-14"
"code-execution-2025-05-22"
"extended-cache-ttl-2025-04-11"
"context-1m-2025-08-07"
"context-management-2025-06-27"
"model-context-window-exceeded-2025-08-26"
"skills-2025-10-02"
"fast-mode-2026-02-01"
"output-300k-2026-03-24"
"user-profiles-2026-03-24"
"user-profiles-2026-08-18"
"user-profiles-2026-09-04"
"advisor-tool-2026-03-01"
"managed-agents-2026-04-01"
"cache-diagnosis-2026-04-07"
"dreaming-2026-04-21"
"thinking-token-count-2026-05-13"
"server-side-fallback-2026-06-01"
"server-side-fallback-2026-07-01"
"fallback-credit-2026-06-01"
"fallback-credit-2026-07-01"
"agent-memory-2026-07-22"
"mid-conversation-tool-changes-2026-07-01"
"compact-2026-01-12"
"computer-use-2025-11-24"
"mcp-tunnels-2026-06-22"
"structured-outputs-2025-11-13"
"task-budgets-2026-03-13"
"thinking-display-updates-2026-08-18"
"ce-user-management-2026-07-13"
"mid-conversation-output-config-2026-07-01"
"thinking-binding-controls-2026-08-01"
"mid-conversation-system-clear-at-2026-08-21"
"compact-2026-09-04"
"inline-tools-2026-09-15"
"mcp-client-2026-09-15"
"ce-plugins-2026-09-01"
"spend-limit-reads-2026-09-26"
"telemetry-destinations-2026-08-11"
##### Body
amount: string or null
Limit amount as a non-negative integer decimal string in the minor unit of the organization's billing currency (cents for USD): "50000" is \$500.00. `null` sets an explicit no-limit override for this scope and `period` only — each period resolves independently, so caps for other periods still apply.
scope: [BetaSpendLimitUserScope](https://platform.claude.com/docs/en/api/http/beta/organization/spend_limits#beta_spend_limit_user_scope) or [BetaSpendLimitOrganizationScope](https://platform.claude.com/docs/en/api/http/beta/organization/spend_limits#beta_spend_limit_organization_scope) or [BetaSpendLimitWorkspaceScope](https://platform.claude.com/docs/en/api/http/beta/organization/spend_limits#beta_spend_limit_workspace_scope)
What the limit applies to. Claude Enterprise organizations set `user` limits. Claude Console organizations set `organization` and `workspace` limits. Any other combination returns 400. Setting `organization` and `workspace` limits through the API is in an early access preview. To request access, contact your Anthropic account team.
One of the following:
BetaSpendLimitUserScope object{ type: "user", user_id }
Scope selecting a single member of the organization.
type: "user"
Scope type. Always `user` for this scope.
defaultuser
user_id: string
Tagged ID of the member the spend limit applies to.
BetaSpendLimitOrganizationScope object{ type: "organization" }
type: "organization"
defaultorganization
BetaSpendLimitWorkspaceScope object{ type: "workspace", workspace_id }
Scope selecting one workspace of a Claude Console organization.
type: "workspace"
Scope type. Always `workspace` for this scope.
defaultworkspace
workspace_id: string
Tagged ID of the workspace the spend limit applies to.
period: optional [BetaSpendLimitPeriod](https://platform.claude.com/docs/en/api/http/beta/organization/spend_limits#beta_spend_limit_period)
One of the following:
"daily"
"monthly"
"weekly"
##### Returns
BetaSpendLimit object{ type: "spend_limit", id, amount, 6 more }
A configured spend limit: a cap on metered spend for one scope and period.
Set Spend Limit
cURL
```python
curl https://api.anthropic.com/v1/organizations/spend_limits \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY" \
-d '{
"amount": "50000",
"scope": {
"type": "user",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"period": "monthly"
}'
```
Response 200
```python
{
"id": "id",
"amount": "50000",
"created_at": "2019-12-27T18:11:19.117Z",
"currency": "USD",
"is_enabled": true,
"period": "daily",
"scope": {
"type": "user",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"type": "spend_limit",
"updated_at": "2019-12-27T18:11:19.117Z"
}
```
##### Returns Examples
Response 200
```python
{
"id": "id",
"amount": "50000",
"created_at": "2019-12-27T18:11:19.117Z",
"currency": "USD",
"is_enabled": true,
"period": "daily",
"scope": {
"type": "user",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
},
"type": "spend_limit",
"updated_at": "2019-12-27T18:11:19.117Z"
---
## Spend Limits - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/spend_limits
Path: 04-API-Reference/Admin/beta-organization-spend-limits.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fspend_limits)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
Set Spend Limit
Get Spend Limit
Delete Spend Limit
List Spend Limits
Effective
Increase Requests
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
# Spend Limits
Copy page
cURL
##### [Set Spend Limit](https://platform.claude.com/docs/en/api/http/beta/organization/spend_limits/set)
POST/v1/organizations/spend_limits
Set a spend limit.
##### [Get Spend Limit](https://platform.claude.com/docs/en/api/http/beta/organization/spend_limits/retrieve)
GET/v1/organizations/spend_limits/{spend_limit_id}
Retrieve a spend limit by ID.
##### [Delete Spend Limit](https://platform.claude.com/docs/en/api/http/beta/organization/spend_limits/delete)
DELETE/v1/organizations/spend_limits/{spend_limit_id}
Delete a spend limit.
##### [List Spend Limits](https://platform.claude.com/docs/en/api/http/beta/organization/spend_limits/list)
GET/v1/organizations/spend_limits
List the organization's spend limits.
##### Models
BetaSpendLimit object{ type: "spend_limit", id, amount, 6 more }
A configured spend limit: a cap on metered spend for one scope and period.
BetaSpendLimitOrganizationScope object{ type: "organization" }
type: "organization"
defaultorganization
BetaSpendLimitOrganizationServiceScope object{ type: "organization_service", service }
type: "organization_service"
defaultorganization_service
service: string
BetaSpendLimitPeriod = "daily" or "monthly" or "weekly"
One of the following:
"daily"
"monthly"
"weekly"
BetaSpendLimitRBACGroupScope object{ type: "rbac_group", rbac_group_id }
type: "rbac_group"
defaultrbac_group
rbac_group_id: string
BetaSpendLimitScopedAPIKeyActor object{ type: "scoped_api_key_actor", scoped_api_key_id }
A scoped Admin API key acting on behalf of the organization.
type: "scoped_api_key_actor"
defaultscoped_api_key_actor
scoped_api_key_id: string
BetaSpendLimitSeatTierScope object{ type: "seat_tier", seat_tier }
type: "seat_tier"
defaultseat_tier
seat_tier: string
BetaSpendLimitUsageTierScope object{ type: "usage_tier" }
Scope of the monthly spend cap Anthropic sets for a Claude Console organization from its usage tier, or a higher cap Anthropic granted the organization. Read-only; its `created_at` and `updated_at` are the organization's creation time, so `amount` can change while `updated_at` stays the same.
type: "usage_tier"
Scope type. Always `usage_tier` for this scope.
defaultusage_tier
BetaSpendLimitUserActor object{ type: "user_actor", deleted, email_address, 2 more }
A user within the organization. `name` and `email_address` are null when the underlying account is unavailable or has been deleted; `deleted` is true only for deleted accounts.
type: "user_actor"
Actor type. Always `user_actor`.
defaultuser_actor
deleted: boolean
True only when the underlying account has been deleted.
defaultfalse
email_address: string or null
The user's email address. Null when the account is unavailable or has been deleted.
name: string or null
The user's current display name. Null when the account is unavailable, has been deleted, or has no name set.
user_id: string
Tagged ID of the user.
BetaSpendLimitUserScope object{ type: "user", user_id }
Scope selecting a single member of the organization.
type: "user"
Scope type. Always `user` for this scope.
defaultuser
user_id: string
Tagged ID of the member the spend limit applies to.
BetaSpendLimitWorkspaceScope object{ type: "workspace", workspace_id }
Scope selecting one workspace of a Claude Console organization.
type: "workspace"
Scope type. Always `workspace` for this scope.
defaultworkspace
workspace_id: string
Tagged ID of the workspace the spend limit applies to.
BetaSpendSummary object{ actor, amount, currency, 5 more }
Per-member effective-limit report row (`GET /spend_limits/effective`).
SpendLimitDeleteResponse object{ type: "spend_limit_deleted", id }
type: "spend_limit_deleted"
defaultspend_limit_deleted
id: string
#### Spend Limits[Effective](https://platform.claude.com/docs/en/api/http/beta/organization/spend_limits/effective)
##### [List Effective Spend Limits](https://platform.claude.com/docs/en/api/http/beta/organization/spend_limits/effective/list)
GET/v1/organizations/spend_limits/effective
List each member's effective spend limit and period-to-date spend.
#### Spend Limits[Increase Requests](https://platform.claude.com/docs/en/api/http/beta/organization/spend_limits/increase_requests)
##### [List Spend Limit Increase Requests](https://platform.claude.com/docs/en/api/http/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](https://platform.claude.com/docs/en/api/http/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](https://platform.claude.com/docs/en/api/http/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](https://platform.claude.com/docs/en/api/http/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.
---
## Create a Telemetry Destination - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/telemetry_destinations/create
Path: 04-API-Reference/Admin/beta-organization-telemetry-destinations-create.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Ftelemetry_destinations%2Fcreate)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Create a Telemetry Destination
List Telemetry Destinations
Retrieve a Telemetry Destination
Update a Telemetry Destination
Delete a Telemetry Destination
Test a Telemetry Destination
Workspaces
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[AWS IAM actions](../Endpoints/claude-platform-on-aws-iam-actions.md)[Google Cloud IAM permissions](../Endpoints/claude-models-on-google-cloud-anthropic-managed-iam-permissions.md)[Versions](../Endpoints/versioning.md)[Migrating to API version 2026-10-21](../Endpoints/migration-2026-10-21.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
API version 2026-10-21
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Telemetry Destinations](https://platform.claude.com/docs/en/api/http/beta/organization/telemetry_destinations)
# Create a Telemetry Destination
Copy page
API version 2026-10-21
cURL
POST/v1/organizations/telemetry_destinations
Register an OpenTelemetry destination for the organization.
The destination starts in state `enabled`. An organization can have at most 10 destinations, including disabled ones.
See the [OpenTelemetry export guide](../Other/manage-claude-opentelemetry.md#add-a-destination) to learn more about adding a destination.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"anthropic-beta": optional array of [AnthropicBeta](../Endpoints/platform-claude-com-http-beta.md#anthropic_beta)
This endpoint is in beta: requests must send `telemetry-destinations-2026-08-11` in this header.
One of the following:
string
"message-batches-2024-09-24"
"prompt-caching-2024-07-31"
"computer-use-2024-10-22"
"computer-use-2025-01-24"
"pdfs-2024-09-25"
"token-counting-2024-11-01"
"token-efficient-tools-2025-02-19"
"output-128k-2025-02-19"
"files-api-2025-04-14"
"mcp-client-2025-04-04"
"mcp-client-2025-11-20"
"dev-full-thinking-2025-05-14"
"interleaved-thinking-2025-05-14"
"code-execution-2025-05-22"
"extended-cache-ttl-2025-04-11"
"context-1m-2025-08-07"
"context-management-2025-06-27"
"model-context-window-exceeded-2025-08-26"
"skills-2025-10-02"
"fast-mode-2026-02-01"
"output-300k-2026-03-24"
"user-profiles-2026-03-24"
"user-profiles-2026-08-18"
"user-profiles-2026-09-04"
"advisor-tool-2026-03-01"
"managed-agents-2026-04-01"
"cache-diagnosis-2026-04-07"
"dreaming-2026-04-21"
"thinking-token-count-2026-05-13"
"server-side-fallback-2026-06-01"
"server-side-fallback-2026-07-01"
"fallback-credit-2026-06-01"
"fallback-credit-2026-07-01"
"agent-memory-2026-07-22"
"mid-conversation-tool-changes-2026-07-01"
"compact-2026-01-12"
"computer-use-2025-11-24"
"mcp-tunnels-2026-06-22"
"structured-outputs-2025-11-13"
"task-budgets-2026-03-13"
"thinking-display-updates-2026-08-18"
"ce-user-management-2026-07-13"
"mid-conversation-output-config-2026-07-01"
"thinking-binding-controls-2026-08-01"
"mid-conversation-system-clear-at-2026-08-21"
"compact-2026-09-04"
"inline-tools-2026-09-15"
"mcp-client-2026-09-15"
"ce-plugins-2026-09-01"
"spend-limit-reads-2026-09-26"
"telemetry-destinations-2026-08-11"
"webhooks-2026-10-07"
##### Body
endpoint_url: string
The base URL of your collector's OTLP/HTTP endpoint, for example `https://gateway.example.com`.
The URL must use `https` and a hostname, not an IP address. The port, if given, must be 443. The URL must not contain a query string, a fragment, or a username and password. At most 2,048 characters.
A path prefix, such as `/otlp`, is allowed. Don't include the per-signal path (`/v1/traces`), because the API appends it on delivery. If your collector takes traces on another path, also set `traces.endpoint_url`.
minLength1
maxLength2048
workspaces: [BetaTelemetryDestinationWorkspacesParams](https://platform.claude.com/docs/en/api/http/beta/organization/telemetry_destinations#beta_telemetry_destination_workspaces_params)
Which of the organization's workspaces the destination covers.
One of the following:
display_name: optional string or null
Human-readable name for the destination. Optional. 1 to 255 characters.
headers: optional map\[string\]
Request headers that the API sends with every delivery, typically your collector's authentication header (for example `authorization`).
The API stores the values encrypted and never returns them. Reads show only `header_names`.
At most 20 headers. Names are at most 128 characters. Two names can't differ only in case. Values are printable ASCII, at most 4,096 characters, and can't begin or end with a space. Names and values together are at most 16,384 bytes.
Reserved names are rejected, for example `host`, `cookie`, `user-agent`, and names that start with `content-`, `proxy-`, `x-forwarded-`, or `anthropic-`. For this check, `_` in a name counts as `-`.
traces: optional [BetaTelemetryDestinationTracesParams](https://platform.claude.com/docs/en/api/http/beta/organization/telemetry_destinations#beta_telemetry_destination_traces_params) { content_mode, enabled, endpoint_url, max_content_bytes }
The settings for the traces that the destination receives. If you leave it out, every setting takes its default.
content_mode: optional [BetaTelemetryDestinationContentMode](https://platform.claude.com/docs/en/api/http/beta/organization/telemetry_destinations#beta_telemetry_destination_content_mode) or null
What the exported spans contain. Defaults to `metadata_only` on create.
On update, `null` sets `metadata_only`.
One of the following:
"metadata_only"
The spans contain identifiers, timing, status, token counts, and similar metadata. They don't contain prompt text, completion text, or tool inputs and outputs.
"content"
The spans contain the same metadata as `metadata_only`, plus message and tool content.
An organization with a data-handling restriction, such as under HIPAA, can't choose this mode. The API exports only metadata for such an organization, even to a destination that already has `content`.
enabled: optional boolean
Whether the destination receives traces. Defaults to true on create. It cannot be null.
endpoint_url: optional string or null
The full URL of your collector's traces endpoint, for a collector that takes traces on a path other than `/v1/traces`. The API posts traces to it exactly as given and appends nothing.
The same rules as for `endpoint_url` apply, except that any path is allowed. It must have the same scheme, host, and port as `endpoint_url`. At most 2,048 characters.
On create, `null` is the same as leaving it out. On update, `null` removes it. The API then posts traces to `endpoint_url` with `/v1/traces` appended. A change of this URL alone keeps the registered headers.
maxLength2048
max_content_bytes: optional number or null
The most bytes of content that one exported span can contain, from 1 up to the API's maximum. `null` sets no bound, so only the API's maximum applies.
On create, leaving it out is the same as `null`. The error for a value above the maximum states the maximum.
formatint32
##### Returns
BetaTelemetryDestination object{ type: "telemetry_destination", id, created_at, 8 more }
An OpenTelemetry destination: an OTLP/HTTP endpoint, the request headers sent with every delivery to it, what the exported spans contain, and which workspaces it covers. A destination belongs to an organization. A workspace's spans go to every enabled destination that covers it.
Create a Telemetry Destination
cURL
```python
curl https://api.anthropic.com/v1/organizations/telemetry_destinations \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2026-10-21' \
-H 'anthropic-beta: telemetry-destinations-2026-08-11' \
-H "Authorization: Bearer $ANTHROPIC_API_KEY" \
-d '{
"endpoint_url": "x",
"workspaces": {
"type": "all"
}
}'
```
Response 200
```python
{
"id": "id",
"created_at": "2019-12-27T18:11:19.117Z",
"delivery_health": {
"last_error": "last_error",
"last_error_at": "2019-12-27T18:11:19.117Z",
"last_success_at": "2019-12-27T18:11:19.117Z"
},
"display_name": "display_name",
"endpoint_url": "endpoint_url",
"header_names": [
"string"
],
"state": {
"type": "enabled"
},
"traces": {
"content_mode": "metadata_only",
"enabled": true,
"endpoint_url": "endpoint_url",
"max_content_bytes": 0
},
"type": "telemetry_destination",
"updated_at": "2019-12-27T18:11:19.117Z",
"workspaces": {
"type": "all"
}
}
```
##### Returns Examples
Response 200
```python
{
"id": "id",
"created_at": "2019-12-27T18:11:19.117Z",
"delivery_health": {
"last_error": "last_error",
"last_error_at": "2019-12-27T18:11:19.117Z",
"last_success_at": "2019-12-27T18:11:19.117Z"
},
"display_name": "display_name",
"endpoint_url": "endpoint_url",
"header_names": [
"string"
],
"state": {
"type": "enabled"
},
"traces": {
"content_mode": "metadata_only",
"enabled": true,
"endpoint_url": "endpoint_url",
"max_content_bytes": 0
},
"type": "telemetry_destination",
"updated_at": "2019-12-27T18:11:19.117Z",
---
## Delete a Telemetry Destination - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/telemetry_destinations/delete
Path: 04-API-Reference/Admin/beta-organization-telemetry-destinations-delete.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Ftelemetry_destinations%2Fdelete)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Create a Telemetry Destination
List Telemetry Destinations
Retrieve a Telemetry Destination
Update a Telemetry Destination
Delete a Telemetry Destination
Test a Telemetry Destination
Workspaces
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[AWS IAM actions](../Endpoints/claude-platform-on-aws-iam-actions.md)[Google Cloud IAM permissions](../Endpoints/claude-models-on-google-cloud-anthropic-managed-iam-permissions.md)[Versions](../Endpoints/versioning.md)[Migrating to API version 2026-10-21](../Endpoints/migration-2026-10-21.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
API version 2026-10-21
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Telemetry Destinations](https://platform.claude.com/docs/en/api/http/beta/organization/telemetry_destinations)
# Delete a Telemetry Destination
Copy page
API version 2026-10-21
cURL
DELETE/v1/organizations/telemetry_destinations/{destination_id}
Delete a destination and its workspace list.
The API stops sending spans to the destination. The spans of the workspaces it covered still go to the other destinations that cover them. A deleted destination can't be read, listed, or restored.
See the [OpenTelemetry export guide](../Other/manage-claude-opentelemetry.md#delivery-and-health) to learn more about managing a destination.
##### Path parameters
destination_id: string
ID of the destination (`tdst_...`).
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"anthropic-beta": optional array of [AnthropicBeta](../Endpoints/platform-claude-com-http-beta.md#anthropic_beta)
This endpoint is in beta: requests must send `telemetry-destinations-2026-08-11` in this header.
One of the following:
string
"message-batches-2024-09-24"
"prompt-caching-2024-07-31"
"computer-use-2024-10-22"
"computer-use-2025-01-24"
"pdfs-2024-09-25"
"token-counting-2024-11-01"
"token-efficient-tools-2025-02-19"
"output-128k-2025-02-19"
"files-api-2025-04-14"
"mcp-client-2025-04-04"
"mcp-client-2025-11-20"
"dev-full-thinking-2025-05-14"
"interleaved-thinking-2025-05-14"
"code-execution-2025-05-22"
"extended-cache-ttl-2025-04-11"
"context-1m-2025-08-07"
"context-management-2025-06-27"
"model-context-window-exceeded-2025-08-26"
"skills-2025-10-02"
"fast-mode-2026-02-01"
"output-300k-2026-03-24"
"user-profiles-2026-03-24"
"user-profiles-2026-08-18"
"user-profiles-2026-09-04"
"advisor-tool-2026-03-01"
"managed-agents-2026-04-01"
"cache-diagnosis-2026-04-07"
"dreaming-2026-04-21"
"thinking-token-count-2026-05-13"
"server-side-fallback-2026-06-01"
"server-side-fallback-2026-07-01"
"fallback-credit-2026-06-01"
"fallback-credit-2026-07-01"
"agent-memory-2026-07-22"
"mid-conversation-tool-changes-2026-07-01"
"compact-2026-01-12"
"computer-use-2025-11-24"
"mcp-tunnels-2026-06-22"
"structured-outputs-2025-11-13"
"task-budgets-2026-03-13"
"thinking-display-updates-2026-08-18"
"ce-user-management-2026-07-13"
"mid-conversation-output-config-2026-07-01"
"thinking-binding-controls-2026-08-01"
"mid-conversation-system-clear-at-2026-08-21"
"compact-2026-09-04"
"inline-tools-2026-09-15"
"mcp-client-2026-09-15"
"ce-plugins-2026-09-01"
"spend-limit-reads-2026-09-26"
"telemetry-destinations-2026-08-11"
"webhooks-2026-10-07"
##### Returns
BetaDeletedTelemetryDestination object{ type: "telemetry_destination_deleted", id }
Confirmation that a destination was deleted.
type: "telemetry_destination_deleted"
id: string
ID of the deleted destination (`tdst_...`).
Delete a Telemetry Destination
cURL
```python
curl https://api.anthropic.com/v1/organizations/telemetry_destinations/$DESTINATION_ID \
-X DELETE \
-H 'anthropic-version: 2026-10-21' \
-H 'anthropic-beta: telemetry-destinations-2026-08-11' \
-H "Authorization: Bearer $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"id": "id",
"type": "telemetry_destination_deleted"
}
```
##### Returns Examples
Response 200
```python
{
"id": "id",
"type": "telemetry_destination_deleted"
---
## List Telemetry Destinations - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/telemetry_destinations/list
Path: 04-API-Reference/Admin/beta-organization-telemetry-destinations-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Ftelemetry_destinations%2Flist)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Create a Telemetry Destination
List Telemetry Destinations
Retrieve a Telemetry Destination
Update a Telemetry Destination
Delete a Telemetry Destination
Test a Telemetry Destination
Workspaces
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[AWS IAM actions](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[Migrating to API version 2026-10-21](../Endpoints/migration-2026-10-21.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
API version 2023-06-01
cURL
This page documents API version 2023-06-01. [See this page for the newer version, 2026-10-21](beta-organization-telemetry-destinations-list.md), or read [what changed in 2026-10-21](../Endpoints/migration-2026-10-21.md).
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Telemetry Destinations](https://platform.claude.com/docs/en/api/http/beta/organization/telemetry_destinations)
# List Telemetry Destinations
Copy page
API version 2023-06-01
cURL
GET/v1/organizations/telemetry_destinations
List the organization's destinations, newest first, optionally only those that cover given workspaces.
See the [OpenTelemetry export guide](../Other/manage-claude-opentelemetry.md#set-up-api-tracing) to learn more about destinations.
##### Query parameters
limit: optional number
Number of destinations to return per page, between 1 and 1,000. Defaults to 20.
formatint32
page: optional string
Opaque cursor from a previous response's `next_page`. Leave it out to get the first page.
workspace_ids: optional array of string
Return only the destinations that cover at least one of these workspaces (`wrkspc_...`).
Send at most 100 IDs, as `workspace_ids[]`. A destination covers a workspace when its `workspaces.type` is `all`, when its `include` list has the workspace, or when its `exclude` list doesn't have it. Destinations in either state can match. An ID that isn't the ID of one of the organization's workspaces doesn't match any destination, not even one whose type is `all`.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"anthropic-beta": optional array of [AnthropicBeta](../Endpoints/platform-claude-com-http-beta.md#anthropic_beta)
This endpoint is in beta: requests must send `telemetry-destinations-2026-08-11` in this header.
One of the following:
string
"message-batches-2024-09-24"
"prompt-caching-2024-07-31"
"computer-use-2024-10-22"
"computer-use-2025-01-24"
"pdfs-2024-09-25"
"token-counting-2024-11-01"
"token-efficient-tools-2025-02-19"
"output-128k-2025-02-19"
"files-api-2025-04-14"
"mcp-client-2025-04-04"
"mcp-client-2025-11-20"
"dev-full-thinking-2025-05-14"
"interleaved-thinking-2025-05-14"
"code-execution-2025-05-22"
"extended-cache-ttl-2025-04-11"
"context-1m-2025-08-07"
"context-management-2025-06-27"
"model-context-window-exceeded-2025-08-26"
"skills-2025-10-02"
"fast-mode-2026-02-01"
"output-300k-2026-03-24"
"user-profiles-2026-03-24"
"user-profiles-2026-08-18"
"user-profiles-2026-09-04"
"advisor-tool-2026-03-01"
"managed-agents-2026-04-01"
"cache-diagnosis-2026-04-07"
"dreaming-2026-04-21"
"thinking-token-count-2026-05-13"
"server-side-fallback-2026-06-01"
"server-side-fallback-2026-07-01"
"fallback-credit-2026-06-01"
"fallback-credit-2026-07-01"
"agent-memory-2026-07-22"
"mid-conversation-tool-changes-2026-07-01"
"compact-2026-01-12"
"computer-use-2025-11-24"
"mcp-tunnels-2026-06-22"
"structured-outputs-2025-11-13"
"task-budgets-2026-03-13"
"thinking-display-updates-2026-08-18"
"ce-user-management-2026-07-13"
"mid-conversation-output-config-2026-07-01"
"thinking-binding-controls-2026-08-01"
"mid-conversation-system-clear-at-2026-08-21"
"compact-2026-09-04"
"inline-tools-2026-09-15"
"mcp-client-2026-09-15"
"ce-plugins-2026-09-01"
"spend-limit-reads-2026-09-26"
"telemetry-destinations-2026-08-11"
"webhooks-2026-10-07"
##### Returns
data: array of [BetaTelemetryDestination](https://platform.claude.com/docs/en/api/http/beta/organization/telemetry_destinations#beta_telemetry_destination) { type: "telemetry_destination", id, created_at, 8 more }
Destinations on this page, newest first.
type: "telemetry_destination"
id: string
The unique ID of the destination (`tdst_...`).
created_at: string
Time the destination was created.
formatdate-time
delivery_health: [BetaTelemetryDestinationDeliveryHealth](https://platform.claude.com/docs/en/api/http/beta/organization/telemetry_destinations#beta_telemetry_destination_delivery_health) { last_error, last_error_at, last_success_at }
The most recent delivery results for this destination.
last_error: string or null
A message that describes the most recent failed delivery to the destination, or `null` if no delivery has failed yet.
Examples are `temporary DNS failure`, `TLS failure`, `timeout`, `connection failure`, `invalid address`, `HTTP error (status 503)`, and `redirect (status 301)`. The message is `invalid address` both for a hostname that doesn't exist and for an address that isn't publicly routable. It never contains the endpoint's response body, a header value, a network address, or TLS details.
`last_error` and `last_error_at` always change together. A later successful delivery doesn't clear them. If `last_success_at` is later than `last_error_at`, a delivery has succeeded since this failure.
See the [OpenTelemetry export guide](../Other/manage-claude-opentelemetry.md#delivery-errors) to learn the likely cause of each error.
last_error_at: string or null
Time of the failure that `last_error` describes. Changes together with `last_error`. Null until a delivery first fails.
formatdate-time
last_success_at: string or null
Time of the most recent successful delivery to the destination, or `null` if no delivery has succeeded yet.
formatdate-time
display_name: string or null
Human-readable name for the destination. Null when none was set.
endpoint_url: string
The base URL of the destination's OTLP/HTTP endpoint, exactly as registered.
The API appends the per-signal path, such as `/v1/traces`, on delivery, unless `traces.endpoint_url` is set.
header_names: array of string
Names of the registered request headers. Header values are write-only and are never returned.
state: [BetaTelemetryDestinationState](https://platform.claude.com/docs/en/api/http/beta/organization/telemetry_destinations#beta_telemetry_destination_state)
Whether the destination receives deliveries.
One of the following:
BetaTelemetryDestinationStateEnabled object{ type: "enabled" }
The telemetry destination receives the spans of the workspaces that it covers.
type: "enabled"
BetaTelemetryDestinationStateDisabled object{ type: "disabled", reason }
The API doesn't deliver anything to the telemetry destination.
Spans produced while it is disabled aren't delivered later.
type: "disabled"
reason: [BetaTelemetryDestinationDisabledReason](https://platform.claude.com/docs/en/api/http/beta/organization/telemetry_destinations#beta_telemetry_destination_disabled_reason)
Whether a caller or the API disabled the destination and, when the API did, why. Read-only.
One of the following:
traces: [BetaTelemetryDestinationTraces](https://platform.claude.com/docs/en/api/http/beta/organization/telemetry_destinations#beta_telemetry_destination_traces) { content_mode, enabled, endpoint_url, max_content_bytes }
The destination's settings for the traces it receives.
content_mode: [BetaTelemetryDestinationContentMode](https://platform.claude.com/docs/en/api/http/beta/organization/telemetry_destinations#beta_telemetry_destination_content_mode)
What the exported spans contain.
One of the following:
"metadata_only"
The spans contain identifiers, timing, status, token counts, and similar metadata. They don't contain prompt text, completion text, or tool inputs and outputs.
"content"
The spans contain the same metadata as `metadata_only`, plus message and tool content.
An organization with a data-handling restriction, such as under HIPAA, can't choose this mode. The API exports only metadata for such an organization, even to a destination that already has `content`.
enabled: boolean
Whether the destination receives traces. A destination whose `enabled` is false keeps its other settings.
endpoint_url: string or null
The full URL that the API posts traces to, exactly as registered, or `null` if the destination doesn't have one.
When it is `null`, the API posts traces to `endpoint_url` with `/v1/traces` appended.
max_content_bytes: number or null
The most bytes of content that one exported span can contain, or `null` if only the API's maximum applies.
Content means model prompts and responses, and tool inputs and outputs. The API shortens longer content to this size before it delivers the span. A destination whose `content_mode` is `metadata_only` keeps this value. It applies once `content_mode` is `content`.
formatint32
updated_at: string
Time of the last change to the destination's configuration or state. Changes to `delivery_health` don't change it.
An update that sets a header value always changes it, even when the value is the same as before. Adding or removing a single workspace on the destination's list doesn't change it. An update that changes the list does.
formatdate-time
workspaces: [BetaTelemetryDestinationWorkspaces](https://platform.claude.com/docs/en/api/http/beta/organization/telemetry_destinations#beta_telemetry_destination_workspaces)
Which of the organization's workspaces the destination covers.
One of the following:
BetaTelemetryDestinationWorkspacesAll object{ type: "all" }
The destination covers every workspace of the organization, including the default workspace, archived workspaces, and workspaces created later. It doesn't have a list.
type: "all"
BetaTelemetryDestinationWorkspacesInclude object{ type: "include" }
The destination covers the workspaces on its list, and no others.
type: "include"
BetaTelemetryDestinationWorkspacesExclude object{ type: "exclude" }
The destination covers every workspace of the organization except the workspaces on its list. A workspace created later is covered until it is added to the list.
type: "exclude"
next_page: string or null
Cursor for the next page. Null on the last page.
List Telemetry Destinations
cURL
```python
curl https://api.anthropic.com/v1/organizations/telemetry_destinations \
-H 'anthropic-version: 2023-06-01' \
-H 'anthropic-beta: telemetry-destinations-2026-08-11' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"data": [
{
"id": "id",
"created_at": "2019-12-27T18:11:19.117Z",
"delivery_health": {
"last_error": "last_error",
"last_error_at": "2019-12-27T18:11:19.117Z",
"last_success_at": "2019-12-27T18:11:19.117Z"
},
"display_name": "display_name",
"endpoint_url": "endpoint_url",
"header_names": [
"string"
],
"state": {
"type": "enabled"
},
"traces": {
"content_mode": "metadata_only",
"enabled": true,
"endpoint_url": "endpoint_url",
"max_content_bytes": 0
},
"type": "telemetry_destination",
"updated_at": "2019-12-27T18:11:19.117Z",
"workspaces": {
"type": "all"
}
}
],
"next_page": "next_page"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"id": "id",
"created_at": "2019-12-27T18:11:19.117Z",
"delivery_health": {
"last_error": "last_error",
"last_error_at": "2019-12-27T18:11:19.117Z",
"last_success_at": "2019-12-27T18:11:19.117Z"
},
"display_name": "display_name",
"endpoint_url": "endpoint_url",
"header_names": [
"string"
],
"state": {
"type": "enabled"
},
"traces": {
"content_mode": "metadata_only",
"enabled": true,
"endpoint_url": "endpoint_url",
"max_content_bytes": 0
},
"type": "telemetry_destination",
"updated_at": "2019-12-27T18:11:19.117Z",
---
## Retrieve a Telemetry Destination - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/telemetry_destinations/retrieve
Path: 04-API-Reference/Admin/beta-organization-telemetry-destinations-retrieve.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Ftelemetry_destinations%2Fretrieve)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Create a Telemetry Destination
List Telemetry Destinations
Retrieve a Telemetry Destination
Update a Telemetry Destination
Delete a Telemetry Destination
Test a Telemetry Destination
Workspaces
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[AWS IAM actions](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[Migrating to API version 2026-10-21](../Endpoints/migration-2026-10-21.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
API version 2023-06-01
cURL
This page documents API version 2023-06-01. [See this page for the newer version, 2026-10-21](beta-organization-telemetry-destinations-retrieve.md), or read [what changed in 2026-10-21](../Endpoints/migration-2026-10-21.md).
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Telemetry Destinations](https://platform.claude.com/docs/en/api/http/beta/organization/telemetry_destinations)
# Retrieve a Telemetry Destination
Copy page
API version 2023-06-01
cURL
GET/v1/organizations/telemetry_destinations/{destination_id}
Read a destination's configuration, state, and most recent delivery results.
See the [OpenTelemetry export guide](../Other/manage-claude-opentelemetry.md#delivery-and-health) to learn how the API delivers spans and when it disables a destination.
##### Path parameters
destination_id: string
ID of the destination (`tdst_...`).
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"anthropic-beta": optional array of [AnthropicBeta](../Endpoints/platform-claude-com-http-beta.md#anthropic_beta)
This endpoint is in beta: requests must send `telemetry-destinations-2026-08-11` in this header.
One of the following:
string
"message-batches-2024-09-24"
"prompt-caching-2024-07-31"
"computer-use-2024-10-22"
"computer-use-2025-01-24"
"pdfs-2024-09-25"
"token-counting-2024-11-01"
"token-efficient-tools-2025-02-19"
"output-128k-2025-02-19"
"files-api-2025-04-14"
"mcp-client-2025-04-04"
"mcp-client-2025-11-20"
"dev-full-thinking-2025-05-14"
"interleaved-thinking-2025-05-14"
"code-execution-2025-05-22"
"extended-cache-ttl-2025-04-11"
"context-1m-2025-08-07"
"context-management-2025-06-27"
"model-context-window-exceeded-2025-08-26"
"skills-2025-10-02"
"fast-mode-2026-02-01"
"output-300k-2026-03-24"
"user-profiles-2026-03-24"
"user-profiles-2026-08-18"
"user-profiles-2026-09-04"
"advisor-tool-2026-03-01"
"managed-agents-2026-04-01"
"cache-diagnosis-2026-04-07"
"dreaming-2026-04-21"
"thinking-token-count-2026-05-13"
"server-side-fallback-2026-06-01"
"server-side-fallback-2026-07-01"
"fallback-credit-2026-06-01"
"fallback-credit-2026-07-01"
"agent-memory-2026-07-22"
"mid-conversation-tool-changes-2026-07-01"
"compact-2026-01-12"
"computer-use-2025-11-24"
"mcp-tunnels-2026-06-22"
"structured-outputs-2025-11-13"
"task-budgets-2026-03-13"
"thinking-display-updates-2026-08-18"
"ce-user-management-2026-07-13"
"mid-conversation-output-config-2026-07-01"
"thinking-binding-controls-2026-08-01"
"mid-conversation-system-clear-at-2026-08-21"
"compact-2026-09-04"
"inline-tools-2026-09-15"
"mcp-client-2026-09-15"
"ce-plugins-2026-09-01"
"spend-limit-reads-2026-09-26"
"telemetry-destinations-2026-08-11"
"webhooks-2026-10-07"
##### Returns
BetaTelemetryDestination object{ type: "telemetry_destination", id, created_at, 8 more }
An OpenTelemetry destination: an OTLP/HTTP endpoint, the request headers sent with every delivery to it, what the exported spans contain, and which workspaces it covers. A destination belongs to an organization. A workspace's spans go to every enabled destination that covers it.
Retrieve a Telemetry Destination
cURL
```python
curl https://api.anthropic.com/v1/organizations/telemetry_destinations/$DESTINATION_ID \
-H 'anthropic-version: 2023-06-01' \
-H 'anthropic-beta: telemetry-destinations-2026-08-11' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"id": "id",
"created_at": "2019-12-27T18:11:19.117Z",
"delivery_health": {
"last_error": "last_error",
"last_error_at": "2019-12-27T18:11:19.117Z",
"last_success_at": "2019-12-27T18:11:19.117Z"
},
"display_name": "display_name",
"endpoint_url": "endpoint_url",
"header_names": [
"string"
],
"state": {
"type": "enabled"
},
"traces": {
"content_mode": "metadata_only",
"enabled": true,
"endpoint_url": "endpoint_url",
"max_content_bytes": 0
},
"type": "telemetry_destination",
"updated_at": "2019-12-27T18:11:19.117Z",
"workspaces": {
"type": "all"
}
}
```
##### Returns Examples
Response 200
```python
{
"id": "id",
"created_at": "2019-12-27T18:11:19.117Z",
"delivery_health": {
"last_error": "last_error",
"last_error_at": "2019-12-27T18:11:19.117Z",
"last_success_at": "2019-12-27T18:11:19.117Z"
},
"display_name": "display_name",
"endpoint_url": "endpoint_url",
"header_names": [
"string"
],
"state": {
"type": "enabled"
},
"traces": {
"content_mode": "metadata_only",
"enabled": true,
"endpoint_url": "endpoint_url",
"max_content_bytes": 0
},
"type": "telemetry_destination",
"updated_at": "2019-12-27T18:11:19.117Z",
---
## Test a Telemetry Destination - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/telemetry_destinations/test
Path: 04-API-Reference/Admin/beta-organization-telemetry-destinations-test.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Ftelemetry_destinations%2Ftest)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Create a Telemetry Destination
List Telemetry Destinations
Retrieve a Telemetry Destination
Update a Telemetry Destination
Delete a Telemetry Destination
Test a Telemetry Destination
Workspaces
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[AWS IAM actions](../Endpoints/claude-platform-on-aws-iam-actions.md)[Google Cloud IAM permissions](../Endpoints/claude-models-on-google-cloud-anthropic-managed-iam-permissions.md)[Versions](../Endpoints/versioning.md)[Migrating to API version 2026-10-21](../Endpoints/migration-2026-10-21.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
API version 2026-10-21
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Telemetry Destinations](https://platform.claude.com/docs/en/api/http/beta/organization/telemetry_destinations)
# Test a Telemetry Destination
Copy page
API version 2026-10-21
cURL
POST/v1/organizations/telemetry_destinations/{destination_id}/test
Send one test span, named `anthropic.test`, to the destination with its registered headers, once and without retries, and report the destination's answer. The response is 200 whether or not the destination answered with a 2xx status: its `result` has the type `success`, or the type `failure` and the reason in `error`. The destination's configuration, `state` and `delivery_health` do not change. A disabled destination can be tested too. Wait 10 seconds between tests of one destination; a request that comes sooner may be answered with status 429.
##### Path parameters
destination_id: string
ID of the destination to test (starts with `tdst_`).
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"anthropic-beta": optional array of [AnthropicBeta](../Endpoints/platform-claude-com-http-beta.md#anthropic_beta)
This endpoint is in beta: requests must send `telemetry-destinations-2026-08-11` in this header.
One of the following:
string
"message-batches-2024-09-24"
"prompt-caching-2024-07-31"
"computer-use-2024-10-22"
"computer-use-2025-01-24"
"pdfs-2024-09-25"
"token-counting-2024-11-01"
"token-efficient-tools-2025-02-19"
"output-128k-2025-02-19"
"files-api-2025-04-14"
"mcp-client-2025-04-04"
"mcp-client-2025-11-20"
"dev-full-thinking-2025-05-14"
"interleaved-thinking-2025-05-14"
"code-execution-2025-05-22"
"extended-cache-ttl-2025-04-11"
"context-1m-2025-08-07"
"context-management-2025-06-27"
"model-context-window-exceeded-2025-08-26"
"skills-2025-10-02"
"fast-mode-2026-02-01"
"output-300k-2026-03-24"
"user-profiles-2026-03-24"
"user-profiles-2026-08-18"
"user-profiles-2026-09-04"
"advisor-tool-2026-03-01"
"managed-agents-2026-04-01"
"cache-diagnosis-2026-04-07"
"dreaming-2026-04-21"
"thinking-token-count-2026-05-13"
"server-side-fallback-2026-06-01"
"server-side-fallback-2026-07-01"
"fallback-credit-2026-06-01"
"fallback-credit-2026-07-01"
"agent-memory-2026-07-22"
"mid-conversation-tool-changes-2026-07-01"
"compact-2026-01-12"
"computer-use-2025-11-24"
"mcp-tunnels-2026-06-22"
"structured-outputs-2025-11-13"
"task-budgets-2026-03-13"
"thinking-display-updates-2026-08-18"
"ce-user-management-2026-07-13"
"mid-conversation-output-config-2026-07-01"
"thinking-binding-controls-2026-08-01"
"mid-conversation-system-clear-at-2026-08-21"
"compact-2026-09-04"
"inline-tools-2026-09-15"
"mcp-client-2026-09-15"
"ce-plugins-2026-09-01"
"spend-limit-reads-2026-09-26"
"telemetry-destinations-2026-08-11"
"webhooks-2026-10-07"
##### Returns
BetaTelemetryDestinationTestResponse object{ type: "telemetry_destination_test", result }
The result of one test span sent to a destination.
type: "telemetry_destination_test"
result: [BetaTelemetryDestinationTestResult](https://platform.claude.com/docs/en/api/http/beta/organization/telemetry_destinations#beta_telemetry_destination_test_result)
How the test went: `success` when the destination answered with a 2xx status, else `failure` with the reason.
One of the following:
BetaTelemetryDestinationTestSuccess object{ type: "success" }
The destination answered the test span with a 2xx status.
type: "success"
BetaTelemetryDestinationTestFailure object{ type: "failure", error }
The test span was not delivered.
type: "failure"
error: string
A message that describes why the test span was not delivered, including the HTTP status code when the destination returned one. Examples: `HTTP error (status 403)`, `timeout`, `TLS failure`. It has the same form as the destination's `delivery_health.last_error` and never contains the destination's response body, any header value, a network address, or TLS details.
Test a Telemetry Destination
cURL
```python
curl https://api.anthropic.com/v1/organizations/telemetry_destinations/$DESTINATION_ID/test \
-X POST \
-H 'anthropic-version: 2026-10-21' \
-H 'anthropic-beta: telemetry-destinations-2026-08-11' \
-H "Authorization: Bearer $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"result": {
"type": "success"
},
"type": "telemetry_destination_test"
}
```
##### Returns Examples
Response 200
```python
{
"result": {
"type": "success"
},
"type": "telemetry_destination_test"
---
## Update a Telemetry Destination - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/telemetry_destinations/update
Path: 04-API-Reference/Admin/beta-organization-telemetry-destinations-update.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Ftelemetry_destinations%2Fupdate)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Create a Telemetry Destination
List Telemetry Destinations
Retrieve a Telemetry Destination
Update a Telemetry Destination
Delete a Telemetry Destination
Test a Telemetry Destination
Workspaces
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[AWS IAM actions](../Endpoints/claude-platform-on-aws-iam-actions.md)[Google Cloud IAM permissions](../Endpoints/claude-models-on-google-cloud-anthropic-managed-iam-permissions.md)[Versions](../Endpoints/versioning.md)[Migrating to API version 2026-10-21](../Endpoints/migration-2026-10-21.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
API version 2026-10-21
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Telemetry Destinations](https://platform.claude.com/docs/en/api/http/beta/organization/telemetry_destinations)
# Update a Telemetry Destination
Copy page
API version 2026-10-21
cURL
POST/v1/organizations/telemetry_destinations/{destination_id}
Change a telemetry destination's settings, its state, or which workspaces it covers.
Send at least one field. Omitted fields keep their stored values, except the registered headers, which a change of the endpoint's hostname or port removes. Only `display_name`, `traces`, `traces.endpoint_url`, `traces.content_mode`, `traces.max_content_bytes`, and individual `headers` values accept `null`.
If another request changes the destination while the update runs, the API returns a 409 `conflict_error`. Read the destination again, then retry the update.
See the [OpenTelemetry export guide](../Other/manage-claude-opentelemetry.md#delivery-and-health) to learn more about changing a destination.
##### Path parameters
destination_id: string
ID of the destination (`tdst_...`).
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"anthropic-beta": optional array of [AnthropicBeta](../Endpoints/platform-claude-com-http-beta.md#anthropic_beta)
This endpoint is in beta: requests must send `telemetry-destinations-2026-08-11` in this header.
One of the following:
string
"message-batches-2024-09-24"
"prompt-caching-2024-07-31"
"computer-use-2024-10-22"
"computer-use-2025-01-24"
"pdfs-2024-09-25"
"token-counting-2024-11-01"
"token-efficient-tools-2025-02-19"
"output-128k-2025-02-19"
"files-api-2025-04-14"
"mcp-client-2025-04-04"
"mcp-client-2025-11-20"
"dev-full-thinking-2025-05-14"
"interleaved-thinking-2025-05-14"
"code-execution-2025-05-22"
"extended-cache-ttl-2025-04-11"
"context-1m-2025-08-07"
"context-management-2025-06-27"
"model-context-window-exceeded-2025-08-26"
"skills-2025-10-02"
"fast-mode-2026-02-01"
"output-300k-2026-03-24"
"user-profiles-2026-03-24"
"user-profiles-2026-08-18"
"user-profiles-2026-09-04"
"advisor-tool-2026-03-01"
"managed-agents-2026-04-01"
"cache-diagnosis-2026-04-07"
"dreaming-2026-04-21"
"thinking-token-count-2026-05-13"
"server-side-fallback-2026-06-01"
"server-side-fallback-2026-07-01"
"fallback-credit-2026-06-01"
"fallback-credit-2026-07-01"
"agent-memory-2026-07-22"
"mid-conversation-tool-changes-2026-07-01"
"compact-2026-01-12"
"computer-use-2025-11-24"
"mcp-tunnels-2026-06-22"
"structured-outputs-2025-11-13"
"task-budgets-2026-03-13"
"thinking-display-updates-2026-08-18"
"ce-user-management-2026-07-13"
"mid-conversation-output-config-2026-07-01"
"thinking-binding-controls-2026-08-01"
"mid-conversation-system-clear-at-2026-08-21"
"compact-2026-09-04"
"inline-tools-2026-09-15"
"mcp-client-2026-09-15"
"ce-plugins-2026-09-01"
"spend-limit-reads-2026-09-26"
"telemetry-destinations-2026-08-11"
"webhooks-2026-10-07"
##### Body
display_name: optional string or null
New human-readable name, 1 to 255 characters. Null clears it.
endpoint_url: optional string
The new base URL of the destination's OTLP/HTTP endpoint. The same rules as on create apply.
A change of hostname or port first removes every registered header, so send the headers for the new endpoint in the same request. When the destination has a `traces.endpoint_url`, such a change must also set `traces.endpoint_url` to a URL with the new hostname and port, or to `null`. A change of the path alone keeps the headers.
maxLength2048
headers: optional map\[string\] or null
Headers to set or remove. The API merges them into the destination's headers by name.
Names compare case-insensitively. A string value sets or replaces that header. A `null` value removes it. Headers that you omit don't change. The field itself can't be `null`.
A request that sets a header value must also include `endpoint_url`. The current URL is accepted.
The resulting set must stay within the same limits as on create. When the request sets a value, each stored value that it doesn't set counts as 4,096 bytes toward the 16,384-byte limit, because you can't read its real length. So to change one header of a destination that has four or more other headers, send the values of the others again in the same request.
state: optional [BetaTelemetryDestinationStateParams](https://platform.claude.com/docs/en/api/http/beta/organization/telemetry_destinations#beta_telemetry_destination_state_params)
Whether the destination receives deliveries after the update. The field can't be `null`.
One of the following:
BetaTelemetryDestinationStateEnabledParams object{ type: "enabled" }
Start deliveries to the telemetry destination again.
This doesn't reset `delivery_health`.
type: "enabled"
BetaTelemetryDestinationStateDisabledParams object{ type: "disabled" }
Stop deliveries to the telemetry destination.
Spans produced while it is disabled aren't delivered later. A destination that is already disabled keeps its `reason`.
type: "disabled"
traces: optional [BetaTelemetryDestinationTracesParams](https://platform.claude.com/docs/en/api/http/beta/organization/telemetry_destinations#beta_telemetry_destination_traces_params) { content_mode, enabled, endpoint_url, max_content_bytes } or null
The traces settings to change. Omitted settings keep their stored values.
`null` sets every traces setting to its create default.
content_mode: optional [BetaTelemetryDestinationContentMode](https://platform.claude.com/docs/en/api/http/beta/organization/telemetry_destinations#beta_telemetry_destination_content_mode) or null
What the exported spans contain. Defaults to `metadata_only` on create.
On update, `null` sets `metadata_only`.
One of the following:
"metadata_only"
The spans contain identifiers, timing, status, token counts, and similar metadata. They don't contain prompt text, completion text, or tool inputs and outputs.
"content"
The spans contain the same metadata as `metadata_only`, plus message and tool content.
An organization with a data-handling restriction, such as under HIPAA, can't choose this mode. The API exports only metadata for such an organization, even to a destination that already has `content`.
enabled: optional boolean
Whether the destination receives traces. Defaults to true on create. It cannot be null.
endpoint_url: optional string or null
The full URL of your collector's traces endpoint, for a collector that takes traces on a path other than `/v1/traces`. The API posts traces to it exactly as given and appends nothing.
The same rules as for `endpoint_url` apply, except that any path is allowed. It must have the same scheme, host, and port as `endpoint_url`. At most 2,048 characters.
On create, `null` is the same as leaving it out. On update, `null` removes it. The API then posts traces to `endpoint_url` with `/v1/traces` appended. A change of this URL alone keeps the registered headers.
maxLength2048
max_content_bytes: optional number or null
The most bytes of content that one exported span can contain, from 1 up to the API's maximum. `null` sets no bound, so only the API's maximum applies.
On create, leaving it out is the same as `null`. The error for a value above the maximum states the maximum.
formatint32
workspaces: optional [BetaTelemetryDestinationWorkspacesParams](https://platform.claude.com/docs/en/api/http/beta/organization/telemetry_destinations#beta_telemetry_destination_workspaces_params)
The new workspace scope, in the same form as on create. The field can't be `null`.
The API refuses an update that changes the type or sends `workspace_ids` while the destination's list has more than 750 workspaces. Remove workspaces one at a time until 750 or fewer remain, then send the update again.
One of the following:
##### Returns
BetaTelemetryDestination object{ type: "telemetry_destination", id, created_at, 8 more }
An OpenTelemetry destination: an OTLP/HTTP endpoint, the request headers sent with every delivery to it, what the exported spans contain, and which workspaces it covers. A destination belongs to an organization. A workspace's spans go to every enabled destination that covers it.
Update a Telemetry Destination
cURL
```python
curl https://api.anthropic.com/v1/organizations/telemetry_destinations/$DESTINATION_ID \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2026-10-21' \
-H 'anthropic-beta: telemetry-destinations-2026-08-11' \
-H "Authorization: Bearer $ANTHROPIC_API_KEY" \
-d '{}'
```
Response 200
```python
{
"id": "id",
"created_at": "2019-12-27T18:11:19.117Z",
"delivery_health": {
"last_error": "last_error",
"last_error_at": "2019-12-27T18:11:19.117Z",
"last_success_at": "2019-12-27T18:11:19.117Z"
},
"display_name": "display_name",
"endpoint_url": "endpoint_url",
"header_names": [
"string"
],
"state": {
"type": "enabled"
},
"traces": {
"content_mode": "metadata_only",
"enabled": true,
"endpoint_url": "endpoint_url",
"max_content_bytes": 0
},
"type": "telemetry_destination",
"updated_at": "2019-12-27T18:11:19.117Z",
"workspaces": {
"type": "all"
}
}
```
##### Returns Examples
Response 200
```python
{
"id": "id",
"created_at": "2019-12-27T18:11:19.117Z",
"delivery_health": {
"last_error": "last_error",
"last_error_at": "2019-12-27T18:11:19.117Z",
"last_success_at": "2019-12-27T18:11:19.117Z"
},
"display_name": "display_name",
"endpoint_url": "endpoint_url",
"header_names": [
"string"
],
"state": {
"type": "enabled"
},
"traces": {
"content_mode": "metadata_only",
"enabled": true,
"endpoint_url": "endpoint_url",
"max_content_bytes": 0
},
"type": "telemetry_destination",
"updated_at": "2019-12-27T18:11:19.117Z",
---
## Add a Telemetry Destination Workspace - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/telemetry_destinations/workspaces/add
Path: 04-API-Reference/Admin/beta-organization-telemetry-destinations-workspaces-add.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Ftelemetry_destinations%2Fworkspaces%2Fadd)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Create a Telemetry Destination
List Telemetry Destinations
Retrieve a Telemetry Destination
Update a Telemetry Destination
Delete a Telemetry Destination
Test a Telemetry Destination
Workspaces
List Telemetry Destination Workspaces
Add a Telemetry Destination Workspace
Remove a Telemetry Destination Workspace
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[AWS IAM actions](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[Migrating to API version 2026-10-21](../Endpoints/migration-2026-10-21.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
API version 2023-06-01
cURL
This page documents API version 2023-06-01. [See this page for the newer version, 2026-10-21](beta-organization-telemetry-destinations-workspaces-add.md), or read [what changed in 2026-10-21](../Endpoints/migration-2026-10-21.md).
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Telemetry Destinations](https://platform.claude.com/docs/en/api/http/beta/organization/telemetry_destinations)
5. [Workspaces](https://platform.claude.com/docs/en/api/http/beta/organization/telemetry_destinations/workspaces)
# Add a Telemetry Destination Workspace
Copy page
API version 2023-06-01
cURL
POST/v1/organizations/telemetry_destinations/{destination_id}/workspaces/{workspace_id}
Add one workspace to a destination's workspace list.
Under `include` the workspace's spans start going to the destination. Under `exclude` they stop. A list holds at most 1,000 workspaces.
Adding a workspace that is already on the list changes nothing and returns the existing entry. An archived workspace that isn't on the list yet can't be added. A destination whose `workspaces.type` is `all` doesn't have a list, so the API returns 400. To change which workspaces such a destination covers, update its `workspaces`.
See the [OpenTelemetry export guide](../Other/manage-claude-opentelemetry.md#choose-workspaces-for-a-destination) to learn more about choosing the workspaces of a destination.
##### Path parameters
destination_id: string
ID of the destination (`tdst_...`).
workspace_id: string
ID of the workspace to add (`wrkspc_...`).
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"anthropic-beta": optional array of [AnthropicBeta](../Endpoints/platform-claude-com-http-beta.md#anthropic_beta)
This endpoint is in beta: requests must send `telemetry-destinations-2026-08-11` in this header.
One of the following:
string
"message-batches-2024-09-24"
"prompt-caching-2024-07-31"
"computer-use-2024-10-22"
"computer-use-2025-01-24"
"pdfs-2024-09-25"
"token-counting-2024-11-01"
"token-efficient-tools-2025-02-19"
"output-128k-2025-02-19"
"files-api-2025-04-14"
"mcp-client-2025-04-04"
"mcp-client-2025-11-20"
"dev-full-thinking-2025-05-14"
"interleaved-thinking-2025-05-14"
"code-execution-2025-05-22"
"extended-cache-ttl-2025-04-11"
"context-1m-2025-08-07"
"context-management-2025-06-27"
"model-context-window-exceeded-2025-08-26"
"skills-2025-10-02"
"fast-mode-2026-02-01"
"output-300k-2026-03-24"
"user-profiles-2026-03-24"
"user-profiles-2026-08-18"
"user-profiles-2026-09-04"
"advisor-tool-2026-03-01"
"managed-agents-2026-04-01"
"cache-diagnosis-2026-04-07"
"dreaming-2026-04-21"
"thinking-token-count-2026-05-13"
"server-side-fallback-2026-06-01"
"server-side-fallback-2026-07-01"
"fallback-credit-2026-06-01"
"fallback-credit-2026-07-01"
"agent-memory-2026-07-22"
"mid-conversation-tool-changes-2026-07-01"
"compact-2026-01-12"
"computer-use-2025-11-24"
"mcp-tunnels-2026-06-22"
"structured-outputs-2025-11-13"
"task-budgets-2026-03-13"
"thinking-display-updates-2026-08-18"
"ce-user-management-2026-07-13"
"mid-conversation-output-config-2026-07-01"
"thinking-binding-controls-2026-08-01"
"mid-conversation-system-clear-at-2026-08-21"
"compact-2026-09-04"
"inline-tools-2026-09-15"
"mcp-client-2026-09-15"
"ce-plugins-2026-09-01"
"spend-limit-reads-2026-09-26"
"telemetry-destinations-2026-08-11"
"webhooks-2026-10-07"
##### Returns
BetaTelemetryDestinationWorkspace object{ type: "telemetry_destination_workspace", created_at, telemetry_destination_id, workspace_id }
A workspace on a telemetry destination's workspace list.
Under `include`, the destination covers the workspace. Under `exclude`, the destination covers every workspace except this one. The entry doesn't have an `id`. Its `telemetry_destination_id` and `workspace_id` together identify it.
type: "telemetry_destination_workspace"
created_at: string
Time the workspace was added to the list.
formatdate-time
telemetry_destination_id: string
ID of the telemetry destination (`tdst_...`).
workspace_id: string
ID of the workspace (`wrkspc_...`).
Add a Telemetry Destination Workspace
cURL
```python
curl https://api.anthropic.com/v1/organizations/telemetry_destinations/$DESTINATION_ID/workspaces/$WORKSPACE_ID \
-X POST \
-H 'anthropic-version: 2023-06-01' \
-H 'anthropic-beta: telemetry-destinations-2026-08-11' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"created_at": "2019-12-27T18:11:19.117Z",
"telemetry_destination_id": "telemetry_destination_id",
"type": "telemetry_destination_workspace",
"workspace_id": "workspace_id"
}
```
##### Returns Examples
Response 200
```python
{
"created_at": "2019-12-27T18:11:19.117Z",
"telemetry_destination_id": "telemetry_destination_id",
"type": "telemetry_destination_workspace",
"workspace_id": "workspace_id"
---
## List Telemetry Destination Workspaces - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/telemetry_destinations/workspaces/list
Path: 04-API-Reference/Admin/beta-organization-telemetry-destinations-workspaces-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Ftelemetry_destinations%2Fworkspaces%2Flist)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Create a Telemetry Destination
List Telemetry Destinations
Retrieve a Telemetry Destination
Update a Telemetry Destination
Delete a Telemetry Destination
Test a Telemetry Destination
Workspaces
List Telemetry Destination Workspaces
Add a Telemetry Destination Workspace
Remove a Telemetry Destination Workspace
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[AWS IAM actions](../Endpoints/claude-platform-on-aws-iam-actions.md)[Google Cloud IAM permissions](../Endpoints/claude-models-on-google-cloud-anthropic-managed-iam-permissions.md)[Versions](../Endpoints/versioning.md)[Migrating to API version 2026-10-21](../Endpoints/migration-2026-10-21.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
API version 2026-10-21
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Telemetry Destinations](https://platform.claude.com/docs/en/api/http/beta/organization/telemetry_destinations)
5. [Workspaces](https://platform.claude.com/docs/en/api/http/beta/organization/telemetry_destinations/workspaces)
# List Telemetry Destination Workspaces
Copy page
API version 2026-10-21
cURL
GET/v1/organizations/telemetry_destinations/{destination_id}/workspaces
List the workspaces on a destination's workspace list, newest entry first.
A destination whose `workspaces.type` is `all` doesn't have a list, so its page is empty. The list includes archived workspaces.
See the [OpenTelemetry export guide](../Other/manage-claude-opentelemetry.md#choose-workspaces-for-a-destination) to learn more about choosing the workspaces of a destination.
##### Path parameters
destination_id: string
ID of the destination (`tdst_...`).
##### Query parameters
limit: optional number
Number of entries to return per page, between 1 and 1,000. Defaults to 20.
formatint32
page: optional string
Opaque cursor from a previous response's `next_page`. Leave it out to get the first page.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"anthropic-beta": optional array of [AnthropicBeta](../Endpoints/platform-claude-com-http-beta.md#anthropic_beta)
This endpoint is in beta: requests must send `telemetry-destinations-2026-08-11` in this header.
One of the following:
string
"message-batches-2024-09-24"
"prompt-caching-2024-07-31"
"computer-use-2024-10-22"
"computer-use-2025-01-24"
"pdfs-2024-09-25"
"token-counting-2024-11-01"
"token-efficient-tools-2025-02-19"
"output-128k-2025-02-19"
"files-api-2025-04-14"
"mcp-client-2025-04-04"
"mcp-client-2025-11-20"
"dev-full-thinking-2025-05-14"
"interleaved-thinking-2025-05-14"
"code-execution-2025-05-22"
"extended-cache-ttl-2025-04-11"
"context-1m-2025-08-07"
"context-management-2025-06-27"
"model-context-window-exceeded-2025-08-26"
"skills-2025-10-02"
"fast-mode-2026-02-01"
"output-300k-2026-03-24"
"user-profiles-2026-03-24"
"user-profiles-2026-08-18"
"user-profiles-2026-09-04"
"advisor-tool-2026-03-01"
"managed-agents-2026-04-01"
"cache-diagnosis-2026-04-07"
"dreaming-2026-04-21"
"thinking-token-count-2026-05-13"
"server-side-fallback-2026-06-01"
"server-side-fallback-2026-07-01"
"fallback-credit-2026-06-01"
"fallback-credit-2026-07-01"
"agent-memory-2026-07-22"
"mid-conversation-tool-changes-2026-07-01"
"compact-2026-01-12"
"computer-use-2025-11-24"
"mcp-tunnels-2026-06-22"
"structured-outputs-2025-11-13"
"task-budgets-2026-03-13"
"thinking-display-updates-2026-08-18"
"ce-user-management-2026-07-13"
"mid-conversation-output-config-2026-07-01"
"thinking-binding-controls-2026-08-01"
"mid-conversation-system-clear-at-2026-08-21"
"compact-2026-09-04"
"inline-tools-2026-09-15"
"mcp-client-2026-09-15"
"ce-plugins-2026-09-01"
"spend-limit-reads-2026-09-26"
"telemetry-destinations-2026-08-11"
"webhooks-2026-10-07"
##### Returns
data: array of [BetaTelemetryDestinationWorkspace](https://platform.claude.com/docs/en/api/http/beta/organization/telemetry_destinations/workspaces#beta_telemetry_destination_workspace) { type: "telemetry_destination_workspace", created_at, telemetry_destination_id, workspace_id }
Entries on this page, newest first.
type: "telemetry_destination_workspace"
created_at: string
Time the workspace was added to the list.
formatdate-time
telemetry_destination_id: string
ID of the telemetry destination (`tdst_...`).
workspace_id: string
ID of the workspace (`wrkspc_...`).
next_page: string or null
Cursor for the next page. Null on the last page.
List Telemetry Destination Workspaces
cURL
```python
curl https://api.anthropic.com/v1/organizations/telemetry_destinations/$DESTINATION_ID/workspaces \
-H 'anthropic-version: 2026-10-21' \
-H 'anthropic-beta: telemetry-destinations-2026-08-11' \
-H "Authorization: Bearer $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"data": [
{
"created_at": "2019-12-27T18:11:19.117Z",
"telemetry_destination_id": "telemetry_destination_id",
"type": "telemetry_destination_workspace",
"workspace_id": "workspace_id"
}
],
"next_page": "next_page"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"created_at": "2019-12-27T18:11:19.117Z",
"telemetry_destination_id": "telemetry_destination_id",
"type": "telemetry_destination_workspace",
"workspace_id": "workspace_id"
---
## Remove a Telemetry Destination Workspace - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/telemetry_destinations/workspaces/remove
Path: 04-API-Reference/Admin/beta-organization-telemetry-destinations-workspaces-remove.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Ftelemetry_destinations%2Fworkspaces%2Fremove)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Create a Telemetry Destination
List Telemetry Destinations
Retrieve a Telemetry Destination
Update a Telemetry Destination
Delete a Telemetry Destination
Test a Telemetry Destination
Workspaces
List Telemetry Destination Workspaces
Add a Telemetry Destination Workspace
Remove a Telemetry Destination Workspace
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[AWS IAM actions](../Endpoints/claude-platform-on-aws-iam-actions.md)[Google Cloud IAM permissions](../Endpoints/claude-models-on-google-cloud-anthropic-managed-iam-permissions.md)[Versions](../Endpoints/versioning.md)[Migrating to API version 2026-10-21](../Endpoints/migration-2026-10-21.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
API version 2026-10-21
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Telemetry Destinations](https://platform.claude.com/docs/en/api/http/beta/organization/telemetry_destinations)
5. [Workspaces](https://platform.claude.com/docs/en/api/http/beta/organization/telemetry_destinations/workspaces)
# Remove a Telemetry Destination Workspace
Copy page
API version 2026-10-21
cURL
DELETE/v1/organizations/telemetry_destinations/{destination_id}/workspaces/{workspace_id}
Remove one workspace from a destination's workspace list.
Under `include` the workspace's spans stop going to the destination. Under `exclude` they start. An archived workspace can be removed too.
The API returns 404 when the workspace isn't on the list. A destination whose `workspaces.type` is `all` doesn't have a list, so the API returns 400.
See the [OpenTelemetry export guide](../Other/manage-claude-opentelemetry.md#choose-workspaces-for-a-destination) to learn more about choosing the workspaces of a destination.
##### Path parameters
destination_id: string
ID of the destination (`tdst_...`).
workspace_id: string
ID of the workspace to remove (`wrkspc_...`).
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"anthropic-beta": optional array of [AnthropicBeta](../Endpoints/platform-claude-com-http-beta.md#anthropic_beta)
This endpoint is in beta: requests must send `telemetry-destinations-2026-08-11` in this header.
One of the following:
string
"message-batches-2024-09-24"
"prompt-caching-2024-07-31"
"computer-use-2024-10-22"
"computer-use-2025-01-24"
"pdfs-2024-09-25"
"token-counting-2024-11-01"
"token-efficient-tools-2025-02-19"
"output-128k-2025-02-19"
"files-api-2025-04-14"
"mcp-client-2025-04-04"
"mcp-client-2025-11-20"
"dev-full-thinking-2025-05-14"
"interleaved-thinking-2025-05-14"
"code-execution-2025-05-22"
"extended-cache-ttl-2025-04-11"
"context-1m-2025-08-07"
"context-management-2025-06-27"
"model-context-window-exceeded-2025-08-26"
"skills-2025-10-02"
"fast-mode-2026-02-01"
"output-300k-2026-03-24"
"user-profiles-2026-03-24"
"user-profiles-2026-08-18"
"user-profiles-2026-09-04"
"advisor-tool-2026-03-01"
"managed-agents-2026-04-01"
"cache-diagnosis-2026-04-07"
"dreaming-2026-04-21"
"thinking-token-count-2026-05-13"
"server-side-fallback-2026-06-01"
"server-side-fallback-2026-07-01"
"fallback-credit-2026-06-01"
"fallback-credit-2026-07-01"
"agent-memory-2026-07-22"
"mid-conversation-tool-changes-2026-07-01"
"compact-2026-01-12"
"computer-use-2025-11-24"
"mcp-tunnels-2026-06-22"
"structured-outputs-2025-11-13"
"task-budgets-2026-03-13"
"thinking-display-updates-2026-08-18"
"ce-user-management-2026-07-13"
"mid-conversation-output-config-2026-07-01"
"thinking-binding-controls-2026-08-01"
"mid-conversation-system-clear-at-2026-08-21"
"compact-2026-09-04"
"inline-tools-2026-09-15"
"mcp-client-2026-09-15"
"ce-plugins-2026-09-01"
"spend-limit-reads-2026-09-26"
"telemetry-destinations-2026-08-11"
"webhooks-2026-10-07"
##### Returns
BetaDeletedTelemetryDestinationWorkspace object{ type: "telemetry_destination_workspace_deleted", telemetry_destination_id, workspace_id }
Confirmation that a workspace was removed from a destination's list.
type: "telemetry_destination_workspace_deleted"
telemetry_destination_id: string
ID of the telemetry destination (`tdst_...`).
workspace_id: string
ID of the workspace that was removed (`wrkspc_...`).
Remove a Telemetry Destination Workspace
cURL
```python
curl https://api.anthropic.com/v1/organizations/telemetry_destinations/$DESTINATION_ID/workspaces/$WORKSPACE_ID \
-X DELETE \
-H 'anthropic-version: 2026-10-21' \
-H 'anthropic-beta: telemetry-destinations-2026-08-11' \
-H "Authorization: Bearer $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"telemetry_destination_id": "telemetry_destination_id",
"type": "telemetry_destination_workspace_deleted",
"workspace_id": "workspace_id"
}
```
##### Returns Examples
Response 200
```python
{
"telemetry_destination_id": "telemetry_destination_id",
"type": "telemetry_destination_workspace_deleted",
"workspace_id": "workspace_id"
---
## Workspaces - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/telemetry_destinations/workspaces
Path: 04-API-Reference/Admin/beta-organization-telemetry-destinations-workspaces.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Ftelemetry_destinations%2Fworkspaces)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Create a Telemetry Destination
List Telemetry Destinations
Retrieve a Telemetry Destination
Update a Telemetry Destination
Delete a Telemetry Destination
Test a Telemetry Destination
Workspaces
List Telemetry Destination Workspaces
Add a Telemetry Destination Workspace
Remove a Telemetry Destination Workspace
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[AWS IAM actions](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[Migrating to API version 2026-10-21](../Endpoints/migration-2026-10-21.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
API version 2023-06-01
cURL
This page documents API version 2023-06-01. [See this page for the newer version, 2026-10-21](beta-organization-telemetry-destinations-workspaces.md), or read [what changed in 2026-10-21](../Endpoints/migration-2026-10-21.md).
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Telemetry Destinations](https://platform.claude.com/docs/en/api/http/beta/organization/telemetry_destinations)
# Workspaces
Copy page
API version 2023-06-01
cURL
##### [List Telemetry Destination Workspaces](https://platform.claude.com/docs/en/api/http/beta/organization/telemetry_destinations/workspaces/list)
GET/v1/organizations/telemetry_destinations/{destination_id}/workspaces
List the workspaces on a destination's workspace list, newest entry first.
##### [Add a Telemetry Destination Workspace](https://platform.claude.com/docs/en/api/http/beta/organization/telemetry_destinations/workspaces/add)
POST/v1/organizations/telemetry_destinations/{destination_id}/workspaces/{workspace_id}
Add one workspace to a destination's workspace list.
##### [Remove a Telemetry Destination Workspace](https://platform.claude.com/docs/en/api/http/beta/organization/telemetry_destinations/workspaces/remove)
DELETE/v1/organizations/telemetry_destinations/{destination_id}/workspaces/{workspace_id}
Remove one workspace from a destination's workspace list.
##### Models
BetaDeletedTelemetryDestinationWorkspace object{ type: "telemetry_destination_workspace_deleted", telemetry_destination_id, workspace_id }
Confirmation that a workspace was removed from a destination's list.
type: "telemetry_destination_workspace_deleted"
telemetry_destination_id: string
ID of the telemetry destination (`tdst_...`).
workspace_id: string
ID of the workspace that was removed (`wrkspc_...`).
BetaTelemetryDestinationWorkspace object{ type: "telemetry_destination_workspace", created_at, telemetry_destination_id, workspace_id }
A workspace on a telemetry destination's workspace list.
Under `include`, the destination covers the workspace. Under `exclude`, the destination covers every workspace except this one. The entry doesn't have an `id`. Its `telemetry_destination_id` and `workspace_id` together identify it.
type: "telemetry_destination_workspace"
created_at: string
Time the workspace was added to the list.
formatdate-time
telemetry_destination_id: string
ID of the telemetry destination (`tdst_...`).
workspace_id: string
ID of the workspace (`wrkspc_...`).
---
## Telemetry Destinations - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/telemetry_destinations
Path: 04-API-Reference/Admin/beta-organization-telemetry-destinations.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Ftelemetry_destinations)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Create a Telemetry Destination
List Telemetry Destinations
Retrieve a Telemetry Destination
Update a Telemetry Destination
Delete a Telemetry Destination
Test a Telemetry Destination
Workspaces
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[AWS IAM actions](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[Migrating to API version 2026-10-21](../Endpoints/migration-2026-10-21.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
API version 2023-06-01
cURL
This page documents API version 2023-06-01. [See this page for the newer version, 2026-10-21](beta-organization-telemetry-destinations.md), or read [what changed in 2026-10-21](../Endpoints/migration-2026-10-21.md).
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
# Telemetry Destinations
Copy page
API version 2023-06-01
cURL
##### [Create a Telemetry Destination](https://platform.claude.com/docs/en/api/http/beta/organization/telemetry_destinations/create)
POST/v1/organizations/telemetry_destinations
Register an OpenTelemetry destination for the organization.
##### [List Telemetry Destinations](https://platform.claude.com/docs/en/api/http/beta/organization/telemetry_destinations/list)
GET/v1/organizations/telemetry_destinations
List the organization's destinations, newest first, optionally only those that cover given workspaces.
##### [Retrieve a Telemetry Destination](https://platform.claude.com/docs/en/api/http/beta/organization/telemetry_destinations/retrieve)
GET/v1/organizations/telemetry_destinations/{destination_id}
Read a destination's configuration, state, and most recent delivery results.
##### [Update a Telemetry Destination](https://platform.claude.com/docs/en/api/http/beta/organization/telemetry_destinations/update)
POST/v1/organizations/telemetry_destinations/{destination_id}
Change a telemetry destination's settings, its state, or which workspaces it covers.
##### [Delete a Telemetry Destination](https://platform.claude.com/docs/en/api/http/beta/organization/telemetry_destinations/delete)
DELETE/v1/organizations/telemetry_destinations/{destination_id}
Delete a destination and its workspace list.
##### [Test a Telemetry Destination](https://platform.claude.com/docs/en/api/http/beta/organization/telemetry_destinations/test)
POST/v1/organizations/telemetry_destinations/{destination_id}/test
Send one test span, named `anthropic.test`, to the destination with its registered headers, once and without retries, and report the destination's answer. The response is 200 whether or not the destination answered with a 2xx status: its `result` has the type `success`, or the type `failure` and the reason in `error`. The destination's configuration, `state` and `delivery_health` do not change. A disabled destination can be tested too. Wait 10 seconds between tests of one destination; a request that comes sooner may be answered with status 429.
##### Models
BetaDeletedTelemetryDestination object{ type: "telemetry_destination_deleted", id }
Confirmation that a destination was deleted.
type: "telemetry_destination_deleted"
id: string
ID of the deleted destination (`tdst_...`).
BetaTelemetryDestination object{ type: "telemetry_destination", id, created_at, 8 more }
An OpenTelemetry destination: an OTLP/HTTP endpoint, the request headers sent with every delivery to it, what the exported spans contain, and which workspaces it covers. A destination belongs to an organization. A workspace's spans go to every enabled destination that covers it.
BetaTelemetryDestinationContentMode = "metadata_only" or "content"
What the spans that the API exports to a telemetry destination contain.
See the [OpenTelemetry export guide](../Other/manage-claude-opentelemetry.md#choose-a-content-mode) to learn what the spans contain in each content mode.
One of the following:
"metadata_only"
The spans contain identifiers, timing, status, token counts, and similar metadata. They don't contain prompt text, completion text, or tool inputs and outputs.
"content"
The spans contain the same metadata as `metadata_only`, plus message and tool content.
An organization with a data-handling restriction, such as under HIPAA, can't choose this mode. The API exports only metadata for such an organization, even to a destination that already has `content`.
BetaTelemetryDestinationDeliveryHealth object{ last_error, last_error_at, last_success_at }
The most recent delivery results that the API records for a telemetry destination.
Changes to the destination's configuration or state don't reset these fields. Changes to these fields don't change `updated_at`. The values can lag behind the latest deliveries.
See the [OpenTelemetry export guide](../Other/manage-claude-opentelemetry.md#delivery-and-health) to learn how the API delivers spans and when it disables a destination.
last_error: string or null
A message that describes the most recent failed delivery to the destination, or `null` if no delivery has failed yet.
Examples are `temporary DNS failure`, `TLS failure`, `timeout`, `connection failure`, `invalid address`, `HTTP error (status 503)`, and `redirect (status 301)`. The message is `invalid address` both for a hostname that doesn't exist and for an address that isn't publicly routable. It never contains the endpoint's response body, a header value, a network address, or TLS details.
`last_error` and `last_error_at` always change together. A later successful delivery doesn't clear them. If `last_success_at` is later than `last_error_at`, a delivery has succeeded since this failure.
See the [OpenTelemetry export guide](../Other/manage-claude-opentelemetry.md#delivery-errors) to learn the likely cause of each error.
last_error_at: string or null
Time of the failure that `last_error` describes. Changes together with `last_error`. Null until a delivery first fails.
formatdate-time
last_success_at: string or null
Time of the most recent successful delivery to the destination, or `null` if no delivery has succeeded yet.
formatdate-time
BetaTelemetryDestinationDisabledReason = [BetaTelemetryDestinationDisabledReasonCaller](https://platform.claude.com/docs/en/api/http/beta/organization/telemetry_destinations#beta_telemetry_destination_disabled_reason_caller) or [BetaTelemetryDestinationDisabledReasonSustainedFailure](https://platform.claude.com/docs/en/api/http/beta/organization/telemetry_destinations#beta_telemetry_destination_disabled_reason_sustained_failure) or [BetaTelemetryDestinationDisabledReasonInvalidAddress](https://platform.claude.com/docs/en/api/http/beta/organization/telemetry_destinations#beta_telemetry_destination_disabled_reason_invalid_address) or [BetaTelemetryDestinationDisabledReasonRedirect](https://platform.claude.com/docs/en/api/http/beta/organization/telemetry_destinations#beta_telemetry_destination_disabled_reason_redirect)
Why the destination is disabled: `caller` when a caller disabled it, or the reason the API disabled it automatically (`sustained_failure`, `invalid_address`, or `redirect`). Every automatic disable is reversible with an update that sets `state` to `enabled`. An update that sets `disabled` on a destination that is already disabled keeps its reason.
One of the following:
BetaTelemetryDestinationDisabledReasonCaller object{ type: "caller" }
A caller disabled the destination with an update that set `state` to `disabled`.
type: "caller"
BetaTelemetryDestinationDisabledReasonInvalidAddress object{ type: "invalid_address" }
The API disabled the destination because deliveries to it failed for longer than the same threshold as for `sustained_failure`, and the most recent failed delivery failed with an invalid address: the DNS answer says that the endpoint's hostname doesn't exist or doesn't have an address, or the address that the API would connect to isn't publicly routable or is reserved, for example a loopback, link-local, private-network, or cloud-metadata address. The API doesn't connect to such an address, and retries the delivery a bounded number of times as it does after a timeout. A timeout or a server failure of the DNS lookup is a temporary DNS failure instead, not an invalid address.
type: "invalid_address"
BetaTelemetryDestinationDisabledReasonRedirect object{ type: "redirect" }
The API disabled the destination because the endpoint answered a delivery with a 3xx status. Redirects are never followed, and one such answer disables the destination at once.
type: "redirect"
BetaTelemetryDestinationDisabledReasonSustainedFailure object{ type: "sustained_failure" }
The API disabled the destination because deliveries to it failed, with no successful delivery in between, for longer than a threshold that Anthropic configures and that is not part of this contract. The reason is `invalid_address` instead when the most recent failed delivery failed with an invalid address.
type: "sustained_failure"
BetaTelemetryDestinationState = [BetaTelemetryDestinationStateEnabled](https://platform.claude.com/docs/en/api/http/beta/organization/telemetry_destinations#beta_telemetry_destination_state_enabled) or [BetaTelemetryDestinationStateDisabled](https://platform.claude.com/docs/en/api/http/beta/organization/telemetry_destinations#beta_telemetry_destination_state_disabled)
Whether a telemetry destination receives deliveries.
A caller can set either state. The API also disables an enabled destination on its own in some cases. The `reason` of the disabled state says whether a caller or the API disabled the destination and, when the API did, why.
See the [OpenTelemetry export guide](../Other/manage-claude-opentelemetry.md#delivery-and-health) to learn when the API disables a destination.
One of the following:
BetaTelemetryDestinationStateEnabled object{ type: "enabled" }
The telemetry destination receives the spans of the workspaces that it covers.
type: "enabled"
BetaTelemetryDestinationStateDisabled object{ type: "disabled", reason }
The API doesn't deliver anything to the telemetry destination.
Spans produced while it is disabled aren't delivered later.
type: "disabled"
reason: [BetaTelemetryDestinationDisabledReason](https://platform.claude.com/docs/en/api/http/beta/organization/telemetry_destinations#beta_telemetry_destination_disabled_reason)
Whether a caller or the API disabled the destination and, when the API did, why. Read-only.
One of the following:
BetaTelemetryDestinationStateDisabled object{ type: "disabled", reason }
The API doesn't deliver anything to the telemetry destination.
Spans produced while it is disabled aren't delivered later.
type: "disabled"
reason: [BetaTelemetryDestinationDisabledReason](https://platform.claude.com/docs/en/api/http/beta/organization/telemetry_destinations#beta_telemetry_destination_disabled_reason)
Whether a caller or the API disabled the destination and, when the API did, why. Read-only.
One of the following:
BetaTelemetryDestinationStateDisabledParams object{ type: "disabled" }
Stop deliveries to the telemetry destination.
Spans produced while it is disabled aren't delivered later. A destination that is already disabled keeps its `reason`.
type: "disabled"
BetaTelemetryDestinationStateEnabled object{ type: "enabled" }
The telemetry destination receives the spans of the workspaces that it covers.
type: "enabled"
BetaTelemetryDestinationStateEnabledParams object{ type: "enabled" }
Start deliveries to the telemetry destination again.
This doesn't reset `delivery_health`.
type: "enabled"
BetaTelemetryDestinationStateParams = [BetaTelemetryDestinationStateEnabledParams](https://platform.claude.com/docs/en/api/http/beta/organization/telemetry_destinations#beta_telemetry_destination_state_enabled_params) or [BetaTelemetryDestinationStateDisabledParams](https://platform.claude.com/docs/en/api/http/beta/organization/telemetry_destinations#beta_telemetry_destination_state_disabled_params)
The state to set on a telemetry destination, by `type` alone.
A caller can't set the `reason` of a disabled state. Only the API sets it.
One of the following:
BetaTelemetryDestinationStateEnabledParams object{ type: "enabled" }
Start deliveries to the telemetry destination again.
This doesn't reset `delivery_health`.
type: "enabled"
BetaTelemetryDestinationStateDisabledParams object{ type: "disabled" }
Stop deliveries to the telemetry destination.
Spans produced while it is disabled aren't delivered later. A destination that is already disabled keeps its `reason`.
type: "disabled"
BetaTelemetryDestinationTestFailure object{ type: "failure", error }
The test span was not delivered.
type: "failure"
error: string
A message that describes why the test span was not delivered, including the HTTP status code when the destination returned one. Examples: `HTTP error (status 403)`, `timeout`, `TLS failure`. It has the same form as the destination's `delivery_health.last_error` and never contains the destination's response body, any header value, a network address, or TLS details.
BetaTelemetryDestinationTestResponse object{ type: "telemetry_destination_test", result }
The result of one test span sent to a destination.
type: "telemetry_destination_test"
result: [BetaTelemetryDestinationTestResult](https://platform.claude.com/docs/en/api/http/beta/organization/telemetry_destinations#beta_telemetry_destination_test_result)
How the test went: `success` when the destination answered with a 2xx status, else `failure` with the reason.
One of the following:
BetaTelemetryDestinationTestSuccess object{ type: "success" }
The destination answered the test span with a 2xx status.
type: "success"
BetaTelemetryDestinationTestFailure object{ type: "failure", error }
The test span was not delivered.
type: "failure"
error: string
A message that describes why the test span was not delivered, including the HTTP status code when the destination returned one. Examples: `HTTP error (status 403)`, `timeout`, `TLS failure`. It has the same form as the destination's `delivery_health.last_error` and never contains the destination's response body, any header value, a network address, or TLS details.
BetaTelemetryDestinationTestResult = [BetaTelemetryDestinationTestSuccess](https://platform.claude.com/docs/en/api/http/beta/organization/telemetry_destinations#beta_telemetry_destination_test_success) or [BetaTelemetryDestinationTestFailure](https://platform.claude.com/docs/en/api/http/beta/organization/telemetry_destinations#beta_telemetry_destination_test_failure)
The outcome of a test: `success`, or `failure` with the reason.
One of the following:
BetaTelemetryDestinationTestSuccess object{ type: "success" }
The destination answered the test span with a 2xx status.
type: "success"
BetaTelemetryDestinationTestFailure object{ type: "failure", error }
The test span was not delivered.
type: "failure"
error: string
A message that describes why the test span was not delivered, including the HTTP status code when the destination returned one. Examples: `HTTP error (status 403)`, `timeout`, `TLS failure`. It has the same form as the destination's `delivery_health.last_error` and never contains the destination's response body, any header value, a network address, or TLS details.
BetaTelemetryDestinationTestSuccess object{ type: "success" }
The destination answered the test span with a 2xx status.
type: "success"
BetaTelemetryDestinationTraces object{ content_mode, enabled, endpoint_url, max_content_bytes }
A telemetry destination's settings for the traces it receives.
content_mode: [BetaTelemetryDestinationContentMode](https://platform.claude.com/docs/en/api/http/beta/organization/telemetry_destinations#beta_telemetry_destination_content_mode)
What the exported spans contain.
One of the following:
"metadata_only"
The spans contain identifiers, timing, status, token counts, and similar metadata. They don't contain prompt text, completion text, or tool inputs and outputs.
"content"
The spans contain the same metadata as `metadata_only`, plus message and tool content.
An organization with a data-handling restriction, such as under HIPAA, can't choose this mode. The API exports only metadata for such an organization, even to a destination that already has `content`.
enabled: boolean
Whether the destination receives traces. A destination whose `enabled` is false keeps its other settings.
endpoint_url: string or null
The full URL that the API posts traces to, exactly as registered, or `null` if the destination doesn't have one.
When it is `null`, the API posts traces to `endpoint_url` with `/v1/traces` appended.
max_content_bytes: number or null
The most bytes of content that one exported span can contain, or `null` if only the API's maximum applies.
Content means model prompts and responses, and tool inputs and outputs. The API shortens longer content to this size before it delivers the span. A destination whose `content_mode` is `metadata_only` keeps this value. It applies once `content_mode` is `content`.
formatint32
BetaTelemetryDestinationTracesParams object{ content_mode, enabled, endpoint_url, max_content_bytes }
The settings for the traces that a telemetry destination receives, as a create or update request sets them. An omitted field takes its default on create and keeps its stored value on update.
content_mode: optional [BetaTelemetryDestinationContentMode](https://platform.claude.com/docs/en/api/http/beta/organization/telemetry_destinations#beta_telemetry_destination_content_mode) or null
What the exported spans contain. Defaults to `metadata_only` on create.
On update, `null` sets `metadata_only`.
One of the following:
"metadata_only"
The spans contain identifiers, timing, status, token counts, and similar metadata. They don't contain prompt text, completion text, or tool inputs and outputs.
"content"
The spans contain the same metadata as `metadata_only`, plus message and tool content.
An organization with a data-handling restriction, such as under HIPAA, can't choose this mode. The API exports only metadata for such an organization, even to a destination that already has `content`.
enabled: optional boolean
Whether the destination receives traces. Defaults to true on create. It cannot be null.
endpoint_url: optional string or null
The full URL of your collector's traces endpoint, for a collector that takes traces on a path other than `/v1/traces`. The API posts traces to it exactly as given and appends nothing.
The same rules as for `endpoint_url` apply, except that any path is allowed. It must have the same scheme, host, and port as `endpoint_url`. At most 2,048 characters.
On create, `null` is the same as leaving it out. On update, `null` removes it. The API then posts traces to `endpoint_url` with `/v1/traces` appended. A change of this URL alone keeps the registered headers.
maxLength2048
max_content_bytes: optional number or null
The most bytes of content that one exported span can contain, from 1 up to the API's maximum. `null` sets no bound, so only the API's maximum applies.
On create, leaving it out is the same as `null`. The error for a value above the maximum states the maximum.
formatint32
BetaTelemetryDestinationWorkspaces = [BetaTelemetryDestinationWorkspacesAll](https://platform.claude.com/docs/en/api/http/beta/organization/telemetry_destinations#beta_telemetry_destination_workspaces_all) or [BetaTelemetryDestinationWorkspacesInclude](https://platform.claude.com/docs/en/api/http/beta/organization/telemetry_destinations#beta_telemetry_destination_workspaces_include) or [BetaTelemetryDestinationWorkspacesExclude](https://platform.claude.com/docs/en/api/http/beta/organization/telemetry_destinations#beta_telemetry_destination_workspaces_exclude)
Which of the organization's workspaces a telemetry destination covers.
Several destinations can cover the same workspace. Each of them receives the workspace's spans while it is enabled.
The workspace list of an `include` or `exclude` destination isn't part of the destination object. List the destination's workspaces to read it. Add or remove one workspace at a time, or replace the whole list with an update. A list holds at most 1,000 workspaces.
One of the following:
BetaTelemetryDestinationWorkspacesAll object{ type: "all" }
The destination covers every workspace of the organization, including the default workspace, archived workspaces, and workspaces created later. It doesn't have a list.
type: "all"
BetaTelemetryDestinationWorkspacesInclude object{ type: "include" }
The destination covers the workspaces on its list, and no others.
type: "include"
BetaTelemetryDestinationWorkspacesExclude object{ type: "exclude" }
The destination covers every workspace of the organization except the workspaces on its list. A workspace created later is covered until it is added to the list.
type: "exclude"
BetaTelemetryDestinationWorkspacesAll object{ type: "all" }
The destination covers every workspace of the organization, including the default workspace, archived workspaces, and workspaces created later. It doesn't have a list.
type: "all"
BetaTelemetryDestinationWorkspacesAllParams object{ type: "all" }
Cover every workspace of the organization. Doesn't take `workspace_ids`.
An update that sets `all` empties the destination's workspace list.
type: "all"
BetaTelemetryDestinationWorkspacesExclude object{ type: "exclude" }
The destination covers every workspace of the organization except the workspaces on its list. A workspace created later is covered until it is added to the list.
type: "exclude"
BetaTelemetryDestinationWorkspacesExcludeParams object{ type: "exclude", workspace_ids }
Cover every workspace of the organization except the workspaces on the list.
type: "exclude"
workspace_ids: optional array of string
The IDs of the workspaces on the destination's list (`wrkspc_...`). At most 100 per request.
On create, these workspaces become the destination's list. If you leave `workspace_ids` out, the list starts empty. If the API refuses one of the IDs, it doesn't create the destination.
On update, `workspace_ids` replaces the whole list. A workspace that stays on the list keeps its entry and its `created_at`. An empty array empties the list. If you leave `workspace_ids` out and the type stays the same, the list doesn't change. If you leave it out and the type changes, the new list starts empty. After a change to `include` without `workspace_ids`, the destination doesn't cover any workspace until one is added. After a change to `exclude` without `workspace_ids`, it covers every workspace.
An ID sent more than once is added once. An archived workspace can't be added to a list. An update can keep an archived workspace that is already on the list.
BetaTelemetryDestinationWorkspacesInclude object{ type: "include" }
The destination covers the workspaces on its list, and no others.
type: "include"
BetaTelemetryDestinationWorkspacesIncludeParams object{ type: "include", workspace_ids }
Cover only the workspaces on the list.
type: "include"
workspace_ids: optional array of string
The IDs of the workspaces on the destination's list (`wrkspc_...`). At most 100 per request.
On create, these workspaces become the destination's list. If you leave `workspace_ids` out, the list starts empty. If the API refuses one of the IDs, it doesn't create the destination.
On update, `workspace_ids` replaces the whole list. A workspace that stays on the list keeps its entry and its `created_at`. An empty array empties the list. If you leave `workspace_ids` out and the type stays the same, the list doesn't change. If you leave it out and the type changes, the new list starts empty. After a change to `include` without `workspace_ids`, the destination doesn't cover any workspace until one is added. After a change to `exclude` without `workspace_ids`, it covers every workspace.
An ID sent more than once is added once. An archived workspace can't be added to a list. An update can keep an archived workspace that is already on the list.
BetaTelemetryDestinationWorkspacesParams = [BetaTelemetryDestinationWorkspacesAllParams](https://platform.claude.com/docs/en/api/http/beta/organization/telemetry_destinations#beta_telemetry_destination_workspaces_all_params) or [BetaTelemetryDestinationWorkspacesIncludeParams](https://platform.claude.com/docs/en/api/http/beta/organization/telemetry_destinations#beta_telemetry_destination_workspaces_include_params) or [BetaTelemetryDestinationWorkspacesExcludeParams](https://platform.claude.com/docs/en/api/http/beta/organization/telemetry_destinations#beta_telemetry_destination_workspaces_exclude_params)
Which of the organization's workspaces a telemetry destination covers, as a create or update request sets it.
One of the following:
#### Telemetry Destinations[Workspaces](https://platform.claude.com/docs/en/api/http/beta/organization/telemetry_destinations/workspaces)
##### [List Telemetry Destination Workspaces](https://platform.claude.com/docs/en/api/http/beta/organization/telemetry_destinations/workspaces/list)
GET/v1/organizations/telemetry_destinations/{destination_id}/workspaces
List the workspaces on a destination's workspace list, newest entry first.
##### [Add a Telemetry Destination Workspace](https://platform.claude.com/docs/en/api/http/beta/organization/telemetry_destinations/workspaces/add)
POST/v1/organizations/telemetry_destinations/{destination_id}/workspaces/{workspace_id}
Add one workspace to a destination's workspace list.
##### [Remove a Telemetry Destination Workspace](https://platform.claude.com/docs/en/api/http/beta/organization/telemetry_destinations/workspaces/remove)
DELETE/v1/organizations/telemetry_destinations/{destination_id}/workspaces/{workspace_id}
Remove one workspace from a destination's workspace list.
---
## Get Claude Code Usage Report - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/usage_report/retrieve_claude_code
Path: 04-API-Reference/Admin/beta-organization-usage-report-retrieve-claude-code.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fusage_report%2Fretrieve_claude_code)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Get Messages Usage Report
Get Claude Code Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Usage Report](https://platform.claude.com/docs/en/api/http/beta/organization/usage_report)
# Get Claude Code Usage Report
Copy page
cURL
GET/v1/organizations/usage_report/claude_code
Retrieve daily aggregated usage metrics for Claude Code users. Enables organizations to analyze developer productivity and build custom dashboards.
##### Query parameters
starting_at: string
UTC date in YYYY-MM-DD format. Returns metrics for this single day only.
formatdate
pattern^\d{4}-\d{2}-\d{2}\$
limit: optional number
Number of records per page (default: 20, max: 1000).
default20
minimum1
maximum1000
page: optional string
Opaque cursor token from previous response's `next_page` field.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
##### Returns
BetaClaudeCodeUsageReport object{ data, has_more, next_page }
Get Claude Code Usage Report
cURL
```python
curl https://api.anthropic.com/v1/organizations/usage_report/claude_code \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"data": [
{
"actor": {
"email_address": "user@emaildomain.com",
"type": "user_actor"
},
"core_metrics": {
"commits_by_claude_code": 8,
"lines_of_code": {
"added": 342,
"removed": 128
},
"num_sessions": 15,
"pull_requests_by_claude_code": 2
},
"customer_type": "api",
"date": "2025-08-08T00:00:00Z",
"is_remote": false,
"model_breakdown": [
{
"estimated_cost": {
"amount": 186,
"currency": "USD"
},
"model": "claude-opus-5-5",
"tokens": {
"cache_creation": 2340,
"cache_read": 8790,
"input": 45230,
"output": 12450
}
},
{
"estimated_cost": {
"amount": 42,
"currency": "USD"
},
"model": "claude-sonnet-5-5",
"tokens": {
"cache_creation": 890,
"cache_read": 3420,
"input": 23100,
"output": 5680
}
}
],
"organization_id": "12345678-1234-5678-1234-567812345678",
"terminal_type": "iTerm.app",
"tool_actions": {
"edit_tool": {
"accepted": 25,
"rejected": 3
},
"multi_edit_tool": {
"accepted": 12,
"rejected": 1
},
"notebook_edit_tool": {
"accepted": 5,
"rejected": 2
},
"write_tool": {
"accepted": 8,
"rejected": 0
}
},
"subscription_type": "enterprise"
}
],
"has_more": true,
"next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo="
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"actor": {
"email_address": "user@emaildomain.com",
"type": "user_actor"
},
"core_metrics": {
"commits_by_claude_code": 8,
"lines_of_code": {
"added": 342,
"removed": 128
},
"num_sessions": 15,
"pull_requests_by_claude_code": 2
},
"customer_type": "api",
"date": "2025-08-08T00:00:00Z",
"is_remote": false,
"model_breakdown": [
{
"estimated_cost": {
"amount": 186,
"currency": "USD"
},
"model": "claude-opus-5-5",
"tokens": {
"cache_creation": 2340,
"cache_read": 8790,
"input": 45230,
"output": 12450
}
},
{
"estimated_cost": {
"amount": 42,
"currency": "USD"
},
"model": "claude-sonnet-5-5",
"tokens": {
"cache_creation": 890,
"cache_read": 3420,
"input": 23100,
"output": 5680
}
}
],
"organization_id": "12345678-1234-5678-1234-567812345678",
"terminal_type": "iTerm.app",
"tool_actions": {
"edit_tool": {
"accepted": 25,
"rejected": 3
},
"multi_edit_tool": {
"accepted": 12,
"rejected": 1
},
"notebook_edit_tool": {
"accepted": 5,
"rejected": 2
},
"write_tool": {
"accepted": 8,
"rejected": 0
}
},
"subscription_type": "enterprise"
}
],
"has_more": true,
"next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo="
---
## Get Messages Usage Report - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/usage_report/retrieve_messages
Path: 04-API-Reference/Admin/beta-organization-usage-report-retrieve-messages.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fusage_report%2Fretrieve_messages)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Get Messages Usage Report
Get Claude Code Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Usage Report](https://platform.claude.com/docs/en/api/http/beta/organization/usage_report)
# Get Messages Usage Report
Copy page
cURL
GET/v1/organizations/usage_report/messages
Get Messages Usage Report
##### Query parameters
starting_at: string
Time buckets that start on or after this RFC 3339 timestamp will be returned. Each time bucket will be snapped to the start of the minute/hour/day in UTC.
formatdate-time
account_ids: optional array of string
Restrict usage returned to the specified user account ID(s).
api_key_ids: optional array of string
Restrict usage returned to the specified API key ID(s).
bucket_width: optional "1d" or "1h" or "1m"
Time granularity of the response data.
default1d
One of the following:
"1d"
"1h"
"1m"
context_window: optional array of [BetaAnalyticsContextWindow](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_context_window)
Restrict usage returned to the specified context window(s).
One of the following:
"0-200k"
"200k-1M"
ending_at: optional string
Time buckets that end before this RFC 3339 timestamp will be returned.
formatdate-time
group_by: optional array of "account_id" or "api_key_id" or "context_window" or 6 more
Group by any subset of the available options.
One of the following:
"account_id"
"api_key_id"
"context_window"
"inference_geo"
"model"
"service_account_id"
"service_tier"
"speed"
"workspace_id"
inference_geos: optional array of [BetaAnalyticsInferenceGeoFilter](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_inference_geo_filter)
Restrict usage returned to the specified inference geo(s). Use `not_available` for models that do not support specifying `inference_geo`.
One of the following:
"global"
"not_available"
"us"
limit: optional number
Maximum number of time buckets to return in the response.
The default and max limits depend on `bucket_width`: • `"1d"`: Default of 7 days, maximum of 31 days • `"1h"`: Default of 24 hours, maximum of 168 hours • `"1m"`: Default of 60 minutes, maximum of 1440 minutes
models: optional array of string
Restrict usage returned to the specified model(s).
page: optional string
Optionally set to the `next_page` token from the previous response.
service_account_ids: optional array of string
Restrict usage returned to the specified service account ID(s).
service_tiers: optional array of "batch" or "flex" or "flex_discount" or 3 more
Restrict usage returned to the specified service tier(s).
One of the following:
"batch"
"flex"
"flex_discount"
"priority"
"priority_on_demand"
"standard"
speeds: optional array of "standard" or "fast"
Restrict usage returned to the specified speed(s).
One of the following:
"standard"
"fast"
workspace_ids: optional array of string
Restrict usage returned to the specified workspace ID(s).
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"anthropic-beta": optional array of [AnthropicBeta](../Endpoints/platform-claude-com-http-beta.md#anthropic_beta)
Optional header to specify the beta version(s) you want to use.
One of the following:
string
"message-batches-2024-09-24"
"prompt-caching-2024-07-31"
"computer-use-2024-10-22"
"computer-use-2025-01-24"
"pdfs-2024-09-25"
"token-counting-2024-11-01"
"token-efficient-tools-2025-02-19"
"output-128k-2025-02-19"
"files-api-2025-04-14"
"mcp-client-2025-04-04"
"mcp-client-2025-11-20"
"dev-full-thinking-2025-05-14"
"interleaved-thinking-2025-05-14"
"code-execution-2025-05-22"
"extended-cache-ttl-2025-04-11"
"context-1m-2025-08-07"
"context-management-2025-06-27"
"model-context-window-exceeded-2025-08-26"
"skills-2025-10-02"
"fast-mode-2026-02-01"
"output-300k-2026-03-24"
"user-profiles-2026-03-24"
"user-profiles-2026-08-18"
"user-profiles-2026-09-04"
"advisor-tool-2026-03-01"
"managed-agents-2026-04-01"
"cache-diagnosis-2026-04-07"
"dreaming-2026-04-21"
"thinking-token-count-2026-05-13"
"server-side-fallback-2026-06-01"
"server-side-fallback-2026-07-01"
"fallback-credit-2026-06-01"
"fallback-credit-2026-07-01"
"agent-memory-2026-07-22"
"mid-conversation-tool-changes-2026-07-01"
"compact-2026-01-12"
"computer-use-2025-11-24"
"mcp-tunnels-2026-06-22"
"structured-outputs-2025-11-13"
"task-budgets-2026-03-13"
"thinking-display-updates-2026-08-18"
"ce-user-management-2026-07-13"
"mid-conversation-output-config-2026-07-01"
"thinking-binding-controls-2026-08-01"
"mid-conversation-system-clear-at-2026-08-21"
"compact-2026-09-04"
"inline-tools-2026-09-15"
"mcp-client-2026-09-15"
"ce-plugins-2026-09-01"
"spend-limit-reads-2026-09-26"
"telemetry-destinations-2026-08-11"
##### Returns
BetaMessagesUsageReport object{ data, has_more, next_page }
Get Messages Usage Report
cURL
```python
curl https://api.anthropic.com/v1/organizations/usage_report/messages \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"data": [
{
"ending_at": "2025-08-02T00:00:00Z",
"results": [
{
"account_id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"api_key_id": "apikey_01Rj2N8SVvo6BePZj99NhmiT",
"cache_creation": {
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 0
},
"cache_read_input_tokens": 200,
"context_window": "0-200k",
"inference_geo": "global",
"model": "claude-opus-5-5",
"output_tokens": 500,
"server_tool_use": {
"web_search_requests": 10
},
"service_account_id": "svac_01Hk3R9TWxq7CfQak00OiVw4",
"service_tier": "standard",
"speed": "standard",
"uncached_input_tokens": 1500,
"workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"
}
],
"starting_at": "2025-08-01T00:00:00Z"
}
],
"has_more": true,
"next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo="
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"ending_at": "2025-08-02T00:00:00Z",
"results": [
{
"account_id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"api_key_id": "apikey_01Rj2N8SVvo6BePZj99NhmiT",
"cache_creation": {
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 0
},
"cache_read_input_tokens": 200,
"context_window": "0-200k",
"inference_geo": "global",
"model": "claude-opus-5-5",
"output_tokens": 500,
"server_tool_use": {
"web_search_requests": 10
},
"service_account_id": "svac_01Hk3R9TWxq7CfQak00OiVw4",
"service_tier": "standard",
"speed": "standard",
"uncached_input_tokens": 1500,
"workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"
}
],
"starting_at": "2025-08-01T00:00:00Z"
}
],
"has_more": true,
"next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo="
---
## Usage Report - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/usage_report
Path: 04-API-Reference/Admin/beta-organization-usage-report.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fusage_report)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Get Messages Usage Report
Get Claude Code Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
# Usage Report
Copy page
cURL
##### [Get Messages Usage Report](https://platform.claude.com/docs/en/api/http/beta/organization/usage_report/retrieve_messages)
GET/v1/organizations/usage_report/messages
##### [Get Claude Code Usage Report](https://platform.claude.com/docs/en/api/http/beta/organization/usage_report/retrieve_claude_code)
GET/v1/organizations/usage_report/claude_code
Retrieve daily aggregated usage metrics for Claude Code users. Enables organizations to analyze developer productivity and build custom dashboards.
##### Models
BetaClaudeCodeUsageReport object{ data, has_more, next_page }
BetaMessagesUsageReport object{ data, has_more, next_page }
---
## List Users - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/users/list
Path: 04-API-Reference/Admin/beta-organization-users-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fusers%2Flist)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
List Users
Get User
Update User
Remove User
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Users](https://platform.claude.com/docs/en/api/http/beta/organization/users)
# List Users
Copy page
cURL
GET/v1/organizations/users
List the organization's members.
##### Query parameters
after_id: optional string
ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object.
before_id: optional string
ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object.
email: optional string
Filter by user email.
formatemail
limit: optional number
Number of items to return per page.
Defaults to `20`. Ranges from `1` to `1000`.
default20
minimum1
maximum1000
roles: optional array of string
Filter to items whose `role` equals one of the supplied values. Repeatable; values are OR'ed together.
Accepted values depend on the organization type: Console and API organizations accept `user`, `developer`, `billing`, `admin`, and `claude_code_user`; Claude Enterprise organizations accept `user`, `owner`, `primary_owner`, `membership_admin`, and `managed`.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
##### Returns
data: array of [BetaOrganizationUser](https://platform.claude.com/docs/en/api/http/beta/organization/users#beta_organization_user) { type: "user", id, added_at, 3 more }
type: "user"
Object type.
For Users, this is always `"user"`.
defaultuser
id: string
ID of the User.
added_at: string
RFC 3339 datetime string indicating when the User joined the Organization.
formatdate-time
email: string
Email of the User.
name: string
Name of the User.
role: [BetaOrganizationRole](platform-claude-com-http-beta-organization.md#beta_organization_role)
Organization role of the User.
One of the following:
"admin"
"billing"
"claude_code_user"
"developer"
"managed"
"membership_admin"
"owner"
"primary_owner"
"user"
first_id: string or null
First ID in the `data` list. Can be used as the `before_id` for the previous page.
has_more: boolean
Indicates if there are more results in the requested page direction.
last_id: string or null
Last ID in the `data` list. Can be used as the `after_id` for the next page.
List Users
cURL
```python
curl https://api.anthropic.com/v1/organizations/users \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"data": [
{
"id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"added_at": "2024-10-30T23:58:27.427722Z",
"email": "user@emaildomain.com",
"name": "Jane Doe",
"role": "admin",
"type": "user"
}
],
"first_id": "first_id",
"has_more": true,
"last_id": "last_id"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"added_at": "2024-10-30T23:58:27.427722Z",
"email": "user@emaildomain.com",
---
## Remove User - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/users/delete
Path: 04-API-Reference/Admin/beta-organization-users-remove.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fusers%2Fremove)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
List Users
Get User
Update User
Remove User
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Users](https://platform.claude.com/docs/en/api/http/beta/organization/users)
# Remove User
DELETE/v1/organizations/users/{user_id}
Remove a member from the organization.
##### Path parameters
user_id: string
ID of the User.
##### Returns
type: "user_deleted"
Deleted object type.
For Users, this is always `"user_deleted"`.
defaultuser_deleted
id: string
ID of the User.
Remove User
cURL
```python
curl https://api.anthropic.com/v1/organizations/users/$USER_ID \
-X DELETE \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"type": "user_deleted"
}
```
##### Returns Examples
Response 200
```python
{
"id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
---
## Get User - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/users/retrieve
Path: 04-API-Reference/Admin/beta-organization-users-retrieve.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fusers%2Fretrieve)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
List Users
Get User
Update User
Remove User
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Users](https://platform.claude.com/docs/en/api/http/beta/organization/users)
# Get User
Copy page
cURL
GET/v1/organizations/users/{user_id}
Retrieve a member of the organization by user ID.
##### Path parameters
user_id: string
ID of the User.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
##### Returns
BetaOrganizationUser object{ type: "user", id, added_at, 3 more }
type: "user"
Object type.
For Users, this is always `"user"`.
defaultuser
id: string
ID of the User.
added_at: string
RFC 3339 datetime string indicating when the User joined the Organization.
formatdate-time
email: string
Email of the User.
name: string
Name of the User.
role: [BetaOrganizationRole](platform-claude-com-http-beta-organization.md#beta_organization_role)
Organization role of the User.
One of the following:
"admin"
"billing"
"claude_code_user"
"developer"
"managed"
"membership_admin"
"owner"
"primary_owner"
"user"
Get User
cURL
```python
curl https://api.anthropic.com/v1/organizations/users/$USER_ID \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"added_at": "2024-10-30T23:58:27.427722Z",
"email": "user@emaildomain.com",
"name": "Jane Doe",
"role": "admin",
"type": "user"
}
```
##### Returns Examples
Response 200
```python
{
"id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"added_at": "2024-10-30T23:58:27.427722Z",
"email": "user@emaildomain.com",
---
## Update User - Claude API Reference
Source: https://platform.claude.com/docs/en/api/admin/users/update
Path: 04-API-Reference/Admin/beta-organization-users-update.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fusers%2Fupdate)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
List Users
Get User
Update User
Remove User
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Users](https://platform.claude.com/docs/en/api/http/beta/organization/users)
# Update User
POST/v1/organizations/users/{user_id}
Update a member's organization role.
##### Path parameters
user_id: string
ID of the User.
##### Body
role: "billing" or "claude_code_user" or "developer" or 2 more
New role for the User.
The accepted values depend on the organization type. Console and API organizations accept `user`, `developer`, `billing`, and `claude_code_user`; `admin` cannot be assigned through the API. Claude Enterprise organizations accept `user` and `managed`.
One of the following:
"billing"
"claude_code_user"
"developer"
"managed"
"user"
##### Returns
BetaOrganizationUser object{ type: "user", id, added_at, 3 more }
type: "user"
Object type.
For Users, this is always `"user"`.
defaultuser
id: string
ID of the User.
added_at: string
RFC 3339 datetime string indicating when the User joined the Organization.
formatdate-time
email: string
Email of the User.
name: string
Name of the User.
role: [BetaOrganizationRole](platform-claude-com-http-beta-organization.md#beta_organization_role)
Organization role of the User.
One of the following:
"admin"
"billing"
"claude_code_user"
"developer"
"managed"
"membership_admin"
"owner"
"primary_owner"
"user"
Update User
cURL
```python
curl https://api.anthropic.com/v1/organizations/users/$USER_ID \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY" \
-d '{
"role": "user"
}'
```
Response 200
```python
{
"id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"added_at": "2024-10-30T23:58:27.427722Z",
"email": "user@emaildomain.com",
"name": "Jane Doe",
"role": "admin",
"type": "user"
}
```
##### Returns Examples
Response 200
```python
{
"id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"added_at": "2024-10-30T23:58:27.427722Z",
"email": "user@emaildomain.com",
---
## Users - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/users
Path: 04-API-Reference/Admin/beta-organization-users.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fusers)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
List Users
Get User
Update User
Remove User
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
# Users
Copy page
cURL
##### [List Users](https://platform.claude.com/docs/en/api/http/beta/organization/users/list)
GET/v1/organizations/users
List the organization's members.
##### [Get User](https://platform.claude.com/docs/en/api/http/beta/organization/users/retrieve)
GET/v1/organizations/users/{user_id}
Retrieve a member of the organization by user ID.
##### [Update User](https://platform.claude.com/docs/en/api/http/beta/organization/users/update)
POST/v1/organizations/users/{user_id}
Update a member's organization role.
##### [Remove User](https://platform.claude.com/docs/en/api/http/beta/organization/users/remove)
DELETE/v1/organizations/users/{user_id}
Remove a member from the organization.
##### Models
BetaOrganizationUser object{ type: "user", id, added_at, 3 more }
type: "user"
Object type.
For Users, this is always `"user"`.
defaultuser
id: string
ID of the User.
added_at: string
RFC 3339 datetime string indicating when the User joined the Organization.
formatdate-time
email: string
Email of the User.
name: string
Name of the User.
role: [BetaOrganizationRole](platform-claude-com-http-beta-organization.md#beta_organization_role)
Organization role of the User.
One of the following:
"admin"
"billing"
"claude_code_user"
"developer"
"managed"
"membership_admin"
"owner"
"primary_owner"
"user"
UserRemoveResponse object{ type: "user_deleted", id }
type: "user_deleted"
Deleted object type.
For Users, this is always `"user_deleted"`.
defaultuser_deleted
id: string
ID of the User.
---
## Create Organization Webhook Endpoint - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/webhooks/create
Path: 04-API-Reference/Admin/beta-organization-webhooks-create.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fwebhooks%2Fcreate)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Create Organization Webhook Endpoint
List Organization Webhook Endpoints
Get Organization Webhook Endpoint
Update Organization Webhook Endpoint
Delete Organization Webhook Endpoint
Regenerate Organization Webhook Endpoint Signing Secret
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Webhooks](https://platform.claude.com/docs/en/api/http/beta/organization/webhooks)
# Create Organization Webhook Endpoint
Copy page
cURL
POST/v1/organizations/webhooks
Create an organization webhook endpoint.
An organization webhook endpoint belongs to the organization rather than to one of its workspaces. An organization can have at most 32 organization webhook endpoints, enabled or disabled.
The response includes the endpoint's signing secret. No read returns it, so store it when you receive it.
Every request must include the beta header `anthropic-beta: webhooks-2026-10-07`. A request without it returns `404`, exactly as if this API did not exist. Anthropic turns organization webhook endpoints on for each organization; until yours is on, requests also return `404`. Organization webhook endpoints are in beta and are not available to organizations with HIPAA readiness enabled.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"anthropic-beta": optional array of [AnthropicBeta](../Endpoints/platform-claude-com-http-beta.md#anthropic_beta)
This endpoint is in beta: requests must send `webhooks-2026-10-07` in this header.
One of the following:
string
"message-batches-2024-09-24"
"prompt-caching-2024-07-31"
"computer-use-2024-10-22"
"computer-use-2025-01-24"
"pdfs-2024-09-25"
"token-counting-2024-11-01"
"token-efficient-tools-2025-02-19"
"output-128k-2025-02-19"
"files-api-2025-04-14"
"mcp-client-2025-04-04"
"mcp-client-2025-11-20"
"dev-full-thinking-2025-05-14"
"interleaved-thinking-2025-05-14"
"code-execution-2025-05-22"
"extended-cache-ttl-2025-04-11"
"context-1m-2025-08-07"
"context-management-2025-06-27"
"model-context-window-exceeded-2025-08-26"
"skills-2025-10-02"
"fast-mode-2026-02-01"
"output-300k-2026-03-24"
"user-profiles-2026-03-24"
"user-profiles-2026-08-18"
"user-profiles-2026-09-04"
"advisor-tool-2026-03-01"
"managed-agents-2026-04-01"
"cache-diagnosis-2026-04-07"
"dreaming-2026-04-21"
"thinking-token-count-2026-05-13"
"server-side-fallback-2026-06-01"
"server-side-fallback-2026-07-01"
"fallback-credit-2026-06-01"
"fallback-credit-2026-07-01"
"agent-memory-2026-07-22"
"mid-conversation-tool-changes-2026-07-01"
"compact-2026-01-12"
"computer-use-2025-11-24"
"mcp-tunnels-2026-06-22"
"structured-outputs-2025-11-13"
"task-budgets-2026-03-13"
"thinking-display-updates-2026-08-18"
"ce-user-management-2026-07-13"
"mid-conversation-output-config-2026-07-01"
"thinking-binding-controls-2026-08-01"
"mid-conversation-system-clear-at-2026-08-21"
"compact-2026-09-04"
"inline-tools-2026-09-15"
"mcp-client-2026-09-15"
"ce-plugins-2026-09-01"
"spend-limit-reads-2026-09-26"
"telemetry-destinations-2026-08-11"
"webhooks-2026-10-07"
##### Body
enabled_events: array of "user_profile.enforcement_action_opened" or "user_profile.enforcement_action_resolved"
The event types to deliver to the endpoint. Must list at least one.
One of the following:
"user_profile.enforcement_action_opened"
"user_profile.enforcement_action_resolved"
url: string
The HTTPS URL that deliveries are sent to.
minLength1
description: optional string
Notes about the endpoint.
name: optional string
A short label for the endpoint.
##### Returns
BetaNewOrganizationWebhookEndpoint object{ id, created_at, description, 7 more }
A new organization webhook endpoint, with its signing secret.
Create Organization Webhook Endpoint
cURL
```python
curl https://api.anthropic.com/v1/organizations/webhooks \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H 'anthropic-beta: webhooks-2026-10-07' \
-H "X-Api-Key: $ANTHROPIC_API_KEY" \
-d '{
"enabled_events": [
"user_profile.enforcement_action_opened"
],
"url": "x"
}'
```
Response 200
```python
{
"id": "id",
"created_at": "2019-12-27T18:11:19.117Z",
"description": "description",
"disabled_reason": "disabled_reason",
"enabled_events": [
"user_profile.enforcement_action_opened"
],
"name": "name",
"signing_secret": "signing_secret",
"state": "disabled",
"updated_at": "2019-12-27T18:11:19.117Z",
"url": "url"
}
```
##### Returns Examples
Response 200
```python
{
"id": "id",
"created_at": "2019-12-27T18:11:19.117Z",
"description": "description",
"disabled_reason": "disabled_reason",
"enabled_events": [
"user_profile.enforcement_action_opened"
],
"name": "name",
"signing_secret": "signing_secret",
"state": "disabled",
"updated_at": "2019-12-27T18:11:19.117Z",
---
## Delete Organization Webhook Endpoint - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/webhooks/delete
Path: 04-API-Reference/Admin/beta-organization-webhooks-delete.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fwebhooks%2Fdelete)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Create Organization Webhook Endpoint
List Organization Webhook Endpoints
Get Organization Webhook Endpoint
Update Organization Webhook Endpoint
Delete Organization Webhook Endpoint
Regenerate Organization Webhook Endpoint Signing Secret
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Webhooks](https://platform.claude.com/docs/en/api/http/beta/organization/webhooks)
# Delete Organization Webhook Endpoint
Copy page
cURL
DELETE/v1/organizations/webhooks/{webhook_endpoint_id}
Delete an organization webhook endpoint.
Every request must include the beta header `anthropic-beta: webhooks-2026-10-07`. A request without it returns `404`, exactly as if this API did not exist. Anthropic turns organization webhook endpoints on for each organization; until yours is on, requests also return `404`. Organization webhook endpoints are in beta and are not available to organizations with HIPAA readiness enabled.
##### Path parameters
webhook_endpoint_id: string
ID of the webhook endpoint.
maxLength2048
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"anthropic-beta": optional array of [AnthropicBeta](../Endpoints/platform-claude-com-http-beta.md#anthropic_beta)
This endpoint is in beta: requests must send `webhooks-2026-10-07` in this header.
One of the following:
string
"message-batches-2024-09-24"
"prompt-caching-2024-07-31"
"computer-use-2024-10-22"
"computer-use-2025-01-24"
"pdfs-2024-09-25"
"token-counting-2024-11-01"
"token-efficient-tools-2025-02-19"
"output-128k-2025-02-19"
"files-api-2025-04-14"
"mcp-client-2025-04-04"
"mcp-client-2025-11-20"
"dev-full-thinking-2025-05-14"
"interleaved-thinking-2025-05-14"
"code-execution-2025-05-22"
"extended-cache-ttl-2025-04-11"
"context-1m-2025-08-07"
"context-management-2025-06-27"
"model-context-window-exceeded-2025-08-26"
"skills-2025-10-02"
"fast-mode-2026-02-01"
"output-300k-2026-03-24"
"user-profiles-2026-03-24"
"user-profiles-2026-08-18"
"user-profiles-2026-09-04"
"advisor-tool-2026-03-01"
"managed-agents-2026-04-01"
"cache-diagnosis-2026-04-07"
"dreaming-2026-04-21"
"thinking-token-count-2026-05-13"
"server-side-fallback-2026-06-01"
"server-side-fallback-2026-07-01"
"fallback-credit-2026-06-01"
"fallback-credit-2026-07-01"
"agent-memory-2026-07-22"
"mid-conversation-tool-changes-2026-07-01"
"compact-2026-01-12"
"computer-use-2025-11-24"
"mcp-tunnels-2026-06-22"
"structured-outputs-2025-11-13"
"task-budgets-2026-03-13"
"thinking-display-updates-2026-08-18"
"ce-user-management-2026-07-13"
"mid-conversation-output-config-2026-07-01"
"thinking-binding-controls-2026-08-01"
"mid-conversation-system-clear-at-2026-08-21"
"compact-2026-09-04"
"inline-tools-2026-09-15"
"mcp-client-2026-09-15"
"ce-plugins-2026-09-01"
"spend-limit-reads-2026-09-26"
"telemetry-destinations-2026-08-11"
"webhooks-2026-10-07"
##### Returns
BetaDeletedOrganizationWebhookEndpoint object{ type: "webhook_endpoint_deleted", id }
A deleted organization webhook endpoint.
type: "webhook_endpoint_deleted"
Always `webhook_endpoint_deleted`.
defaultwebhook_endpoint_deleted
id: string
ID of the deleted webhook endpoint.
Delete Organization Webhook Endpoint
cURL
```python
curl https://api.anthropic.com/v1/organizations/webhooks/$WEBHOOK_ENDPOINT_ID \
-X DELETE \
-H 'anthropic-version: 2023-06-01' \
-H 'anthropic-beta: webhooks-2026-10-07' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"id": "id",
"type": "webhook_endpoint_deleted"
}
```
##### Returns Examples
Response 200
```python
{
"id": "id",
"type": "webhook_endpoint_deleted"
---
## List Organization Webhook Endpoints - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/webhooks/list
Path: 04-API-Reference/Admin/beta-organization-webhooks-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fwebhooks%2Flist)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Create Organization Webhook Endpoint
List Organization Webhook Endpoints
Get Organization Webhook Endpoint
Update Organization Webhook Endpoint
Delete Organization Webhook Endpoint
Regenerate Organization Webhook Endpoint Signing Secret
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Webhooks](https://platform.claude.com/docs/en/api/http/beta/organization/webhooks)
# List Organization Webhook Endpoints
Copy page
cURL
GET/v1/organizations/webhooks
List the organization's webhook endpoints.
An organization webhook endpoint belongs to the organization rather than to one of its workspaces. The list does not include webhook endpoints that belong to a workspace.
Every request must include the beta header `anthropic-beta: webhooks-2026-10-07`. A request without it returns `404`, exactly as if this API did not exist. Anthropic turns organization webhook endpoints on for each organization; until yours is on, requests also return `404`. Organization webhook endpoints are in beta and are not available to organizations with HIPAA readiness enabled.
##### Query parameters
after_id: optional string
ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object.
before_id: optional string
ID of a webhook endpoint to use as a cursor. Returns the first `limit` endpoints that come before it in list order, not the `limit` endpoints just before it.
limit: optional number
Number of items to return per page, up to `100`. The default, `0`, means `20`.
default0
minimum0
maximum100
order: optional "asc" or "desc"
Sort order by `created_at`. Defaults to `desc`, newest first.
One of the following:
"asc"
"desc"
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"anthropic-beta": optional array of [AnthropicBeta](../Endpoints/platform-claude-com-http-beta.md#anthropic_beta)
This endpoint is in beta: requests must send `webhooks-2026-10-07` in this header.
One of the following:
string
"message-batches-2024-09-24"
"prompt-caching-2024-07-31"
"computer-use-2024-10-22"
"computer-use-2025-01-24"
"pdfs-2024-09-25"
"token-counting-2024-11-01"
"token-efficient-tools-2025-02-19"
"output-128k-2025-02-19"
"files-api-2025-04-14"
"mcp-client-2025-04-04"
"mcp-client-2025-11-20"
"dev-full-thinking-2025-05-14"
"interleaved-thinking-2025-05-14"
"code-execution-2025-05-22"
"extended-cache-ttl-2025-04-11"
"context-1m-2025-08-07"
"context-management-2025-06-27"
"model-context-window-exceeded-2025-08-26"
"skills-2025-10-02"
"fast-mode-2026-02-01"
"output-300k-2026-03-24"
"user-profiles-2026-03-24"
"user-profiles-2026-08-18"
"user-profiles-2026-09-04"
"advisor-tool-2026-03-01"
"managed-agents-2026-04-01"
"cache-diagnosis-2026-04-07"
"dreaming-2026-04-21"
"thinking-token-count-2026-05-13"
"server-side-fallback-2026-06-01"
"server-side-fallback-2026-07-01"
"fallback-credit-2026-06-01"
"fallback-credit-2026-07-01"
"agent-memory-2026-07-22"
"mid-conversation-tool-changes-2026-07-01"
"compact-2026-01-12"
"computer-use-2025-11-24"
"mcp-tunnels-2026-06-22"
"structured-outputs-2025-11-13"
"task-budgets-2026-03-13"
"thinking-display-updates-2026-08-18"
"ce-user-management-2026-07-13"
"mid-conversation-output-config-2026-07-01"
"thinking-binding-controls-2026-08-01"
"mid-conversation-system-clear-at-2026-08-21"
"compact-2026-09-04"
"inline-tools-2026-09-15"
"mcp-client-2026-09-15"
"ce-plugins-2026-09-01"
"spend-limit-reads-2026-09-26"
"telemetry-destinations-2026-08-11"
"webhooks-2026-10-07"
##### Returns
data: array of [BetaOrganizationWebhookEndpoint](https://platform.claude.com/docs/en/api/http/beta/organization/webhooks#beta_organization_webhook_endpoint) { id, created_at, description, 6 more }
The organization webhook endpoints on this page.
id: string
ID of the webhook endpoint.
created_at: string
When the endpoint was created, in RFC 3339 format.
formatdate-time
description: string
Notes about the endpoint. An empty string when none were given.
disabled_reason: string
Why Anthropic disabled the endpoint automatically. An empty string when the endpoint is enabled, or when you disabled it.
enabled_events: array of "user_profile.enforcement_action_opened" or "user_profile.enforcement_action_resolved"
The event types delivered to the endpoint.
One of the following:
"user_profile.enforcement_action_opened"
"user_profile.enforcement_action_resolved"
name: string
A short label for the endpoint. An empty string when none was given.
state: [BetaOrganizationWebhookEndpointState](https://platform.claude.com/docs/en/api/http/beta/organization/webhooks#beta_organization_webhook_endpoint_state)
Whether deliveries are sent to the endpoint.
One of the following:
"disabled"
"enabled"
updated_at: string
When the endpoint was last changed, in RFC 3339 format.
formatdate-time
url: string
The HTTPS URL that deliveries are sent to.
has_more: boolean
Whether more endpoints follow this page in list order. With `before_id`, only endpoints before the cursor count.
first_id: optional string or null
First ID in the `data` list.
last_id: optional string or null
Last ID in the `data` list. Can be used as the `after_id` for the next page.
List Organization Webhook Endpoints
cURL
```python
curl https://api.anthropic.com/v1/organizations/webhooks \
-H 'anthropic-version: 2023-06-01' \
-H 'anthropic-beta: webhooks-2026-10-07' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"data": [
{
"id": "id",
"created_at": "2019-12-27T18:11:19.117Z",
"description": "description",
"disabled_reason": "disabled_reason",
"enabled_events": [
"user_profile.enforcement_action_opened"
],
"name": "name",
"state": "disabled",
"updated_at": "2019-12-27T18:11:19.117Z",
"url": "url"
}
],
"has_more": true,
"first_id": "first_id",
"last_id": "last_id"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"id": "id",
"created_at": "2019-12-27T18:11:19.117Z",
"description": "description",
"disabled_reason": "disabled_reason",
"enabled_events": [
"user_profile.enforcement_action_opened"
],
"name": "name",
"state": "disabled",
"updated_at": "2019-12-27T18:11:19.117Z",
---
## Regenerate Organization Webhook Endpoint Signing Secret - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/webhooks/regenerate_signing_secret
Path: 04-API-Reference/Admin/beta-organization-webhooks-regenerate-signing-secret.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fwebhooks%2Fregenerate_signing_secret)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Create Organization Webhook Endpoint
List Organization Webhook Endpoints
Get Organization Webhook Endpoint
Update Organization Webhook Endpoint
Delete Organization Webhook Endpoint
Regenerate Organization Webhook Endpoint Signing Secret
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Webhooks](https://platform.claude.com/docs/en/api/http/beta/organization/webhooks)
# Regenerate Organization Webhook Endpoint Signing Secret
Copy page
cURL
POST/v1/organizations/webhooks/{webhook_endpoint_id}/regenerate_signing_secret
Replace an organization webhook endpoint's signing secret. The old secret stops working immediately. The new secret is returned only in this response.
Every request must include the beta header `anthropic-beta: webhooks-2026-10-07`. A request without it returns `404`, exactly as if this API did not exist. Anthropic turns organization webhook endpoints on for each organization; until yours is on, requests also return `404`. Organization webhook endpoints are in beta and are not available to organizations with HIPAA readiness enabled.
##### Path parameters
webhook_endpoint_id: string
ID of the webhook endpoint.
maxLength2048
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"anthropic-beta": optional array of [AnthropicBeta](../Endpoints/platform-claude-com-http-beta.md#anthropic_beta)
This endpoint is in beta: requests must send `webhooks-2026-10-07` in this header.
One of the following:
string
"message-batches-2024-09-24"
"prompt-caching-2024-07-31"
"computer-use-2024-10-22"
"computer-use-2025-01-24"
"pdfs-2024-09-25"
"token-counting-2024-11-01"
"token-efficient-tools-2025-02-19"
"output-128k-2025-02-19"
"files-api-2025-04-14"
"mcp-client-2025-04-04"
"mcp-client-2025-11-20"
"dev-full-thinking-2025-05-14"
"interleaved-thinking-2025-05-14"
"code-execution-2025-05-22"
"extended-cache-ttl-2025-04-11"
"context-1m-2025-08-07"
"context-management-2025-06-27"
"model-context-window-exceeded-2025-08-26"
"skills-2025-10-02"
"fast-mode-2026-02-01"
"output-300k-2026-03-24"
"user-profiles-2026-03-24"
"user-profiles-2026-08-18"
"user-profiles-2026-09-04"
"advisor-tool-2026-03-01"
"managed-agents-2026-04-01"
"cache-diagnosis-2026-04-07"
"dreaming-2026-04-21"
"thinking-token-count-2026-05-13"
"server-side-fallback-2026-06-01"
"server-side-fallback-2026-07-01"
"fallback-credit-2026-06-01"
"fallback-credit-2026-07-01"
"agent-memory-2026-07-22"
"mid-conversation-tool-changes-2026-07-01"
"compact-2026-01-12"
"computer-use-2025-11-24"
"mcp-tunnels-2026-06-22"
"structured-outputs-2025-11-13"
"task-budgets-2026-03-13"
"thinking-display-updates-2026-08-18"
"ce-user-management-2026-07-13"
"mid-conversation-output-config-2026-07-01"
"thinking-binding-controls-2026-08-01"
"mid-conversation-system-clear-at-2026-08-21"
"compact-2026-09-04"
"inline-tools-2026-09-15"
"mcp-client-2026-09-15"
"ce-plugins-2026-09-01"
"spend-limit-reads-2026-09-26"
"telemetry-destinations-2026-08-11"
"webhooks-2026-10-07"
##### Returns
BetaOrganizationWebhookEndpointSigningSecret object{ signing_secret }
An organization webhook endpoint's new signing secret.
signing_secret: string
The new signing secret. Deliveries are signed with it from now on, and no other response returns it.
Regenerate Organization Webhook Endpoint Signing Secret
cURL
```python
curl https://api.anthropic.com/v1/organizations/webhooks/$WEBHOOK_ENDPOINT_ID/regenerate_signing_secret \
-X POST \
-H 'anthropic-version: 2023-06-01' \
-H 'anthropic-beta: webhooks-2026-10-07' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"signing_secret": "signing_secret"
}
```
##### Returns Examples
Response 200
```python
{
"signing_secret": "signing_secret"
---
## Get Organization Webhook Endpoint - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/webhooks/retrieve
Path: 04-API-Reference/Admin/beta-organization-webhooks-retrieve.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fwebhooks%2Fretrieve)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Create Organization Webhook Endpoint
List Organization Webhook Endpoints
Get Organization Webhook Endpoint
Update Organization Webhook Endpoint
Delete Organization Webhook Endpoint
Regenerate Organization Webhook Endpoint Signing Secret
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Webhooks](https://platform.claude.com/docs/en/api/http/beta/organization/webhooks)
# Get Organization Webhook Endpoint
Copy page
cURL
GET/v1/organizations/webhooks/{webhook_endpoint_id}
Retrieve an organization webhook endpoint by ID.
Every request must include the beta header `anthropic-beta: webhooks-2026-10-07`. A request without it returns `404`, exactly as if this API did not exist. Anthropic turns organization webhook endpoints on for each organization; until yours is on, requests also return `404`. Organization webhook endpoints are in beta and are not available to organizations with HIPAA readiness enabled.
##### Path parameters
webhook_endpoint_id: string
ID of the webhook endpoint.
maxLength2048
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"anthropic-beta": optional array of [AnthropicBeta](../Endpoints/platform-claude-com-http-beta.md#anthropic_beta)
This endpoint is in beta: requests must send `webhooks-2026-10-07` in this header.
One of the following:
string
"message-batches-2024-09-24"
"prompt-caching-2024-07-31"
"computer-use-2024-10-22"
"computer-use-2025-01-24"
"pdfs-2024-09-25"
"token-counting-2024-11-01"
"token-efficient-tools-2025-02-19"
"output-128k-2025-02-19"
"files-api-2025-04-14"
"mcp-client-2025-04-04"
"mcp-client-2025-11-20"
"dev-full-thinking-2025-05-14"
"interleaved-thinking-2025-05-14"
"code-execution-2025-05-22"
"extended-cache-ttl-2025-04-11"
"context-1m-2025-08-07"
"context-management-2025-06-27"
"model-context-window-exceeded-2025-08-26"
"skills-2025-10-02"
"fast-mode-2026-02-01"
"output-300k-2026-03-24"
"user-profiles-2026-03-24"
"user-profiles-2026-08-18"
"user-profiles-2026-09-04"
"advisor-tool-2026-03-01"
"managed-agents-2026-04-01"
"cache-diagnosis-2026-04-07"
"dreaming-2026-04-21"
"thinking-token-count-2026-05-13"
"server-side-fallback-2026-06-01"
"server-side-fallback-2026-07-01"
"fallback-credit-2026-06-01"
"fallback-credit-2026-07-01"
"agent-memory-2026-07-22"
"mid-conversation-tool-changes-2026-07-01"
"compact-2026-01-12"
"computer-use-2025-11-24"
"mcp-tunnels-2026-06-22"
"structured-outputs-2025-11-13"
"task-budgets-2026-03-13"
"thinking-display-updates-2026-08-18"
"ce-user-management-2026-07-13"
"mid-conversation-output-config-2026-07-01"
"thinking-binding-controls-2026-08-01"
"mid-conversation-system-clear-at-2026-08-21"
"compact-2026-09-04"
"inline-tools-2026-09-15"
"mcp-client-2026-09-15"
"ce-plugins-2026-09-01"
"spend-limit-reads-2026-09-26"
"telemetry-destinations-2026-08-11"
"webhooks-2026-10-07"
##### Returns
BetaOrganizationWebhookEndpoint object{ id, created_at, description, 6 more }
A webhook endpoint that belongs to the organization rather than to one of its workspaces.
Get Organization Webhook Endpoint
cURL
```python
curl https://api.anthropic.com/v1/organizations/webhooks/$WEBHOOK_ENDPOINT_ID \
-H 'anthropic-version: 2023-06-01' \
-H 'anthropic-beta: webhooks-2026-10-07' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"id": "id",
"created_at": "2019-12-27T18:11:19.117Z",
"description": "description",
"disabled_reason": "disabled_reason",
"enabled_events": [
"user_profile.enforcement_action_opened"
],
"name": "name",
"state": "disabled",
"updated_at": "2019-12-27T18:11:19.117Z",
"url": "url"
}
```
##### Returns Examples
Response 200
```python
{
"id": "id",
"created_at": "2019-12-27T18:11:19.117Z",
"description": "description",
"disabled_reason": "disabled_reason",
"enabled_events": [
"user_profile.enforcement_action_opened"
],
"name": "name",
"state": "disabled",
"updated_at": "2019-12-27T18:11:19.117Z",
---
## Update Organization Webhook Endpoint - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/webhooks/update
Path: 04-API-Reference/Admin/beta-organization-webhooks-update.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fwebhooks%2Fupdate)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Create Organization Webhook Endpoint
List Organization Webhook Endpoints
Get Organization Webhook Endpoint
Update Organization Webhook Endpoint
Delete Organization Webhook Endpoint
Regenerate Organization Webhook Endpoint Signing Secret
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Webhooks](https://platform.claude.com/docs/en/api/http/beta/organization/webhooks)
# Update Organization Webhook Endpoint
Copy page
cURL
POST/v1/organizations/webhooks/{webhook_endpoint_id}
Update an organization webhook endpoint. Only the fields you send are changed.
Every request must include the beta header `anthropic-beta: webhooks-2026-10-07`. A request without it returns `404`, exactly as if this API did not exist. Anthropic turns organization webhook endpoints on for each organization; until yours is on, requests also return `404`. Organization webhook endpoints are in beta and are not available to organizations with HIPAA readiness enabled.
##### Path parameters
webhook_endpoint_id: string
ID of the webhook endpoint.
maxLength2048
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"anthropic-beta": optional array of [AnthropicBeta](../Endpoints/platform-claude-com-http-beta.md#anthropic_beta)
This endpoint is in beta: requests must send `webhooks-2026-10-07` in this header.
One of the following:
string
"message-batches-2024-09-24"
"prompt-caching-2024-07-31"
"computer-use-2024-10-22"
"computer-use-2025-01-24"
"pdfs-2024-09-25"
"token-counting-2024-11-01"
"token-efficient-tools-2025-02-19"
"output-128k-2025-02-19"
"files-api-2025-04-14"
"mcp-client-2025-04-04"
"mcp-client-2025-11-20"
"dev-full-thinking-2025-05-14"
"interleaved-thinking-2025-05-14"
"code-execution-2025-05-22"
"extended-cache-ttl-2025-04-11"
"context-1m-2025-08-07"
"context-management-2025-06-27"
"model-context-window-exceeded-2025-08-26"
"skills-2025-10-02"
"fast-mode-2026-02-01"
"output-300k-2026-03-24"
"user-profiles-2026-03-24"
"user-profiles-2026-08-18"
"user-profiles-2026-09-04"
"advisor-tool-2026-03-01"
"managed-agents-2026-04-01"
"cache-diagnosis-2026-04-07"
"dreaming-2026-04-21"
"thinking-token-count-2026-05-13"
"server-side-fallback-2026-06-01"
"server-side-fallback-2026-07-01"
"fallback-credit-2026-06-01"
"fallback-credit-2026-07-01"
"agent-memory-2026-07-22"
"mid-conversation-tool-changes-2026-07-01"
"compact-2026-01-12"
"computer-use-2025-11-24"
"mcp-tunnels-2026-06-22"
"structured-outputs-2025-11-13"
"task-budgets-2026-03-13"
"thinking-display-updates-2026-08-18"
"ce-user-management-2026-07-13"
"mid-conversation-output-config-2026-07-01"
"thinking-binding-controls-2026-08-01"
"mid-conversation-system-clear-at-2026-08-21"
"compact-2026-09-04"
"inline-tools-2026-09-15"
"mcp-client-2026-09-15"
"ce-plugins-2026-09-01"
"spend-limit-reads-2026-09-26"
"telemetry-destinations-2026-08-11"
"webhooks-2026-10-07"
##### Body
description: optional string
Notes about the endpoint.
enabled_events: optional array of "user_profile.enforcement_action_opened" or "user_profile.enforcement_action_resolved"
The event types to deliver to the endpoint. Replaces the whole set; an empty list leaves it unchanged.
One of the following:
"user_profile.enforcement_action_opened"
"user_profile.enforcement_action_resolved"
name: optional string
A short label for the endpoint.
state: optional "disabled" or "enabled"
`disabled` stops deliveries. `enabled` resumes them and clears `disabled_reason`. Events that happen while the endpoint is disabled are never delivered.
One of the following:
"disabled"
"enabled"
url: optional string
The HTTPS URL that deliveries are sent to.
minLength1
##### Returns
BetaOrganizationWebhookEndpoint object{ id, created_at, description, 6 more }
A webhook endpoint that belongs to the organization rather than to one of its workspaces.
Update Organization Webhook Endpoint
cURL
```python
curl https://api.anthropic.com/v1/organizations/webhooks/$WEBHOOK_ENDPOINT_ID \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H 'anthropic-beta: webhooks-2026-10-07' \
-H "X-Api-Key: $ANTHROPIC_API_KEY" \
-d '{}'
```
Response 200
```python
{
"id": "id",
"created_at": "2019-12-27T18:11:19.117Z",
"description": "description",
"disabled_reason": "disabled_reason",
"enabled_events": [
"user_profile.enforcement_action_opened"
],
"name": "name",
"state": "disabled",
"updated_at": "2019-12-27T18:11:19.117Z",
"url": "url"
}
```
##### Returns Examples
Response 200
```python
{
"id": "id",
"created_at": "2019-12-27T18:11:19.117Z",
"description": "description",
"disabled_reason": "disabled_reason",
"enabled_events": [
"user_profile.enforcement_action_opened"
],
"name": "name",
"state": "disabled",
"updated_at": "2019-12-27T18:11:19.117Z",
---
## Webhooks - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/webhooks
Path: 04-API-Reference/Admin/beta-organization-webhooks.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fwebhooks)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Create Organization Webhook Endpoint
List Organization Webhook Endpoints
Get Organization Webhook Endpoint
Update Organization Webhook Endpoint
Delete Organization Webhook Endpoint
Regenerate Organization Webhook Endpoint Signing Secret
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
# Webhooks
Copy page
cURL
##### [Create Organization Webhook Endpoint](https://platform.claude.com/docs/en/api/http/beta/organization/webhooks/create)
POST/v1/organizations/webhooks
Create an organization webhook endpoint.
##### [List Organization Webhook Endpoints](https://platform.claude.com/docs/en/api/http/beta/organization/webhooks/list)
GET/v1/organizations/webhooks
List the organization's webhook endpoints.
##### [Get Organization Webhook Endpoint](https://platform.claude.com/docs/en/api/http/beta/organization/webhooks/retrieve)
GET/v1/organizations/webhooks/{webhook_endpoint_id}
Retrieve an organization webhook endpoint by ID.
##### [Update Organization Webhook Endpoint](https://platform.claude.com/docs/en/api/http/beta/organization/webhooks/update)
POST/v1/organizations/webhooks/{webhook_endpoint_id}
Update an organization webhook endpoint. Only the fields you send are changed.
##### [Delete Organization Webhook Endpoint](https://platform.claude.com/docs/en/api/http/beta/organization/webhooks/delete)
DELETE/v1/organizations/webhooks/{webhook_endpoint_id}
Delete an organization webhook endpoint.
##### [Regenerate Organization Webhook Endpoint Signing Secret](https://platform.claude.com/docs/en/api/http/beta/organization/webhooks/regenerate_signing_secret)
POST/v1/organizations/webhooks/{webhook_endpoint_id}/regenerate_signing_secret
Replace an organization webhook endpoint's signing secret. The old secret stops working immediately. The new secret is returned only in this response.
##### Models
BetaDeletedOrganizationWebhookEndpoint object{ type: "webhook_endpoint_deleted", id }
A deleted organization webhook endpoint.
type: "webhook_endpoint_deleted"
Always `webhook_endpoint_deleted`.
defaultwebhook_endpoint_deleted
id: string
ID of the deleted webhook endpoint.
BetaNewOrganizationWebhookEndpoint object{ id, created_at, description, 7 more }
A new organization webhook endpoint, with its signing secret.
BetaOrganizationWebhookEndpoint object{ id, created_at, description, 6 more }
A webhook endpoint that belongs to the organization rather than to one of its workspaces.
BetaOrganizationWebhookEndpointSigningSecret object{ signing_secret }
An organization webhook endpoint's new signing secret.
signing_secret: string
The new signing secret. Deliveries are signed with it from now on, and no other response returns it.
BetaOrganizationWebhookEndpointState = "disabled" or "enabled"
Whether deliveries are sent to an organization webhook endpoint.
---
## Archive Workspace - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/workspaces/archive
Path: 04-API-Reference/Admin/beta-organization-workspaces-archive.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fworkspaces%2Farchive)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
List Workspaces
Create Workspace
Get Workspace
Update Workspace
Archive Workspace
Rate Limits
Members
Service Accounts
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Workspaces](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces)
# Archive Workspace
Copy page
cURL
POST/v1/organizations/workspaces/{workspace_id}/archive
Archive Workspace
##### Path parameters
workspace_id: string
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
##### Returns
BetaWorkspace object{ type: "workspace", id, archived_at, 7 more }
Archive Workspace
cURL
```python
curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/archive \
-X POST \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ",
"archived_at": "2024-11-01T23:59:27.427722Z",
"compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c",
"created_at": "2024-10-30T23:58:27.427722Z",
"data_residency": {
"allowed_inference_geos": "unrestricted",
"default_inference_geo": "global",
"workspace_geo": "us"
},
"display_color": "#6C5BB9",
"external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK",
"name": "Workspace Name",
"tags": {
"env": "prod",
"team": "platform"
},
"type": "workspace"
}
```
##### Returns Examples
Response 200
```python
{
"id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ",
"archived_at": "2024-11-01T23:59:27.427722Z",
"compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c",
"created_at": "2024-10-30T23:58:27.427722Z",
"data_residency": {
"allowed_inference_geos": "unrestricted",
"default_inference_geo": "global",
"workspace_geo": "us"
},
"display_color": "#6C5BB9",
"external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK",
---
## Create Workspace - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/workspaces/create
Path: 04-API-Reference/Admin/beta-organization-workspaces-create.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fworkspaces%2Fcreate)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
List Workspaces
Create Workspace
Get Workspace
Update Workspace
Archive Workspace
Rate Limits
Members
Service Accounts
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Workspaces](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces)
# Create Workspace
Copy page
cURL
POST/v1/organizations/workspaces
Create Workspace
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"anthropic-beta": optional array of [AnthropicBeta](../Endpoints/platform-claude-com-http-beta.md#anthropic_beta)
Optional header to specify the beta version(s) you want to use.
One of the following:
string
"message-batches-2024-09-24"
"prompt-caching-2024-07-31"
"computer-use-2024-10-22"
"computer-use-2025-01-24"
"pdfs-2024-09-25"
"token-counting-2024-11-01"
"token-efficient-tools-2025-02-19"
"output-128k-2025-02-19"
"files-api-2025-04-14"
"mcp-client-2025-04-04"
"mcp-client-2025-11-20"
"dev-full-thinking-2025-05-14"
"interleaved-thinking-2025-05-14"
"code-execution-2025-05-22"
"extended-cache-ttl-2025-04-11"
"context-1m-2025-08-07"
"context-management-2025-06-27"
"model-context-window-exceeded-2025-08-26"
"skills-2025-10-02"
"fast-mode-2026-02-01"
"output-300k-2026-03-24"
"user-profiles-2026-03-24"
"user-profiles-2026-08-18"
"user-profiles-2026-09-04"
"advisor-tool-2026-03-01"
"managed-agents-2026-04-01"
"cache-diagnosis-2026-04-07"
"dreaming-2026-04-21"
"thinking-token-count-2026-05-13"
"server-side-fallback-2026-06-01"
"server-side-fallback-2026-07-01"
"fallback-credit-2026-06-01"
"fallback-credit-2026-07-01"
"agent-memory-2026-07-22"
"mid-conversation-tool-changes-2026-07-01"
"compact-2026-01-12"
"computer-use-2025-11-24"
"mcp-tunnels-2026-06-22"
"structured-outputs-2025-11-13"
"task-budgets-2026-03-13"
"thinking-display-updates-2026-08-18"
"ce-user-management-2026-07-13"
"mid-conversation-output-config-2026-07-01"
"thinking-binding-controls-2026-08-01"
"mid-conversation-system-clear-at-2026-08-21"
"compact-2026-09-04"
"inline-tools-2026-09-15"
"mcp-client-2026-09-15"
"ce-plugins-2026-09-01"
"spend-limit-reads-2026-09-26"
"telemetry-destinations-2026-08-11"
"webhooks-2026-10-07"
##### Body
name: string
Name of the Workspace.
minLength1
maxLength255
data_residency: optional [BetaDataResidencyCreateConfig](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces#beta_data_residency_create_config) { allowed_inference_geos, default_inference_geo, workspace_geo } or null
Data residency configuration for the workspace. If omitted, defaults to `workspace_geo: "us"`, `allowed_inference_geos: "unrestricted"`, and `default_inference_geo: "global"`.
display_color: optional string or null
Hex color code representing the Workspace in the Anthropic Console.
maxLength7
pattern^#\[0-9A-Fa-f\]{6}\$
external_key_id: optional string or null
ID of the customer-managed encryption key (CMEK) configuration to use for this Workspace. Setting this field requires CMEK to be enabled for your organization. When set, data stored for this Workspace is encrypted with the referenced key. Create key configurations with the External Keys API. On Claude Platform on AWS the value is the AWS KMS key ARN, and the key must be a single-Region key in the same AWS account and Region as the Workspace. On that platform the key is validated against this Workspace when it is attached, so a key-policy problem is reported as an error on this request. This field is write-once: once a key is attached to a Workspace it cannot be detached or replaced. To rotate key material, rotate the underlying key on your cloud KMS; the `external_key_id` stays the same.
tags: optional map\[string\] or null
User-defined tags as string key-value pairs. Keys may not begin with `anthropic`.
##### Returns
BetaWorkspace object{ type: "workspace", id, archived_at, 7 more }
Create Workspace
cURL
```python
curl https://api.anthropic.com/v1/organizations/workspaces \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY" \
-d '{
"name": "x",
"display_color": "#6C5BB9",
"external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK",
"tags": {
"env": "prod",
"team": "platform"
}
}'
```
Response 200
```python
{
"id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ",
"archived_at": "2024-11-01T23:59:27.427722Z",
"compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c",
"created_at": "2024-10-30T23:58:27.427722Z",
"data_residency": {
"allowed_inference_geos": "unrestricted",
"default_inference_geo": "global",
"workspace_geo": "us"
},
"display_color": "#6C5BB9",
"external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK",
"name": "Workspace Name",
"tags": {
"env": "prod",
"team": "platform"
},
"type": "workspace"
}
```
##### Returns Examples
Response 200
```python
{
"id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ",
"archived_at": "2024-11-01T23:59:27.427722Z",
"compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c",
"created_at": "2024-10-30T23:58:27.427722Z",
"data_residency": {
"allowed_inference_geos": "unrestricted",
"default_inference_geo": "global",
"workspace_geo": "us"
},
"display_color": "#6C5BB9",
"external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK",
---
## List Workspaces - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/workspaces/list
Path: 04-API-Reference/Admin/beta-organization-workspaces-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fworkspaces%2Flist)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
List Workspaces
Create Workspace
Get Workspace
Update Workspace
Archive Workspace
Rate Limits
Members
Service Accounts
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Workspaces](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces)
# List Workspaces
Copy page
cURL
GET/v1/organizations/workspaces
List Workspaces
##### Query parameters
after_id: optional string
ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object.
before_id: optional string
ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object.
include_archived: optional boolean
Whether to include Workspaces that have been archived in the response
defaultfalse
include_default: optional boolean
Whether to include the organization's default Workspace in the response
defaultfalse
limit: optional number
Number of items to return per page.
Defaults to `20`. Ranges from `1` to `1000`.
default20
minimum1
maximum1000
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
##### Returns
data: array of [BetaWorkspace](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces#beta_workspace) { type: "workspace", id, archived_at, 7 more }
type: "workspace"
Object type.
For Workspaces, this is always `"workspace"`.
defaultworkspace
id: string
ID of the Workspace.
archived_at: string or null
RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived.
formatdate-time
compartment_id: string
Identifier for this Workspace's encryption compartment. When you configure a customer-managed encryption key (CMEK) on AWS, reference this value in your KMS key-policy condition so the key is scoped to this compartment. On GCP and Azure, Anthropic enforces the compartment binding automatically; you do not need to reference this value in your key configuration. See the CMEK integration guide for the required key configuration; unless your organization is on Claude Platform on AWS, it includes a separate value used during key validation. On Claude Platform on AWS there is no separate validation value: the key is validated against this Workspace's own value when it is attached, so if your key policy uses the compartment condition, add this value to it before attaching the key.
created_at: string
RFC 3339 datetime string indicating when the Workspace was created.
formatdate-time
data_residency: [BetaDataResidency](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces#beta_data_residency) { allowed_inference_geos, default_inference_geo, workspace_geo }
Data residency configuration.
allowed_inference_geos: array of [BetaAllowedInferenceGeo](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces#beta_allowed_inference_geo) or "unrestricted"
Permitted inference geo values. 'unrestricted' means all geos are allowed.
One of the following:
Geos = array of [BetaAllowedInferenceGeo](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces#beta_allowed_inference_geo)
One of the following:
"global"
"us"
"unrestricted"
default_inference_geo: "global" or "us"
Default inference geo applied when requests omit the parameter.
One of the following:
"global"
"us"
workspace_geo: "us"
Geographic region for workspace data storage. Immutable after creation.
display_color: string
Hex color code representing the Workspace in the Anthropic Console.
external_key_id: string or null
ID of the customer-managed encryption key (CMEK) configuration to use for this Workspace. Setting this field requires CMEK to be enabled for your organization. When set, data stored for this Workspace is encrypted with the referenced key. Create key configurations with the External Keys API. On Claude Platform on AWS the value is the AWS KMS key ARN, and the key must be a single-Region key in the same AWS account and Region as the Workspace. On that platform the key is validated against this Workspace when it is attached, so a key-policy problem is reported as an error on this request. This field is write-once: once a key is attached to a Workspace it cannot be detached or replaced. To rotate key material, rotate the underlying key on your cloud KMS; the `external_key_id` stays the same.
name: string
Name of the Workspace.
tags: map\[string\]
User-defined tags as string key-value pairs. Keys may not begin with `anthropic`.
first_id: string or null
First ID in the `data` list. Can be used as the `before_id` for the previous page.
has_more: boolean
Indicates if there are more results in the requested page direction.
last_id: string or null
Last ID in the `data` list. Can be used as the `after_id` for the next page.
List Workspaces
cURL
```python
curl https://api.anthropic.com/v1/organizations/workspaces \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"data": [
{
"id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ",
"archived_at": "2024-11-01T23:59:27.427722Z",
"compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c",
"created_at": "2024-10-30T23:58:27.427722Z",
"data_residency": {
"allowed_inference_geos": "unrestricted",
"default_inference_geo": "global",
"workspace_geo": "us"
},
"display_color": "#6C5BB9",
"external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK",
"name": "Workspace Name",
"tags": {
"env": "prod",
"team": "platform"
},
"type": "workspace"
}
],
"first_id": "first_id",
"has_more": true,
"last_id": "last_id"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ",
"archived_at": "2024-11-01T23:59:27.427722Z",
"compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c",
"created_at": "2024-10-30T23:58:27.427722Z",
"data_residency": {
"allowed_inference_geos": "unrestricted",
"default_inference_geo": "global",
"workspace_geo": "us"
},
"display_color": "#6C5BB9",
"external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK",
---
## Create Workspace Member - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/workspaces/members/add
Path: 04-API-Reference/Admin/beta-organization-workspaces-members-add.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fworkspaces%2Fmembers%2Fadd)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
List Workspaces
Create Workspace
Get Workspace
Update Workspace
Archive Workspace
Rate Limits
Members
List Workspace Members
Create Workspace Member
Get Workspace Member
Update Workspace Member
Delete Workspace Member
Service Accounts
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Workspaces](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces)
5. [Members](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces/members)
# Create Workspace Member
Copy page
cURL
POST/v1/organizations/workspaces/{workspace_id}/members
Create Workspace Member
##### Path parameters
workspace_id: string
ID of the Workspace.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
##### Body
user_id: string
ID of the User.
workspace_role: [BetaNoBillingWorkspaceRole](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces#beta_no_billing_workspace_role)
Role of the new Workspace Member. Cannot be `workspace_billing`.
One of the following:
"workspace_admin"
"workspace_developer"
"workspace_restricted_developer"
"workspace_user"
##### Returns
BetaWorkspaceMember object{ type: "workspace_member", user_id, workspace_id, workspace_role }
type: "workspace_member"
Object type.
For Workspace Members, this is always `"workspace_member"`.
defaultworkspace_member
user_id: string
ID of the User.
workspace_id: string
ID of the Workspace.
workspace_role: [BetaWorkspaceRole](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces#beta_workspace_role)
Role of the Workspace Member.
One of the following:
"workspace_admin"
"workspace_billing"
"workspace_developer"
"workspace_restricted_developer"
"workspace_user"
Create Workspace Member
cURL
```python
curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY" \
-d '{
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"workspace_role": "workspace_admin"
}'
```
Response 200
```python
{
"type": "workspace_member",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ",
"workspace_role": "workspace_admin"
}
```
##### Returns Examples
Response 200
```python
{
"type": "workspace_member",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ",
"workspace_role": "workspace_admin"
---
## List Workspace Members - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/workspaces/members/list
Path: 04-API-Reference/Admin/beta-organization-workspaces-members-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fworkspaces%2Fmembers%2Flist)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
List Workspaces
Create Workspace
Get Workspace
Update Workspace
Archive Workspace
Rate Limits
Members
List Workspace Members
Create Workspace Member
Get Workspace Member
Update Workspace Member
Delete Workspace Member
Service Accounts
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Workspaces](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces)
5. [Members](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces/members)
# List Workspace Members
Copy page
cURL
GET/v1/organizations/workspaces/{workspace_id}/members
List Workspace Members
##### Path parameters
workspace_id: string
ID of the Workspace.
##### Query parameters
after_id: optional string
ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object.
before_id: optional string
ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object.
limit: optional number
Number of items to return per page.
Defaults to `20`. Ranges from `1` to `1000`.
default20
minimum1
maximum1000
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
##### Returns
data: array of [BetaWorkspaceMember](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces#beta_workspace_member) { type: "workspace_member", user_id, workspace_id, workspace_role }
type: "workspace_member"
Object type.
For Workspace Members, this is always `"workspace_member"`.
defaultworkspace_member
user_id: string
ID of the User.
workspace_id: string
ID of the Workspace.
workspace_role: [BetaWorkspaceRole](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces#beta_workspace_role)
Role of the Workspace Member.
One of the following:
"workspace_admin"
"workspace_billing"
"workspace_developer"
"workspace_restricted_developer"
"workspace_user"
first_id: string or null
First ID in the `data` list. Can be used as the `before_id` for the previous page.
has_more: boolean
Indicates if there are more results in the requested page direction.
last_id: string or null
Last ID in the `data` list. Can be used as the `after_id` for the next page.
List Workspace Members
cURL
```python
curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"data": [
{
"type": "workspace_member",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ",
"workspace_role": "workspace_admin"
}
],
"first_id": "first_id",
"has_more": true,
"last_id": "last_id"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"type": "workspace_member",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ",
"workspace_role": "workspace_admin"
---
## Delete Workspace Member - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/workspaces/members/remove
Path: 04-API-Reference/Admin/beta-organization-workspaces-members-remove.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fworkspaces%2Fmembers%2Fremove)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
List Workspaces
Create Workspace
Get Workspace
Update Workspace
Archive Workspace
Rate Limits
Members
List Workspace Members
Create Workspace Member
Get Workspace Member
Update Workspace Member
Delete Workspace Member
Service Accounts
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Workspaces](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces)
5. [Members](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces/members)
# Delete Workspace Member
Copy page
cURL
DELETE/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Delete Workspace Member
##### Path parameters
workspace_id: string
ID of the Workspace.
user_id: string
ID of the User.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
##### Returns
type: "workspace_member_deleted"
Deleted object type.
For Workspace Members, this is always `"workspace_member_deleted"`.
defaultworkspace_member_deleted
user_id: string
ID of the User.
workspace_id: string
ID of the Workspace.
Delete Workspace Member
cURL
```python
curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members/$USER_ID \
-X DELETE \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"type": "workspace_member_deleted",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"
}
```
##### Returns Examples
Response 200
```python
{
"type": "workspace_member_deleted",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"
---
## Get Workspace Member - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/workspaces/members/retrieve
Path: 04-API-Reference/Admin/beta-organization-workspaces-members-retrieve.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fworkspaces%2Fmembers%2Fretrieve)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
List Workspaces
Create Workspace
Get Workspace
Update Workspace
Archive Workspace
Rate Limits
Members
List Workspace Members
Create Workspace Member
Get Workspace Member
Update Workspace Member
Delete Workspace Member
Service Accounts
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Workspaces](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces)
5. [Members](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces/members)
# Get Workspace Member
Copy page
cURL
GET/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Get Workspace Member
##### Path parameters
workspace_id: string
ID of the Workspace.
user_id: string
ID of the User.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
##### Returns
BetaWorkspaceMember object{ type: "workspace_member", user_id, workspace_id, workspace_role }
type: "workspace_member"
Object type.
For Workspace Members, this is always `"workspace_member"`.
defaultworkspace_member
user_id: string
ID of the User.
workspace_id: string
ID of the Workspace.
workspace_role: [BetaWorkspaceRole](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces#beta_workspace_role)
Role of the Workspace Member.
One of the following:
"workspace_admin"
"workspace_billing"
"workspace_developer"
"workspace_restricted_developer"
"workspace_user"
Get Workspace Member
cURL
```python
curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members/$USER_ID \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"type": "workspace_member",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ",
"workspace_role": "workspace_admin"
}
```
##### Returns Examples
Response 200
```python
{
"type": "workspace_member",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ",
"workspace_role": "workspace_admin"
---
## Update Workspace Member - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/workspaces/members/update
Path: 04-API-Reference/Admin/beta-organization-workspaces-members-update.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fworkspaces%2Fmembers%2Fupdate)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
List Workspaces
Create Workspace
Get Workspace
Update Workspace
Archive Workspace
Rate Limits
Members
List Workspace Members
Create Workspace Member
Get Workspace Member
Update Workspace Member
Delete Workspace Member
Service Accounts
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Workspaces](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces)
5. [Members](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces/members)
# Update Workspace Member
Copy page
cURL
POST/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Update Workspace Member
##### Path parameters
workspace_id: string
ID of the Workspace.
user_id: string
ID of the User.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
##### Body
workspace_role: [BetaWorkspaceRole](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces#beta_workspace_role)
New workspace role for the User.
One of the following:
"workspace_admin"
"workspace_billing"
"workspace_developer"
"workspace_restricted_developer"
"workspace_user"
##### Returns
BetaWorkspaceMember object{ type: "workspace_member", user_id, workspace_id, workspace_role }
type: "workspace_member"
Object type.
For Workspace Members, this is always `"workspace_member"`.
defaultworkspace_member
user_id: string
ID of the User.
workspace_id: string
ID of the Workspace.
workspace_role: [BetaWorkspaceRole](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces#beta_workspace_role)
Role of the Workspace Member.
One of the following:
"workspace_admin"
"workspace_billing"
"workspace_developer"
"workspace_restricted_developer"
"workspace_user"
Update Workspace Member
cURL
```python
curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members/$USER_ID \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY" \
-d '{
"workspace_role": "workspace_admin"
}'
```
Response 200
```python
{
"type": "workspace_member",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ",
"workspace_role": "workspace_admin"
}
```
##### Returns Examples
Response 200
```python
{
"type": "workspace_member",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ",
"workspace_role": "workspace_admin"
---
## Members - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/workspaces/members
Path: 04-API-Reference/Admin/beta-organization-workspaces-members.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fworkspaces%2Fmembers)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
List Workspaces
Create Workspace
Get Workspace
Update Workspace
Archive Workspace
Rate Limits
Members
List Workspace Members
Create Workspace Member
Get Workspace Member
Update Workspace Member
Delete Workspace Member
Service Accounts
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Workspaces](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces)
# Members
Copy page
cURL
##### [List Workspace Members](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces/members/list)
GET/v1/organizations/workspaces/{workspace_id}/members
##### [Create Workspace Member](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces/members/add)
POST/v1/organizations/workspaces/{workspace_id}/members
##### [Get Workspace Member](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces/members/retrieve)
GET/v1/organizations/workspaces/{workspace_id}/members/{user_id}
##### [Update Workspace Member](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces/members/update)
POST/v1/organizations/workspaces/{workspace_id}/members/{user_id}
##### [Delete Workspace Member](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces/members/remove)
DELETE/v1/organizations/workspaces/{workspace_id}/members/{user_id}
##### Models
MemberRemoveResponse object{ type: "workspace_member_deleted", user_id, workspace_id }
type: "workspace_member_deleted"
Deleted object type.
For Workspace Members, this is always `"workspace_member_deleted"`.
defaultworkspace_member_deleted
user_id: string
ID of the User.
workspace_id: string
ID of the Workspace.
---
## List Workspace Rate Limits - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/workspaces/rate_limits/list
Path: 04-API-Reference/Admin/beta-organization-workspaces-rate-limits-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fworkspaces%2Frate_limits%2Flist)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
List Workspaces
Create Workspace
Get Workspace
Update Workspace
Archive Workspace
Rate Limits
List Workspace Rate Limits
Set Workspace Rate Limits
Members
Service Accounts
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Workspaces](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces)
5. [Rate Limits](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces/rate_limits)
# List Workspace Rate Limits
Copy page
cURL
GET/v1/organizations/workspaces/{workspace_id}/rate_limits
List a workspace's rate limits.
By default, returns only the groups and limiter types that have a workspace-level override. With `include_inherited=true`, returns every group with organization-level limits the workspace can see, listing for each the values it inherits from the organization as well as its own overrides. Each value's `source` says which it is.
When `limit` is omitted, every matching entry is returned in a single page; when `limit` truncates the result, follow `next_page` to fetch the remaining entries.
##### Path parameters
workspace_id: string
The ID of the workspace.
##### Query parameters
group_type: optional "batch" or "files" or "model_group" or 3 more
Filter by group type.
One of the following:
"batch"
"files"
"model_group"
"skills"
"token_count"
"web_search"
include_inherited: optional boolean
Also list the limiter values the workspace inherits from the organization, including groups with no workspace-level override.
defaultfalse
limit: optional number
Maximum number of items to return per page. Ranges from `1` to `1000`.
When omitted, every remaining entry is returned in a single page and `next_page` is `null`.
minimum1
maximum1000
page: optional string
Opaque cursor from a previous response's `next_page`.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
##### Returns
data: array of [BetaWorkspaceRateLimit](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces/rate_limits#beta_workspace_rate_limit) { type: "workspace_rate_limit", group, group_type, 4 more }
Rate-limit entries for the workspace: one per group with at least one override, or, with `include_inherited` set to `true`, one per group the workspace can see that has organization-level limits.
type: "workspace_rate_limit"
Object type. Always `workspace_rate_limit` for workspace rate-limit entries.
defaultworkspace_rate_limit
group: [BetaOrganizationRateLimitModelGroup](https://platform.claude.com/docs/en/api/http/beta/organization/rate_limits#beta_organization_rate_limit_model_group) or [BetaOrganizationRateLimitBatchGroup](https://platform.claude.com/docs/en/api/http/beta/organization/rate_limits#beta_organization_rate_limit_batch_group) or [BetaOrganizationRateLimitTokenCountGroup](https://platform.claude.com/docs/en/api/http/beta/organization/rate_limits#beta_organization_rate_limit_token_count_group) or 3 more
The rate-limit group this entry's limits apply to. Its `type` equals `group_type`.
One of the following:
BetaOrganizationRateLimitModelGroup object{ type: "model_group", id, display_name }
type: "model_group"
Always `model_group`: a family of models.
defaultmodel_group
id: string
Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization.
display_name: string
Human-readable name of the model group (for example, `Claude Sonnet 4.x`). For display only; it may change.
BetaOrganizationRateLimitBatchGroup object{ type: "batch", id }
type: "batch"
Always `batch`: the Message Batches API.
defaultbatch
id: string
Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization.
BetaOrganizationRateLimitTokenCountGroup object{ type: "token_count", id }
type: "token_count"
Always `token_count`: the Token Count API.
defaulttoken_count
id: string
Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization.
BetaOrganizationRateLimitFilesGroup object{ type: "files", id }
type: "files"
Always `files`: the Files API.
defaultfiles
id: string
Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization.
BetaOrganizationRateLimitSkillsGroup object{ type: "skills", id }
type: "skills"
Always `skills`: the Skills API.
defaultskills
id: string
Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization.
BetaOrganizationRateLimitWebSearchGroup object{ type: "web_search", id }
type: "web_search"
Always `web_search`: the Messages API web search tool.
defaultweb_search
id: string
Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization.
limits: array of [BetaWorkspaceRateLimitValue](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces/rate_limits#beta_workspace_rate_limit_value) { type, org_limit, source, value }
The workspace's limiter values for this group. By default only the limiter types with a workspace-level override are listed. With `include_inherited` set to `true`, the limiter types the workspace inherits from the organization are listed too, each marked by `source`.
type: string
The limiter type (for example, `requests_per_minute` or `input_tokens_per_minute`).
org_limit: number or null
The organization-level value for the same limiter type, for reference. `null` when the organization has no limit configured for this limiter type.
source: [BetaWorkspaceRateLimitWorkspaceSource](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces/rate_limits#beta_workspace_rate_limit_workspace_source) or [BetaWorkspaceRateLimitOrganizationSource](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces/rate_limits#beta_workspace_rate_limit_organization_source)
Where `value` comes from. `organization` values are listed only when `include_inherited` is `true`, and then `value` equals `org_limit`.
One of the following:
BetaWorkspaceRateLimitWorkspaceSource object{ type: "workspace" }
type: "workspace"
Always `workspace`: a workspace-level override is stored.
defaultworkspace
BetaWorkspaceRateLimitOrganizationSource object{ type: "organization" }
type: "organization"
Always `organization`: no workspace-level override is stored, so the organization's value applies.
defaultorganization
value: number
The workspace's value for this limiter type: the workspace-level override when `source.type` is `workspace`, otherwise the organization's value.
models: array of string or null
Model names this entry's limits apply to, including aliases. `null` when `group_type` is not `"model_group"`.
rate_limit_id: string
The `id` of the organization's RateLimit entry this entry applies to.
workspace_id: string
ID of the Workspace this entry applies to.
group_type: "batch" or "files" or "model_group" or 3 moreDeprecated
Deprecated: use `group.type` instead. The kind of rate-limit group this entry represents. `model_group` entries apply to a family of models (listed in `models`); other values apply to an API-surface category and have `models` set to `null`. Always equal to `group.type`.
Use \`group.type\` instead. \`group_type\` is still returned and always equals \`group.type\`.
One of the following:
"batch"
"files"
"model_group"
"skills"
"token_count"
"web_search"
next_page: string or null
Opaque cursor for the next page of results, or `null` when no entries remain beyond this response.
List Workspace Rate Limits
cURL
```python
curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/rate_limits \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"data": [
{
"group": {
"id": "id",
"display_name": "display_name",
"type": "model_group"
},
"group_type": "batch",
"limits": [
{
"org_limit": 0,
"source": {
"type": "workspace"
},
"type": "type",
"value": 0
}
],
"models": [
"string"
],
"rate_limit_id": "rate_limit_id",
"type": "workspace_rate_limit",
"workspace_id": "workspace_id"
}
],
"next_page": "next_page"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"group": {
"id": "id",
"display_name": "display_name",
"type": "model_group"
},
"group_type": "batch",
"limits": [
{
"org_limit": 0,
"source": {
"type": "workspace"
},
"type": "type",
"value": 0
}
],
"models": [
"string"
],
"rate_limit_id": "rate_limit_id",
"type": "workspace_rate_limit",
"workspace_id": "workspace_id"
---
## Set Workspace Rate Limits - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/workspaces/rate_limits/update
Path: 04-API-Reference/Admin/beta-organization-workspaces-rate-limits-update.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fworkspaces%2Frate_limits%2Fupdate)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
List Workspaces
Create Workspace
Get Workspace
Update Workspace
Archive Workspace
Rate Limits
List Workspace Rate Limits
Set Workspace Rate Limits
Members
Service Accounts
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Workspaces](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces)
5. [Rate Limits](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces/rate_limits)
# Set Workspace Rate Limits
Copy page
cURL
POST/v1/organizations/workspaces/{workspace_id}/rate_limits/{rate_limit_id}
Set or clear rate-limit overrides for one rate-limit group in a workspace.
Only the limiter types named in `limits` change: an integer `value` sets that type's override and `null` clears it. Types not named keep their current value. A value above the organization's own limit is stored, but the organization limit still applies, so the lower of the two is enforced.
Returns the targeted group's entry with this request applied, in the shape `GET /v1/organizations/workspaces/{workspace_id}/rate_limits` returns. Changes take effect within about an hour.
##### Path parameters
workspace_id: string
The ID of the workspace.
rate_limit_id: string
The `id` of the organization's rate-limit entry to set overrides for.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
##### Body
limits: array of [BetaWorkspaceRateLimitUpdateValue](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces/rate_limits#beta_workspace_rate_limit_update_value) { type, value }
Limits to set or clear. Unspecified limit types are unchanged.
minItems1
maxItems16
type: [BetaWorkspaceRateLimitType](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces/rate_limits#beta_workspace_rate_limit_type)
Rate limiter type.
One of the following:
"fast_itpmca"
"fast_otpm"
"input_tokens_per_minute"
"input_tokens_per_minute_cache_aware"
"output_tokens_per_minute"
"requests_per_minute"
"tokens_per_day"
"tokens_per_minute"
"tool_uses_per_second"
value: number or null
New limit value. Set to null to clear the workspace override and fall back to the organization limit.
minimum0
maximum9007199254740991
##### Returns
BetaWorkspaceRateLimit object{ type: "workspace_rate_limit", group, group_type, 4 more }
Set Workspace Rate Limits
cURL
```python
curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/rate_limits/$RATE_LIMIT_ID \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY" \
-d '{
"limits": [
{
"type": "fast_itpmca",
"value": 0
}
]
}'
```
Response 200
```python
{
"group": {
"id": "id",
"display_name": "display_name",
"type": "model_group"
},
"group_type": "batch",
"limits": [
{
"org_limit": 0,
"source": {
"type": "workspace"
},
"type": "type",
"value": 0
}
],
"models": [
"string"
],
"rate_limit_id": "rate_limit_id",
"type": "workspace_rate_limit",
"workspace_id": "workspace_id"
}
```
##### Returns Examples
Response 200
```python
{
"group": {
"id": "id",
"display_name": "display_name",
"type": "model_group"
},
"group_type": "batch",
"limits": [
{
"org_limit": 0,
"source": {
"type": "workspace"
},
"type": "type",
"value": 0
}
],
"models": [
"string"
],
"rate_limit_id": "rate_limit_id",
"type": "workspace_rate_limit",
"workspace_id": "workspace_id"
---
## Rate Limits - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/workspaces/rate_limits
Path: 04-API-Reference/Admin/beta-organization-workspaces-rate-limits.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fworkspaces%2Frate_limits)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
List Workspaces
Create Workspace
Get Workspace
Update Workspace
Archive Workspace
Rate Limits
List Workspace Rate Limits
Set Workspace Rate Limits
Members
Service Accounts
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Workspaces](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces)
# Rate Limits
Copy page
cURL
##### [List Workspace Rate Limits](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces/rate_limits/list)
GET/v1/organizations/workspaces/{workspace_id}/rate_limits
List a workspace's rate limits.
##### [Set Workspace Rate Limits](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces/rate_limits/update)
POST/v1/organizations/workspaces/{workspace_id}/rate_limits/{rate_limit_id}
Set or clear rate-limit overrides for one rate-limit group in a workspace.
##### Models
BetaWorkspaceRateLimit object{ type: "workspace_rate_limit", group, group_type, 4 more }
BetaWorkspaceRateLimitOrganizationSource object{ type: "organization" }
type: "organization"
Always `organization`: no workspace-level override is stored, so the organization's value applies.
defaultorganization
BetaWorkspaceRateLimitType = "fast_itpmca" or "fast_otpm" or "input_tokens_per_minute" or 6 more
Rate limiter type.
One of the following:
"fast_itpmca"
"fast_otpm"
"input_tokens_per_minute"
"input_tokens_per_minute_cache_aware"
"output_tokens_per_minute"
"requests_per_minute"
"tokens_per_day"
"tokens_per_minute"
"tool_uses_per_second"
BetaWorkspaceRateLimitUpdateValue object{ type, value }
type: [BetaWorkspaceRateLimitType](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces/rate_limits#beta_workspace_rate_limit_type)
Rate limiter type.
One of the following:
"fast_itpmca"
"fast_otpm"
"input_tokens_per_minute"
"input_tokens_per_minute_cache_aware"
"output_tokens_per_minute"
"requests_per_minute"
"tokens_per_day"
"tokens_per_minute"
"tool_uses_per_second"
value: number or null
New limit value. Set to null to clear the workspace override and fall back to the organization limit.
minimum0
maximum9007199254740991
BetaWorkspaceRateLimitValue object{ type, org_limit, source, value }
BetaWorkspaceRateLimitWorkspaceSource object{ type: "workspace" }
type: "workspace"
Always `workspace`: a workspace-level override is stored.
---
## Get Workspace - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/workspaces/retrieve
Path: 04-API-Reference/Admin/beta-organization-workspaces-retrieve.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fworkspaces%2Fretrieve)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
List Workspaces
Create Workspace
Get Workspace
Update Workspace
Archive Workspace
Rate Limits
Members
Service Accounts
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Workspaces](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces)
# Get Workspace
Copy page
cURL
GET/v1/organizations/workspaces/{workspace_id}
Get Workspace
##### Path parameters
workspace_id: string
ID of the Workspace.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
##### Returns
BetaWorkspace object{ type: "workspace", id, archived_at, 7 more }
Get Workspace
cURL
```python
curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ",
"archived_at": "2024-11-01T23:59:27.427722Z",
"compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c",
"created_at": "2024-10-30T23:58:27.427722Z",
"data_residency": {
"allowed_inference_geos": "unrestricted",
"default_inference_geo": "global",
"workspace_geo": "us"
},
"display_color": "#6C5BB9",
"external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK",
"name": "Workspace Name",
"tags": {
"env": "prod",
"team": "platform"
},
"type": "workspace"
}
```
##### Returns Examples
Response 200
```python
{
"id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ",
"archived_at": "2024-11-01T23:59:27.427722Z",
"compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c",
"created_at": "2024-10-30T23:58:27.427722Z",
"data_residency": {
"allowed_inference_geos": "unrestricted",
"default_inference_geo": "global",
"workspace_geo": "us"
},
"display_color": "#6C5BB9",
"external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK",
---
## Create Service Account Workspace Member - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/workspaces/service_accounts/add
Path: 04-API-Reference/Admin/beta-organization-workspaces-service-accounts-add.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fworkspaces%2Fservice_accounts%2Fadd)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
List Workspaces
Create Workspace
Get Workspace
Update Workspace
Archive Workspace
Rate Limits
Members
Service Accounts
List Service Account Workspace Members
Create Service Account Workspace Member
Get Service Account Workspace Member
Update Service Account Workspace Member
Delete Service Account Workspace Member
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Workspaces](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces)
5. [Service Accounts](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces/service_accounts)
# Create Service Account Workspace Member
Copy page
cURL
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](../Other/manage-claude-wif-admin-api.md).
Add a service account to a workspace with the given `workspace_role`.
The role determines what the service account can do in the workspace and which workspace-scoped permissions it can be granted when authenticating through federation. Every service account is already an implicit `workspace_user` member of the default workspace; adding it explicitly assigns a chosen role. If the service account is already an explicit member of the workspace, its `workspace_role` is replaced with the value supplied here. Archived workspaces return 400. Archived service accounts cannot be added and are rejected.
##### Path parameters
workspace_id: string
ID of the workspace.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"anthropic-beta": optional array of [AnthropicBeta](../Endpoints/platform-claude-com-http-beta.md#anthropic_beta)
Optional header to specify the beta version(s) you want to use.
One of the following:
string
"message-batches-2024-09-24"
"prompt-caching-2024-07-31"
"computer-use-2024-10-22"
"computer-use-2025-01-24"
"pdfs-2024-09-25"
"token-counting-2024-11-01"
"token-efficient-tools-2025-02-19"
"output-128k-2025-02-19"
"files-api-2025-04-14"
"mcp-client-2025-04-04"
"mcp-client-2025-11-20"
"dev-full-thinking-2025-05-14"
"interleaved-thinking-2025-05-14"
"code-execution-2025-05-22"
"extended-cache-ttl-2025-04-11"
"context-1m-2025-08-07"
"context-management-2025-06-27"
"model-context-window-exceeded-2025-08-26"
"skills-2025-10-02"
"fast-mode-2026-02-01"
"output-300k-2026-03-24"
"user-profiles-2026-03-24"
"user-profiles-2026-08-18"
"user-profiles-2026-09-04"
"advisor-tool-2026-03-01"
"managed-agents-2026-04-01"
"cache-diagnosis-2026-04-07"
"dreaming-2026-04-21"
"thinking-token-count-2026-05-13"
"server-side-fallback-2026-06-01"
"server-side-fallback-2026-07-01"
"fallback-credit-2026-06-01"
"fallback-credit-2026-07-01"
"agent-memory-2026-07-22"
"mid-conversation-tool-changes-2026-07-01"
"compact-2026-01-12"
"computer-use-2025-11-24"
"mcp-tunnels-2026-06-22"
"structured-outputs-2025-11-13"
"task-budgets-2026-03-13"
"thinking-display-updates-2026-08-18"
"ce-user-management-2026-07-13"
"mid-conversation-output-config-2026-07-01"
"thinking-binding-controls-2026-08-01"
"mid-conversation-system-clear-at-2026-08-21"
"compact-2026-09-04"
"inline-tools-2026-09-15"
"mcp-client-2026-09-15"
"ce-plugins-2026-09-01"
"spend-limit-reads-2026-09-26"
"telemetry-destinations-2026-08-11"
"webhooks-2026-10-07"
##### Body
service_account_id: string
Tagged service account ID to add.
workspace_role: [BetaNoBillingWorkspaceRole](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces#beta_no_billing_workspace_role)
Role to assign to the service account in this workspace.
One of the following:
"workspace_admin"
"workspace_developer"
"workspace_restricted_developer"
"workspace_user"
##### Returns
BetaServiceAccountWorkspaceMember object{ type: "service_account_workspace_member", created_by_actor_id, implicit, 3 more }
type: "service_account_workspace_member"
defaultservice_account_workspace_member
created_by_actor_id: string or null
Tagged ID (`user_...`/`svac_...`) of the actor who created this membership.
implicit: boolean or null
True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed.
service_account_id: string
Tagged service account ID (`svac_...`).
workspace_id: string
Tagged workspace ID (`wrkspc_...`).
workspace_role: [BetaWorkspaceRole](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces#beta_workspace_role)
Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role.
One of the following:
"workspace_admin"
"workspace_billing"
"workspace_developer"
"workspace_restricted_developer"
"workspace_user"
Create Service Account Workspace Member
cURL
```python
curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/service_accounts \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY" \
-d '{
"service_account_id": "service_account_id",
"workspace_role": "workspace_admin"
}'
```
Response 200
```python
{
"created_by_actor_id": "created_by_actor_id",
"implicit": true,
"service_account_id": "service_account_id",
"type": "service_account_workspace_member",
"workspace_id": "workspace_id",
"workspace_role": "workspace_admin"
}
```
##### Returns Examples
Response 200
```python
{
"created_by_actor_id": "created_by_actor_id",
"implicit": true,
"service_account_id": "service_account_id",
"type": "service_account_workspace_member",
"workspace_id": "workspace_id",
"workspace_role": "workspace_admin"
---
## List Service Account Workspace Members - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/workspaces/service_accounts/list
Path: 04-API-Reference/Admin/beta-organization-workspaces-service-accounts-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fworkspaces%2Fservice_accounts%2Flist)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
List Workspaces
Create Workspace
Get Workspace
Update Workspace
Archive Workspace
Rate Limits
Members
Service Accounts
List Service Account Workspace Members
Create Service Account Workspace Member
Get Service Account Workspace Member
Update Service Account Workspace Member
Delete Service Account Workspace Member
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Workspaces](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces)
5. [Service Accounts](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces/service_accounts)
# List Service Account Workspace Members
Copy page
cURL
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](../Other/manage-claude-wif-admin-api.md).
List the service accounts that are members of a workspace.
Each entry includes the service account's `workspace_role`. Use `limit` and the `next_page` cursor to paginate. Archived workspaces return 400; use `GET /service_accounts/{id}/workspaces` to audit memberships of an archived workspace. The implicit default-workspace membership is not included in this list. Memberships of archived service accounts are omitted from the results.
##### Path parameters
workspace_id: string
ID of the workspace.
##### Query parameters
limit: optional number
Number of results per page.
default20
minimum1
maximum100
page: optional string
Opaque cursor from a previous response's `next_page`.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"anthropic-beta": optional array of [AnthropicBeta](../Endpoints/platform-claude-com-http-beta.md#anthropic_beta)
Optional header to specify the beta version(s) you want to use.
One of the following:
string
"message-batches-2024-09-24"
"prompt-caching-2024-07-31"
"computer-use-2024-10-22"
"computer-use-2025-01-24"
"pdfs-2024-09-25"
"token-counting-2024-11-01"
"token-efficient-tools-2025-02-19"
"output-128k-2025-02-19"
"files-api-2025-04-14"
"mcp-client-2025-04-04"
"mcp-client-2025-11-20"
"dev-full-thinking-2025-05-14"
"interleaved-thinking-2025-05-14"
"code-execution-2025-05-22"
"extended-cache-ttl-2025-04-11"
"context-1m-2025-08-07"
"context-management-2025-06-27"
"model-context-window-exceeded-2025-08-26"
"skills-2025-10-02"
"fast-mode-2026-02-01"
"output-300k-2026-03-24"
"user-profiles-2026-03-24"
"user-profiles-2026-08-18"
"user-profiles-2026-09-04"
"advisor-tool-2026-03-01"
"managed-agents-2026-04-01"
"cache-diagnosis-2026-04-07"
"dreaming-2026-04-21"
"thinking-token-count-2026-05-13"
"server-side-fallback-2026-06-01"
"server-side-fallback-2026-07-01"
"fallback-credit-2026-06-01"
"fallback-credit-2026-07-01"
"agent-memory-2026-07-22"
"mid-conversation-tool-changes-2026-07-01"
"compact-2026-01-12"
"computer-use-2025-11-24"
"mcp-tunnels-2026-06-22"
"structured-outputs-2025-11-13"
"task-budgets-2026-03-13"
"thinking-display-updates-2026-08-18"
"ce-user-management-2026-07-13"
"mid-conversation-output-config-2026-07-01"
"thinking-binding-controls-2026-08-01"
"mid-conversation-system-clear-at-2026-08-21"
"compact-2026-09-04"
"inline-tools-2026-09-15"
"mcp-client-2026-09-15"
"ce-plugins-2026-09-01"
"spend-limit-reads-2026-09-26"
"telemetry-destinations-2026-08-11"
"webhooks-2026-10-07"
##### Returns
data: array of [BetaServiceAccountWorkspaceMember](https://platform.claude.com/docs/en/api/http/beta/organization/service_accounts#beta_service_account_workspace_member) { type: "service_account_workspace_member", created_by_actor_id, implicit, 3 more }
type: "service_account_workspace_member"
defaultservice_account_workspace_member
created_by_actor_id: string or null
Tagged ID (`user_...`/`svac_...`) of the actor who created this membership.
implicit: boolean or null
True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed.
service_account_id: string
Tagged service account ID (`svac_...`).
workspace_id: string
Tagged workspace ID (`wrkspc_...`).
workspace_role: [BetaWorkspaceRole](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces#beta_workspace_role)
Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role.
One of the following:
"workspace_admin"
"workspace_billing"
"workspace_developer"
"workspace_restricted_developer"
"workspace_user"
next_page: string or null
Opaque cursor for the next page, or null if no more results.
List Service Account Workspace Members
cURL
```python
curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/service_accounts \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"data": [
{
"created_by_actor_id": "created_by_actor_id",
"implicit": true,
"service_account_id": "service_account_id",
"type": "service_account_workspace_member",
"workspace_id": "workspace_id",
"workspace_role": "workspace_admin"
}
],
"next_page": "next_page"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"created_by_actor_id": "created_by_actor_id",
"implicit": true,
"service_account_id": "service_account_id",
"type": "service_account_workspace_member",
"workspace_id": "workspace_id",
"workspace_role": "workspace_admin"
---
## Delete Service Account Workspace Member - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/workspaces/service_accounts/remove
Path: 04-API-Reference/Admin/beta-organization-workspaces-service-accounts-remove.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fworkspaces%2Fservice_accounts%2Fremove)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
List Workspaces
Create Workspace
Get Workspace
Update Workspace
Archive Workspace
Rate Limits
Members
Service Accounts
List Service Account Workspace Members
Create Service Account Workspace Member
Get Service Account Workspace Member
Update Service Account Workspace Member
Delete Service Account Workspace Member
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Workspaces](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces)
5. [Service Accounts](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces/service_accounts)
# Delete Service Account Workspace Member
Copy page
cURL
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](../Other/manage-claude-wif-admin-api.md).
Remove a service account from a workspace.
Removal is idempotent (returns 200 even if the membership was already removed). A DELETE against the implicit default-workspace membership returns 200 but is a no-op and the membership persists; deleting an explicit default-workspace row reverts to the implicit `workspace_user` membership. Archived workspaces return 400.
##### Path parameters
workspace_id: string
ID of the workspace.
service_account_id: string
ID of the service account.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"anthropic-beta": optional array of [AnthropicBeta](../Endpoints/platform-claude-com-http-beta.md#anthropic_beta)
Optional header to specify the beta version(s) you want to use.
One of the following:
string
"message-batches-2024-09-24"
"prompt-caching-2024-07-31"
"computer-use-2024-10-22"
"computer-use-2025-01-24"
"pdfs-2024-09-25"
"token-counting-2024-11-01"
"token-efficient-tools-2025-02-19"
"output-128k-2025-02-19"
"files-api-2025-04-14"
"mcp-client-2025-04-04"
"mcp-client-2025-11-20"
"dev-full-thinking-2025-05-14"
"interleaved-thinking-2025-05-14"
"code-execution-2025-05-22"
"extended-cache-ttl-2025-04-11"
"context-1m-2025-08-07"
"context-management-2025-06-27"
"model-context-window-exceeded-2025-08-26"
"skills-2025-10-02"
"fast-mode-2026-02-01"
"output-300k-2026-03-24"
"user-profiles-2026-03-24"
"user-profiles-2026-08-18"
"user-profiles-2026-09-04"
"advisor-tool-2026-03-01"
"managed-agents-2026-04-01"
"cache-diagnosis-2026-04-07"
"dreaming-2026-04-21"
"thinking-token-count-2026-05-13"
"server-side-fallback-2026-06-01"
"server-side-fallback-2026-07-01"
"fallback-credit-2026-06-01"
"fallback-credit-2026-07-01"
"agent-memory-2026-07-22"
"mid-conversation-tool-changes-2026-07-01"
"compact-2026-01-12"
"computer-use-2025-11-24"
"mcp-tunnels-2026-06-22"
"structured-outputs-2025-11-13"
"task-budgets-2026-03-13"
"thinking-display-updates-2026-08-18"
"ce-user-management-2026-07-13"
"mid-conversation-output-config-2026-07-01"
"thinking-binding-controls-2026-08-01"
"mid-conversation-system-clear-at-2026-08-21"
"compact-2026-09-04"
"inline-tools-2026-09-15"
"mcp-client-2026-09-15"
"ce-plugins-2026-09-01"
"spend-limit-reads-2026-09-26"
"telemetry-destinations-2026-08-11"
"webhooks-2026-10-07"
##### Returns
type: "service_account_workspace_member_deleted"
defaultservice_account_workspace_member_deleted
service_account_id: string
Tagged service account ID (`svac_...`) named in the delete request. Removal is idempotent; see the endpoint description for the implicit-membership no-op.
workspace_id: string
Tagged workspace ID (`wrkspc_...`) named in the delete request.
Delete Service Account Workspace Member
cURL
```python
curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/service_accounts/$SERVICE_ACCOUNT_ID \
-X DELETE \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"service_account_id": "service_account_id",
"type": "service_account_workspace_member_deleted",
"workspace_id": "workspace_id"
}
```
##### Returns Examples
Response 200
```python
{
"service_account_id": "service_account_id",
"type": "service_account_workspace_member_deleted",
"workspace_id": "workspace_id"
---
## Get Service Account Workspace Member - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/workspaces/service_accounts/retrieve
Path: 04-API-Reference/Admin/beta-organization-workspaces-service-accounts-retrieve.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fworkspaces%2Fservice_accounts%2Fretrieve)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
List Workspaces
Create Workspace
Get Workspace
Update Workspace
Archive Workspace
Rate Limits
Members
Service Accounts
List Service Account Workspace Members
Create Service Account Workspace Member
Get Service Account Workspace Member
Update Service Account Workspace Member
Delete Service Account Workspace Member
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Workspaces](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces)
5. [Service Accounts](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces/service_accounts)
# Get Service Account Workspace Member
Copy page
cURL
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](../Other/manage-claude-wif-admin-api.md).
Retrieve a service account's membership in a workspace.
Returns the membership record, including the service account's `workspace_role` in this workspace. Archived workspaces return 400. For the default workspace, returns the implicit (`implicit: true`) membership when no explicit membership exists; an explicitly added membership is returned with its assigned role. An archived service account returns 404.
##### Path parameters
workspace_id: string
ID of the workspace.
service_account_id: string
ID of the service account.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"anthropic-beta": optional array of [AnthropicBeta](../Endpoints/platform-claude-com-http-beta.md#anthropic_beta)
Optional header to specify the beta version(s) you want to use.
One of the following:
string
"message-batches-2024-09-24"
"prompt-caching-2024-07-31"
"computer-use-2024-10-22"
"computer-use-2025-01-24"
"pdfs-2024-09-25"
"token-counting-2024-11-01"
"token-efficient-tools-2025-02-19"
"output-128k-2025-02-19"
"files-api-2025-04-14"
"mcp-client-2025-04-04"
"mcp-client-2025-11-20"
"dev-full-thinking-2025-05-14"
"interleaved-thinking-2025-05-14"
"code-execution-2025-05-22"
"extended-cache-ttl-2025-04-11"
"context-1m-2025-08-07"
"context-management-2025-06-27"
"model-context-window-exceeded-2025-08-26"
"skills-2025-10-02"
"fast-mode-2026-02-01"
"output-300k-2026-03-24"
"user-profiles-2026-03-24"
"user-profiles-2026-08-18"
"user-profiles-2026-09-04"
"advisor-tool-2026-03-01"
"managed-agents-2026-04-01"
"cache-diagnosis-2026-04-07"
"dreaming-2026-04-21"
"thinking-token-count-2026-05-13"
"server-side-fallback-2026-06-01"
"server-side-fallback-2026-07-01"
"fallback-credit-2026-06-01"
"fallback-credit-2026-07-01"
"agent-memory-2026-07-22"
"mid-conversation-tool-changes-2026-07-01"
"compact-2026-01-12"
"computer-use-2025-11-24"
"mcp-tunnels-2026-06-22"
"structured-outputs-2025-11-13"
"task-budgets-2026-03-13"
"thinking-display-updates-2026-08-18"
"ce-user-management-2026-07-13"
"mid-conversation-output-config-2026-07-01"
"thinking-binding-controls-2026-08-01"
"mid-conversation-system-clear-at-2026-08-21"
"compact-2026-09-04"
"inline-tools-2026-09-15"
"mcp-client-2026-09-15"
"ce-plugins-2026-09-01"
"spend-limit-reads-2026-09-26"
"telemetry-destinations-2026-08-11"
"webhooks-2026-10-07"
##### Returns
BetaServiceAccountWorkspaceMember object{ type: "service_account_workspace_member", created_by_actor_id, implicit, 3 more }
type: "service_account_workspace_member"
defaultservice_account_workspace_member
created_by_actor_id: string or null
Tagged ID (`user_...`/`svac_...`) of the actor who created this membership.
implicit: boolean or null
True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed.
service_account_id: string
Tagged service account ID (`svac_...`).
workspace_id: string
Tagged workspace ID (`wrkspc_...`).
workspace_role: [BetaWorkspaceRole](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces#beta_workspace_role)
Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role.
One of the following:
"workspace_admin"
"workspace_billing"
"workspace_developer"
"workspace_restricted_developer"
"workspace_user"
Get Service Account Workspace Member
cURL
```python
curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/service_accounts/$SERVICE_ACCOUNT_ID \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"created_by_actor_id": "created_by_actor_id",
"implicit": true,
"service_account_id": "service_account_id",
"type": "service_account_workspace_member",
"workspace_id": "workspace_id",
"workspace_role": "workspace_admin"
}
```
##### Returns Examples
Response 200
```python
{
"created_by_actor_id": "created_by_actor_id",
"implicit": true,
"service_account_id": "service_account_id",
"type": "service_account_workspace_member",
"workspace_id": "workspace_id",
"workspace_role": "workspace_admin"
---
## Update Service Account Workspace Member - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/workspaces/service_accounts/update
Path: 04-API-Reference/Admin/beta-organization-workspaces-service-accounts-update.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fworkspaces%2Fservice_accounts%2Fupdate)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
List Workspaces
Create Workspace
Get Workspace
Update Workspace
Archive Workspace
Rate Limits
Members
Service Accounts
List Service Account Workspace Members
Create Service Account Workspace Member
Get Service Account Workspace Member
Update Service Account Workspace Member
Delete Service Account Workspace Member
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Workspaces](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces)
5. [Service Accounts](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces/service_accounts)
# Update Service Account Workspace Member
Copy page
cURL
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](../Other/manage-claude-wif-admin-api.md).
Change a service account's role in a workspace.
The new `workspace_role` replaces the current one. Only explicit memberships can be updated; to set a role on the implicit default-workspace membership, add the service account explicitly with `POST /workspaces/{workspace_id}/service_accounts`. Archived workspaces return 400. Archived service accounts cannot be updated and are rejected.
##### Path parameters
workspace_id: string
ID of the workspace.
service_account_id: string
ID of the service account.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"anthropic-beta": optional array of [AnthropicBeta](../Endpoints/platform-claude-com-http-beta.md#anthropic_beta)
Optional header to specify the beta version(s) you want to use.
One of the following:
string
"message-batches-2024-09-24"
"prompt-caching-2024-07-31"
"computer-use-2024-10-22"
"computer-use-2025-01-24"
"pdfs-2024-09-25"
"token-counting-2024-11-01"
"token-efficient-tools-2025-02-19"
"output-128k-2025-02-19"
"files-api-2025-04-14"
"mcp-client-2025-04-04"
"mcp-client-2025-11-20"
"dev-full-thinking-2025-05-14"
"interleaved-thinking-2025-05-14"
"code-execution-2025-05-22"
"extended-cache-ttl-2025-04-11"
"context-1m-2025-08-07"
"context-management-2025-06-27"
"model-context-window-exceeded-2025-08-26"
"skills-2025-10-02"
"fast-mode-2026-02-01"
"output-300k-2026-03-24"
"user-profiles-2026-03-24"
"user-profiles-2026-08-18"
"user-profiles-2026-09-04"
"advisor-tool-2026-03-01"
"managed-agents-2026-04-01"
"cache-diagnosis-2026-04-07"
"dreaming-2026-04-21"
"thinking-token-count-2026-05-13"
"server-side-fallback-2026-06-01"
"server-side-fallback-2026-07-01"
"fallback-credit-2026-06-01"
"fallback-credit-2026-07-01"
"agent-memory-2026-07-22"
"mid-conversation-tool-changes-2026-07-01"
"compact-2026-01-12"
"computer-use-2025-11-24"
"mcp-tunnels-2026-06-22"
"structured-outputs-2025-11-13"
"task-budgets-2026-03-13"
"thinking-display-updates-2026-08-18"
"ce-user-management-2026-07-13"
"mid-conversation-output-config-2026-07-01"
"thinking-binding-controls-2026-08-01"
"mid-conversation-system-clear-at-2026-08-21"
"compact-2026-09-04"
"inline-tools-2026-09-15"
"mcp-client-2026-09-15"
"ce-plugins-2026-09-01"
"spend-limit-reads-2026-09-26"
"telemetry-destinations-2026-08-11"
"webhooks-2026-10-07"
##### Body
workspace_role: [BetaNoBillingWorkspaceRole](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces#beta_no_billing_workspace_role)
New role for the service account in this workspace.
One of the following:
"workspace_admin"
"workspace_developer"
"workspace_restricted_developer"
"workspace_user"
##### Returns
BetaServiceAccountWorkspaceMember object{ type: "service_account_workspace_member", created_by_actor_id, implicit, 3 more }
type: "service_account_workspace_member"
defaultservice_account_workspace_member
created_by_actor_id: string or null
Tagged ID (`user_...`/`svac_...`) of the actor who created this membership.
implicit: boolean or null
True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed.
service_account_id: string
Tagged service account ID (`svac_...`).
workspace_id: string
Tagged workspace ID (`wrkspc_...`).
workspace_role: [BetaWorkspaceRole](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces#beta_workspace_role)
Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role.
One of the following:
"workspace_admin"
"workspace_billing"
"workspace_developer"
"workspace_restricted_developer"
"workspace_user"
Update Service Account Workspace Member
cURL
```python
curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/service_accounts/$SERVICE_ACCOUNT_ID \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY" \
-d '{
"workspace_role": "workspace_admin"
}'
```
Response 200
```python
{
"created_by_actor_id": "created_by_actor_id",
"implicit": true,
"service_account_id": "service_account_id",
"type": "service_account_workspace_member",
"workspace_id": "workspace_id",
"workspace_role": "workspace_admin"
}
```
##### Returns Examples
Response 200
```python
{
"created_by_actor_id": "created_by_actor_id",
"implicit": true,
"service_account_id": "service_account_id",
"type": "service_account_workspace_member",
"workspace_id": "workspace_id",
"workspace_role": "workspace_admin"
---
## Service Accounts - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/workspaces/service_accounts
Path: 04-API-Reference/Admin/beta-organization-workspaces-service-accounts.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fworkspaces%2Fservice_accounts)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
List Workspaces
Create Workspace
Get Workspace
Update Workspace
Archive Workspace
Rate Limits
Members
Service Accounts
List Service Account Workspace Members
Create Service Account Workspace Member
Get Service Account Workspace Member
Update Service Account Workspace Member
Delete Service Account Workspace Member
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Workspaces](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces)
# Service Accounts
Copy page
cURL
##### [List Service Account Workspace Members](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [Create Service Account Workspace Member](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [Get Service Account Workspace Member](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [Update Service Account Workspace Member](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [Delete Service Account Workspace Member](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### Models
ServiceAccountRemoveResponse object{ type: "service_account_workspace_member_deleted", service_account_id, workspace_id }
type: "service_account_workspace_member_deleted"
defaultservice_account_workspace_member_deleted
service_account_id: string
Tagged service account ID (`svac_...`) named in the delete request. Removal is idempotent; see the endpoint description for the implicit-membership no-op.
workspace_id: string
Tagged workspace ID (`wrkspc_...`) named in the delete request.
---
## Update Workspace - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/workspaces/update
Path: 04-API-Reference/Admin/beta-organization-workspaces-update.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fworkspaces%2Fupdate)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
List Workspaces
Create Workspace
Get Workspace
Update Workspace
Archive Workspace
Rate Limits
Members
Service Accounts
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Workspaces](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces)
# Update Workspace
Copy page
cURL
POST/v1/organizations/workspaces/{workspace_id}
Update Workspace
##### Path parameters
workspace_id: string
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
##### Body
data_residency: optional [BetaDataResidencyUpdateConfig](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces#beta_data_residency_update_config) { allowed_inference_geos, default_inference_geo } or null
Data residency configuration for the workspace.
allowed_inference_geos: optional array of [BetaAllowedInferenceGeo](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces#beta_allowed_inference_geo) or "unrestricted" or null
Permitted inference geo values. Use 'unrestricted' to allow all geos, or a list of specific geos.
One of the following:
Geos = array of [BetaAllowedInferenceGeo](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces#beta_allowed_inference_geo)
One of the following:
"global"
"us"
"unrestricted"
default_inference_geo: optional "global" or "us" or null
Default inference geo applied when requests omit the parameter. Must be a member of `allowed_inference_geos` unless `allowed_inference_geos` is `"unrestricted"`.
One of the following:
"global"
"us"
display_color: optional string
Hex color code representing the Workspace in the Anthropic Console.
maxLength7
pattern^#\[0-9A-Fa-f\]{6}\$
external_key_id: optional string
ID of the customer-managed encryption key (CMEK) configuration to use for this Workspace. Setting this field requires CMEK to be enabled for your organization. When set, data stored for this Workspace is encrypted with the referenced key. Create key configurations with the External Keys API. On Claude Platform on AWS the value is the AWS KMS key ARN, and the key must be a single-Region key in the same AWS account and Region as the Workspace. On that platform the key is validated against this Workspace when it is attached, so a key-policy problem is reported as an error on this request. This field is write-once: once a key is attached to a Workspace it cannot be detached or replaced. To rotate key material, rotate the underlying key on your cloud KMS; the `external_key_id` stays the same.
name: optional string
Name of the Workspace.
minLength1
maxLength255
tags: optional map\[string\] or null
User-defined tags as string key-value pairs. Keys may not begin with `anthropic`.
##### Returns
BetaWorkspace object{ type: "workspace", id, archived_at, 7 more }
Update Workspace
cURL
```python
curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY" \
-d '{
"display_color": "#6C5BB9",
"external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK",
"tags": {
"env": "prod",
"team": "platform"
}
}'
```
Response 200
```python
{
"id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ",
"archived_at": "2024-11-01T23:59:27.427722Z",
"compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c",
"created_at": "2024-10-30T23:58:27.427722Z",
"data_residency": {
"allowed_inference_geos": "unrestricted",
"default_inference_geo": "global",
"workspace_geo": "us"
},
"display_color": "#6C5BB9",
"external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK",
"name": "Workspace Name",
"tags": {
"env": "prod",
"team": "platform"
},
"type": "workspace"
}
```
##### Returns Examples
Response 200
```python
{
"id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ",
"archived_at": "2024-11-01T23:59:27.427722Z",
"compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c",
"created_at": "2024-10-30T23:58:27.427722Z",
"data_residency": {
"allowed_inference_geos": "unrestricted",
"default_inference_geo": "global",
"workspace_geo": "us"
},
"display_color": "#6C5BB9",
"external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK",
---
## Workspaces - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/workspaces
Path: 04-API-Reference/Admin/beta-organization-workspaces.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fworkspaces)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
List Workspaces
Create Workspace
Get Workspace
Update Workspace
Archive Workspace
Rate Limits
Members
Service Accounts
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
# Workspaces
Copy page
cURL
##### [List Workspaces](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces/list)
GET/v1/organizations/workspaces
##### [Create Workspace](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces/create)
POST/v1/organizations/workspaces
##### [Get Workspace](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces/retrieve)
GET/v1/organizations/workspaces/{workspace_id}
##### [Update Workspace](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces/update)
POST/v1/organizations/workspaces/{workspace_id}
##### [Archive Workspace](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces/archive)
POST/v1/organizations/workspaces/{workspace_id}/archive
##### Models
BetaAllowedInferenceGeo = "global" or "us"
One of the following:
"global"
"us"
BetaDataResidency object{ allowed_inference_geos, default_inference_geo, workspace_geo }
allowed_inference_geos: array of [BetaAllowedInferenceGeo](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces#beta_allowed_inference_geo) or "unrestricted"
Permitted inference geo values. 'unrestricted' means all geos are allowed.
One of the following:
Geos = array of [BetaAllowedInferenceGeo](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces#beta_allowed_inference_geo)
One of the following:
"global"
"us"
"unrestricted"
default_inference_geo: "global" or "us"
Default inference geo applied when requests omit the parameter.
One of the following:
"global"
"us"
workspace_geo: "us"
Geographic region for workspace data storage. Immutable after creation.
BetaDataResidencyCreateConfig object{ allowed_inference_geos, default_inference_geo, workspace_geo }
allowed_inference_geos: optional array of [BetaAllowedInferenceGeo](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces#beta_allowed_inference_geo) or "unrestricted" or null
Permitted inference geo values. Defaults to 'unrestricted' if omitted, which allows all geos. Use the string 'unrestricted' to allow all geos, or a list of specific geos.
One of the following:
Geos = array of [BetaAllowedInferenceGeo](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces#beta_allowed_inference_geo)
One of the following:
"global"
"us"
"unrestricted"
default_inference_geo: optional "global" or "us" or null
Default inference geo applied when requests omit the parameter. Defaults to 'global' if omitted. Must be a member of `allowed_inference_geos` unless `allowed_inference_geos` is `"unrestricted"`.
One of the following:
"global"
"us"
workspace_geo: optional "us" or null
Geographic region for workspace data storage. Immutable after creation. Defaults to 'us' if omitted.
BetaDataResidencyUpdateConfig object{ allowed_inference_geos, default_inference_geo }
allowed_inference_geos: optional array of [BetaAllowedInferenceGeo](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces#beta_allowed_inference_geo) or "unrestricted" or null
Permitted inference geo values. Use 'unrestricted' to allow all geos, or a list of specific geos.
One of the following:
Geos = array of [BetaAllowedInferenceGeo](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces#beta_allowed_inference_geo)
One of the following:
"global"
"us"
"unrestricted"
default_inference_geo: optional "global" or "us" or null
Default inference geo applied when requests omit the parameter. Must be a member of `allowed_inference_geos` unless `allowed_inference_geos` is `"unrestricted"`.
One of the following:
"global"
"us"
BetaNoBillingWorkspaceRole = "workspace_admin" or "workspace_developer" or "workspace_restricted_developer" or "workspace_user"
One of the following:
"workspace_admin"
"workspace_developer"
"workspace_restricted_developer"
"workspace_user"
BetaWorkspace object{ type: "workspace", id, archived_at, 7 more }
BetaWorkspaceMember object{ type: "workspace_member", user_id, workspace_id, workspace_role }
type: "workspace_member"
Object type.
For Workspace Members, this is always `"workspace_member"`.
defaultworkspace_member
user_id: string
ID of the User.
workspace_id: string
ID of the Workspace.
workspace_role: [BetaWorkspaceRole](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces#beta_workspace_role)
Role of the Workspace Member.
One of the following:
"workspace_admin"
"workspace_billing"
"workspace_developer"
"workspace_restricted_developer"
"workspace_user"
BetaWorkspaceRole = "workspace_admin" or "workspace_billing" or "workspace_developer" or 2 more
One of the following:
"workspace_admin"
"workspace_billing"
"workspace_developer"
"workspace_restricted_developer"
"workspace_user"
#### Workspaces[Rate Limits](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces/rate_limits)
##### [List Workspace Rate Limits](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces/rate_limits/list)
GET/v1/organizations/workspaces/{workspace_id}/rate_limits
List a workspace's rate limits.
##### [Set Workspace Rate Limits](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces/rate_limits/update)
POST/v1/organizations/workspaces/{workspace_id}/rate_limits/{rate_limit_id}
Set or clear rate-limit overrides for one rate-limit group in a workspace.
#### Workspaces[Members](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces/members)
##### [List Workspace Members](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces/members/list)
GET/v1/organizations/workspaces/{workspace_id}/members
##### [Create Workspace Member](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces/members/add)
POST/v1/organizations/workspaces/{workspace_id}/members
##### [Get Workspace Member](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces/members/retrieve)
GET/v1/organizations/workspaces/{workspace_id}/members/{user_id}
##### [Update Workspace Member](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces/members/update)
POST/v1/organizations/workspaces/{workspace_id}/members/{user_id}
##### [Delete Workspace Member](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces/members/remove)
DELETE/v1/organizations/workspaces/{workspace_id}/members/{user_id}
#### Workspaces[Service Accounts](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces/service_accounts)
##### [List Service Account Workspace Members](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [Create Service Account Workspace Member](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [Get Service Account Workspace Member](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [Update Service Account Workspace Member](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [Delete Service Account Workspace Member](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
---
## Query compliance activities - Claude API Reference
Source: https://platform.claude.com/docs/en/api/compliance/activities/list
Path: 04-API-Reference/Admin/compliance-activities-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fcompliance%2Factivities%2Flist)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Query compliance activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
To enable the Compliance API, see the setup guide.
[Set up the Compliance API](../Other/manage-claude-compliance-api-access.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Compliance API](../Endpoints/http-compliance.md)
3. [Activities](https://platform.claude.com/docs/en/api/http/compliance/activities)
# Query compliance activities
Copy page
GET/v1/compliance/activities
List compliance activities for the authenticated tenant.
The tenant is the caller's parent organization, or — for an organization with no parent — the organization itself. Returns a paginated list of compliance activities that can be filtered by various criteria.
##### Query parameters
activity_types: optional array of "abuse_decision_received" or "account_deleted" or "admin_api_key_created" or 533 more
Filter activities by type. See the response `data` schema for the additional fields each type returns. Cannot be combined with `exclude_activity_types[]`.
One of the following:
"abuse_decision_received"
An external anti-abuse service reported a consequential decision about a sign-in or sign-up attempt.
"account_deleted"
User-initiated self-service account deletion.
"admin_api_key_created"
An admin API key was created.
"admin_api_key_deleted"
An admin API key was deleted.
"admin_api_key_updated"
An admin API key was updated (renamed or activated/deactivated).
"admin_connector_request_resolved"
Admin approved or dismissed pending member requests to enable an MCP connector.
"admin_request_created"
Admin request created by an org member (seat upgrade, limit increase, join org, end-user invite).
"admin_setup_checklist_step_delegated"
A step of the Claude Enterprise admin setup checklist was delegated to a teammate — an organization member, or an email address that has not joined the organization yet — replacing any earlier delegation of that step.
"admin_setup_checklist_step_delegation_cancelled"
The delegation of a Claude Enterprise admin setup checklist step was cancelled.
"age_verified"
User age was verified.
"anonymous_mobile_login_attempted"
Anonymous mobile login was attempted.
"api_key_created"
Activity logged when a new API key is created.
"audit_log_export_accessed"
Audit log export file was accessed/downloaded via signed URL.
"audit_log_export_started"
Audit log export was initiated.
"billing_emails_updated"
The organization's billing email recipients were updated.
"ccr_agent_created"
A Claude Code agent was created.
"ccr_agent_deleted"
A Claude Code agent was deleted.
"ccr_agent_proxy_anthropic_oidc_token_exchanged"
The Claude Code agent proxy exchanged a minted identity token for short-lived credentials in the organization's own cloud. Recorded for exchange targets only (such as "aws" and "gcp"; the "direct" target has no exchange step). One event is recorded per exchange call; a request served from the proxy's exchanged-credential cache does not exchange again and is not recorded here. Per-request detail for traffic the credentials were injected into is available in the agent proxy network events.
"ccr_agent_proxy_anthropic_oidc_token_minted"
The Claude Code agent proxy minted a short-lived identity token for an anthropic_oidc credential. One event is recorded per fresh token issuance; a request served from the proxy's short-lived token cache does not mint a new token and is not recorded here. Per-request detail for traffic the credential was injected into is available in the agent proxy network events.
"ccr_agent_proxy_credential_created"
A Claude Code agent proxy credential was created. Credentials hold the secrets the agent proxy injects into requests Claude Code sessions send to approved external services; each credential belongs to an agent proxy profile. Audit events carry only credential names and settings, never the secret material itself.
"ccr_agent_proxy_credential_deleted"
A Claude Code agent proxy credential was deleted. Its secret material was removed and can no longer be sent to any host.
"ccr_agent_proxy_credential_rotated"
A Claude Code agent proxy credential's secret material was replaced. The replacement keeps the same name, profile, and allowed hosts under a new credential identifier, and everything that referenced the old credential now uses the replacement.
"ccr_agent_proxy_credential_updated"
A Claude Code agent proxy credential's settings were updated. Only the display name and the allowed host patterns can be updated; the secret material can only be replaced through a rotation.
"ccr_agent_proxy_destination_deleted"
An agent proxy destination was deleted.
"ccr_agent_proxy_network_events_listed"
A Claude Code network activity export was accessed for the given hour.
"ccr_agent_proxy_profile_bound"
A Claude Code agent proxy profile was bound to a scope, applying its policy to Claude Code sessions in that scope.
"ccr_agent_proxy_profile_created"
A Claude Code agent proxy profile was created. Agent proxy profiles are named, reusable bundles of access policy that administrators bind to parts of the organization.
"ccr_agent_proxy_profile_deleted"
A Claude Code agent proxy profile was deleted, removing its policy from everything it was bound to.
"ccr_agent_proxy_profile_unbound"
A Claude Code agent proxy profile was unbound from a scope, removing its policy from Claude Code sessions in that scope.
"ccr_agent_proxy_profile_updated"
A Claude Code agent proxy profile's configuration was updated.
"ccr_agent_proxy_provisioning_credential_rejected"
An organization owner rejected a credential that a teammate submitted via an agent proxy provisioning link: the credential and its disabled rule were deleted and the link was revoked. The actor is the owner; the submitter is recorded for attribution.
"ccr_agent_proxy_provisioning_link_enabled"
An organization owner enabled a credential that a teammate submitted via an agent proxy provisioning link: the disabled rule created at submission was switched to enforce, so the credential now takes traffic. The actor is the owner; the submitter is the actor on the prior ccr_agent_proxy_provisioning_link_submitted event.
"ccr_agent_proxy_provisioning_link_generated"
An organization owner generated a one-time agent proxy credential provisioning link so a teammate can submit a credential into the target agent proxy profile without holding the owner role.
"ccr_agent_proxy_provisioning_link_revoked"
An organization owner revoked an unfilled agent proxy provisioning link.
"ccr_agent_proxy_provisioning_link_submitted"
A teammate submitted a credential via an agent proxy provisioning link. The credential and a disabled rule are created; the credential takes traffic only after an organization owner enables the submitted credential. This event records the link-mediated lifecycle; the credential itself additionally emits ccr_agent_proxy_credential_created.
"ccr_agent_proxy_rule_created"
An agent proxy rule was created. A rule decides what happens to a session's outbound requests that match it.
"ccr_agent_proxy_rule_deleted"
An agent proxy rule was deleted.
"ccr_agent_proxy_rule_updated"
An agent proxy rule was updated. An update replaces everything the rule matches and does, so the host name patterns here are the rule's complete set after the update.
"ccr_agent_slack_access_scope_created"
A Claude Code agent was granted access to read or write in an additional Slack channel beyond the one it is assigned to.
"ccr_agent_slack_access_scope_deleted"
A Claude Code agent's access to an additional Slack channel was revoked.
"ccr_agent_slack_binding_created"
A Claude Code agent was assigned to a Slack channel or workspace as its dedicated agent.
"ccr_agent_slack_binding_deleted"
A Claude Code agent's assignment to a Slack channel or workspace was removed.
"ccr_agent_updated"
A Claude Code agent's configuration was updated. Also emitted with updated_fields \["is_virtual"\] alone when an auto-provisioned agent is promoted to a configured one, whether by an update request targeting it or by binding an agent proxy profile to it.
"ccr_channel_manager_added"
An org owner/admin assigned an organization member to manage the Claude-in-Slack configuration of one Slack channel.
"ccr_channel_manager_removed"
An org owner/admin removed an organization member's assignment to manage the Claude-in-Slack configuration of one Slack channel.
"ccr_role_channel_assignment_deleted"
CcrRoleChannelAssignmentDeleted is emitted when an org owner/admin removes an RBAC role's channel assignment row (the role reverts to granting zero channels).
"ccr_role_channel_assignment_updated"
CcrRoleChannelAssignmentUpdated is emitted when an org owner/admin sets or replaces the list of Slack channels an RBAC role's holders may configure via the delegated Claude-in-Slack channel-manage surface.
"ccr_session_created"
A Claude Code session was created. A session is one coding interaction with Claude.
"ccr_session_deleted"
A Claude Code session was deleted.
"ccr_session_updated"
A Claude Code session's settings were updated.
"ccr_slack_channel_joined"
Claude's Slack app joined a public Slack channel at an organization administrator's request.
"claude_artifact_access_failed"
An attempt to access an artifact failed.
"claude_artifact_commented"
Comment activity on a published artifact: a comment was added, a thread's resolved state was changed, or a thread was deleted. The actor is the user who performed the action; the comment text itself is stored with the artifact and is not part of this record.
"claude_artifact_comments_viewed"
An artifact's comments were viewed.
"claude_artifact_created"
An artifact was created.
"claude_artifact_duplicated"
A user duplicated an artifact they could view into a new artifact that they own. The actor is the user who created the copy; the source artifact is not modified.
"claude_artifact_external_sharing_permission_updated"
An organization admin allowed one artifact to be shared outside the organization by link while the organization-wide external sharing setting was off, or revoked that permission.
"claude_artifact_invite_accepted"
Someone outside the organization signed in with a verified account for the invited address and accepted an invitation to an artifact, and can now open it; recorded in the artifact owner's organization. The person who accepted is identified by `invitee_email` and `invitee_user_id`.
"claude_artifact_invite_created"
A member invited (or re-invited) an email address outside the organization to an artifact; recorded in the artifact owner's organization with the inviting member as the actor.
"claude_artifact_invite_revoked"
A member withdrew an invitation to an artifact for someone outside the organization, removing any access that invitation had granted; recorded in the artifact owner's organization with that member as the actor.
"claude_artifact_invite_role_updated"
A member changed the access level of an email invitation to an artifact for someone outside the organization, whether the invitation was still pending or had been accepted; recorded in the artifact owner's organization with that member as the actor.
"claude_artifact_published"
A new version of an artifact was published — for an artifact created in a chat this is the action that made it publicly viewable; for an artifact created outside a chat it is recorded when the artifact is saved, including saves of private artifacts, except that automatic saves made while a person keeps editing may be recorded periodically for that person rather than once per save; changes to who can access the artifact are recorded separately as claude_artifact_sharing_updated.
"claude_artifact_sent_to_partner"
A member sent an export of an artifact to a partner application ("Send to …" on the artifact; a partner is a third-party application listed in Claude's connector directory): a file exported from the artifact was made available over a temporary link for the chosen partner to fetch. One activity is recorded per send, in the artifact owner's organization with the sending member as actor, whether or not the partner then retrieved the file; the partner's own import of the file is not part of this record. The file's name and contents are not recorded.
"claude_artifact_sharing_updated"
An artifact's sharing settings were updated.
"claude_artifact_type_default_updated"
An organization's default artifact for an artifact type (for example, its default design system) was set or cleared. Neither artifact named is itself modified.
"claude_artifact_type_pin_updated"
An artifact was pinned or unpinned for an artifact type (for example, a design system was pinned so every member sees it in their picker). Neither artifact named is itself modified, and pinning does not change who can open it.
"claude_artifact_viewed"
An artifact was viewed.
"claude_chat_access_failed"
A user was denied access to a Claude.ai chat conversation.
"claude_chat_created"
User created a chat.
"claude_chat_deleted"
A user deleted a Claude.ai chat conversation.
"claude_chat_deletion_failed"
A request to delete a Claude.ai chat conversation failed.
"claude_chat_settings_updated"
User updated the settings for a conversation.
"claude_chat_snapshot_created"
User created/shared a chat snapshot.
"claude_chat_snapshot_deleted"
User deleted/unshared a chat snapshot.
"claude_chat_snapshot_viewed"
User viewed a chat snapshot (authenticated or public/unauthenticated).
"claude_chat_sync_source_created"
A sync source was connected for syncing external content into Claude chats.
"claude_chat_sync_source_deleted"
A sync source was disconnected from Claude chats.
"claude_chat_sync_source_updated"
A Claude chat sync source's configuration was updated.
"claude_chat_updated"
User updated the chat metadata (e.g name, model).
"claude_chat_viewed"
A user viewed a Claude.ai chat conversation.
"claude_code_credential_revoked"
A Claude Code credential (runner pool key, runner token, or session token) was revoked. The credential itself is never recorded.
"claude_code_review_config_updated"
Claude Code Review configuration was enabled/disabled for an org.
"claude_code_review_repository_added"
A repository was added to org-level Claude Code Review configuration.
"claude_code_review_repository_removed"
A repository was removed from org-level Claude Code Review configuration.
"claude_code_review_repository_updated"
A Claude Code Review repository configuration was updated.
"claude_code_runner_deleted"
A self-hosted runner was forcibly removed from its pool. Sessions assigned to the runner were returned to the pool queue, unless a session had already been requeued repeatedly, in which case it was marked stuck instead of being requeued again.
"claude_code_runner_pool_created"
A self-hosted runner pool for Claude Code was created.
"claude_code_runner_pool_deleted"
A self-hosted runner pool was deleted.
"claude_code_runner_pool_secret_minted"
A registration key for a self-hosted runner pool was minted. Runners present this key to join the pool. The key itself is never recorded.
"claude_code_runner_pool_session_queue_updated"
An admin changed a session's position in its self-hosted runner pool's queue: requeued it onto a different runner, dismissed it from the queue, or re-admitted it for another runner provisioning attempt.
"claude_code_runner_pool_updated"
A self-hosted runner pool's settings were updated.
"claude_code_security_center_config_updated"
Claude Code Security Center scanning was enabled/disabled for an org.
"claude_code_security_scan_cancelled"
In-flight Claude Code Security scans were cancelled for a project.
"claude_code_security_scan_created"
A Claude Code Security scan was started.
"claude_code_security_scan_project_member_updated"
A person's access to a Claude Code Security scan project was granted, changed, or revoked.
"claude_code_security_scan_project_updated"
A Claude Code Security scan project was archived, unarchived, created, or migrated to a new product experience.
"claude_code_security_scan_project_visibility_updated"
A Claude Code Security scan project was shared with the organization or made private.
"claude_code_security_scan_run_updated"
A single Claude Code Security scan run was archived, unarchived, or resumed after a billing pause.
"claude_code_security_scan_schedule_deleted"
A recurring scan schedule was deleted for a Claude Code Security project.
"claude_code_security_scan_schedule_updated"
A recurring scan schedule was set or replaced for a Claude Code Security project.
"claude_code_security_vulnerability_deleted"
A Claude Code Security vulnerability finding was permanently deleted.
"claude_code_security_vulnerability_fix_session_created"
A Claude Code remediation session was created for a Claude Code Security vulnerability finding.
"claude_code_security_vulnerability_updated"
A Claude Code Security vulnerability finding was dismissed, restored, marked fixed, or reopened.
"claude_code_security_webhook_created"
A Claude Code Security outbound webhook was created.
"claude_code_security_webhook_deleted"
A Claude Code Security outbound webhook was deleted.
"claude_code_security_webhook_secret_updated"
The HMAC signing secret for a Claude Code Security webhook was rotated.
"claude_code_security_webhook_updated"
A Claude Code Security outbound webhook was updated.
"claude_code_team_memory_acl_updated"
An RBAC group was added to or removed from the Claude Code team-memory ACL.
"claude_code_team_memory_updated"
Claude Code team memory shared with the organization was updated.
"claude_code_team_onboarding_guide_updated"
A Claude Code team onboarding guide was created, updated, or deleted.
"claude_code_user_marketplaces_updated"
A user's Claude Code plugin marketplace selections were updated on Anthropic servers.
"claude_code_user_memory_updated"
A user's synced private Claude Code memory was updated or deleted on Anthropic servers.
"claude_code_user_plugins_updated"
A user's Claude Code plugin selections — which plugins are installed and enabled — were updated on Anthropic servers.
"claude_code_user_settings_updated"
A user's synced Claude Code settings were updated or deleted on Anthropic servers.
"claude_command_created"
Command was created.
"claude_command_deleted"
Command was deleted.
"claude_command_replaced"
Command was replaced.
"claude_enterprise_upgrade_credit_updated"
An organization admin cancelled, or turned back on, the monthly usage credit the organization receives for upgrading from the Team plan to the Enterprise plan, together with the recurring monthly charge that accompanies it.
"claude_file_access_failed"
A user was denied access to a file in Claude.ai.
"claude_file_deleted"
A file was deleted.
"claude_file_exported"
A file was exported from Claude to an external storage destination.
"claude_file_uploaded"
A file was uploaded.
"claude_file_viewed"
A user viewed a file in Claude.ai.
"claude_gdrive_integration_created"
A Google Drive integration was enabled for the organization.
"claude_gdrive_integration_deleted"
A Google Drive integration was disabled for the organization.
"claude_gdrive_integration_updated"
A Google Drive integration's configuration was updated.
"claude_github_integration_created"
A GitHub integration was enabled for the organization.
"claude_github_integration_deleted"
A GitHub integration was disabled for the organization.
"claude_github_integration_updated"
A GitHub integration's configuration was updated.
"claude_organization_settings_updated"
Organization settings were updated.
"claude_plugin_archive_accessed"
A version archive of a member-owned plugin, containing that member's own files, was downloaded.
"claude_plugin_created"
Plugin was created.
"claude_plugin_deleted"
Plugin was deleted.
"claude_plugin_disabled"
User disabled a plugin for their account.
"claude_plugin_downloaded"
The archive of the plugin version a member was served was downloaded to install or update the plugin in one of the member's Claude apps (Claude in the browser, the Claude desktop app, Claude Code, or a cloud session). Recorded when the member explicitly installs, updates or downloads the plugin (user_action), and when a fetch creates the member's install record for the plugin — its first delivery to them, whether a background sync of a plugin distributed to them or their own first install, which then carries both records (first_delivery). A plugin the member enabled in Claude is on the feed as claude_plugin_enabled and its later delivery by a client's background sync is not recorded again; nor are re-syncs, or fetches that only display the plugin's files in the browser.
"claude_plugin_enabled"
User enabled a plugin for their account.
"claude_plugin_replaced"
Plugin was replaced.
"claude_plugin_security_scan_completed"
A security scan of a plugin completed and produced a verdict.
"claude_plugin_served_version_updated"
A plugin's served version was updated: an administrator or the owner chose a version, a saved version became the served version, or an accepted library submission was published into the plugin.
"claude_plugin_updated"
Plugin was updated.
"claude_plugin_version_created"
A new version of a plugin was created.
"claude_project_archived"
A Claude project was archived.
"claude_project_created"
A Claude project was created.
"claude_project_deleted"
A Claude project was deleted.
"claude_project_document_access_failed"
An attempt to access a document in a Claude project failed.
"claude_project_document_bulk_deletion_audit_truncated"
A bulk request to delete documents from a Claude project failed with more documents requested than were individually recorded in the audit log.
"claude_project_document_deleted"
A document was deleted from a Claude project.
"claude_project_document_deletion_failed"
A request to delete a document from a Claude project failed.
"claude_project_document_updated"
The content of a document in a Claude project was replaced in place.
"claude_project_document_uploaded"
A document was uploaded to a Claude project.
"claude_project_document_viewed"
A document in a Claude project was viewed.
"claude_project_file_access_failed"
An attempt to access a file in a Claude project failed.
"claude_project_file_bulk_deletion_audit_truncated"
A bulk request to delete files from a Claude project failed with more files requested than were individually recorded in the audit log.
"claude_project_file_deleted"
A file was deleted from a Claude project.
"claude_project_file_deletion_failed"
A request to delete a file from a Claude project failed.
"claude_project_file_uploaded"
A file was uploaded to a Claude project.
"claude_project_reported"
A Claude project was reported.
"claude_project_sharing_updated"
A Claude project's sharing settings were updated.
"claude_project_sync_source_created"
A sync source was connected to a Claude project's knowledge base.
"claude_project_sync_source_deleted"
A sync source was disconnected from a Claude project's knowledge base.
"claude_project_sync_source_updated"
A Claude project sync source's configuration was updated.
"claude_project_viewed"
A Claude project was viewed.
"claude_published_artifact_deleted"
A published artifact was deleted or unpublished — by its creator, by an organization admin, or by Anthropic (for example, when it was removed for a policy violation).
"claude_pubsec_identity_configured"
SAML IdP configuration updated for a public sector organization.
"claude_skill_created"
Skill was created.
"claude_skill_deleted"
Skill was deleted.
"claude_skill_disabled"
User disabled a skill for their account.
"claude_skill_downloaded"
A member explicitly downloaded a skill's files to their device: the Download action in Claude, a single file saved from the skill viewer, or an install they asked one of their Claude apps for. Background syncs to the Claude apps, viewing a skill in the app and services reading a skill on the member's behalf are not recorded.
"claude_skill_enabled"
User enabled a skill for their account.
"claude_skill_replaced"
Skill was replaced.
"claude_skill_security_scan_completed"
A security scan of a skill completed and produced a verdict.
"claude_survey_closed"
An organization admin closed an in-app survey before its end date, ending the collection of responses; a survey that reaches its end date records no event.
"claude_survey_created"
An organization admin launched an in-app survey to its chosen audience, opening it immediately or at a scheduled start time.
"claude_survey_deleted"
An organization admin permanently deleted a closed in-app survey together with every response collected for it.
"claude_survey_response_submitted"
A member submitted their response to an in-app survey run by their organization; the record omits the response content, and a retried submission can produce more than one record for the same response.
"claude_survey_responses_exported"
An organization admin downloaded a survey's responses as a CSV file, one row per response with the member's email address (blank if it is no longer available, for example because they left the organization), the groups, department and cost center they were invited through, the product they answered in, the submission time, and their answers.
"claude_user_role_updated"
A user's role within the organization was changed, or the user was added to or removed from the organization.
"claude_user_seat_tier_updated"
An organization member's seat tier was changed. A null `previous_seat_tier` means the member previously had no seat assigned; a null `current_seat_tier` means the seat was removed.
"claude_user_settings_updated"
User updated their personal settings.
"cli_plugin_exec_policy_updated"
Admin set or cleared the per-op permission ceiling for a plugin CLI.
"compliance_api_accessed"
Logging event auto-generated for each compliance API request.
"cowork_session_updated"
A Cowork session was updated.
"design_project_artifact_published"
A Claude Design project's content was published as a claude.ai artifact, making a snapshot of one of its files viewable outside the project's sharing settings.
"design_project_created"
A Claude Design project was created.
"design_project_deleted"
A Claude Design project was deleted.
"design_project_member_added"
A member was granted access to a Claude Design project.
"design_project_member_removed"
A member's access to a Claude Design project was revoked.
"design_project_member_role_updated"
A Claude Design project member's role was changed.
"design_project_published"
A Claude Design template or design system was published, making it discoverable by everyone in its organization.
"design_project_sharing_updated"
A Claude Design project's link-sharing settings were changed — who the project's link works for, and what people opening it through the link may do. Access granted to individual members is reported separately (see design_project_member_added).
"design_project_unpublished"
A Claude Design template or design system was unpublished, removing it from its organization's shared gallery.
"design_project_updated"
A Claude Design project's metadata was updated.
"design_project_version_restored"
A Claude Design project's working tree was rolled back to a previously saved version, replacing its current files with that version's files.
"design_project_viewed"
A Claude Design project's content was read. The surface field records which kind of read — a project open, a full-content read, a single-file read, a saved-version read, or an export request. The actor is the reader.
This activity type is retired: project content reads are no longer recorded. Events of this type may still appear in feeds for reads that occurred while it was active.
"desktop_extension_allowlisted"
A desktop extension was added to an org's allowlist.
"desktop_extension_blocklisted"
A desktop extension was added to the global blocklist.
"desktop_extension_deleted"
A desktop extension was deleted, either globally by an admin or org-scoped by an org owner.
"desktop_extension_removed_from_allowlist"
A desktop extension was removed from an org's allowlist.
"desktop_extension_unblocked"
A desktop extension was removed from the global blocklist.
"desktop_extension_uploaded"
A desktop extension was uploaded, either globally by an admin or org-scoped by an org owner.
"desktop_extension_version_uploaded"
A new version of an existing org-owned desktop extension was uploaded.
"domain_claim_initiated"
Domain capture claim initiated over personal accounts on verified domains.
"end_user_invite_requested"
Non-admin member submitted an invite request for a new org member.
"extra_usage_billing_enabled"
Usage credit billing was enabled for an organization.
"extra_usage_credit_granted"
A promotional usage credit grant was claimed.
"extra_usage_spend_limit_created"
Usage credit spend limit was created.
"extra_usage_spend_limit_deleted"
Usage credit spend limit was deleted.
"extra_usage_spend_limit_increase_request_approved"
A usage credit spend limit increase request was approved.
"extra_usage_spend_limit_increase_request_denied"
A usage credit spend limit increase request was denied.
"extra_usage_spend_limit_updated"
Usage credit spend limit was updated.
"ghe_configuration_created"
Admin created a GHE configuration.
"ghe_configuration_deleted"
Admin deleted a GHE configuration.
"ghe_configuration_updated"
Admin updated a GHE configuration. Previous/new field pairs are recorded only for settings that changed in the update; secret credentials are never recorded, only whether they were replaced.
"ghe_user_connected"
User connected to a GHE instance.
"ghe_user_disconnected"
User disconnected from a GHE instance.
"ghe_webhook_signature_invalid"
Webhook signature validation failed.
"github_app_installation_linked"
An installation of the Claude GitHub App (a GitHub organization or user account where the App is installed) was linked to the organization, letting the organization's Claude Code features act on that GitHub account's repositories.
"github_app_installation_unlinked"
An installation of the Claude GitHub App was unlinked from the organization, so the organization's Claude Code features can no longer act on that GitHub account's repositories through it.
"github_token_import"
A user attempted to import a personal GitHub access token for use with Claude Code. The `result` field indicates the outcome of the import (imported, rejected, or failed).
"gitlab_configuration_created"
An organization admin created a self-managed GitLab configuration for syncing plugin marketplaces.
"gitlab_configuration_deleted"
An organization admin deleted a self-managed GitLab configuration.
"gitlab_configuration_updated"
An organization admin updated a self-managed GitLab configuration. Previous/new field pairs are recorded only for settings that changed in the update; secret credentials are never recorded, only whether they were replaced.
"group_created"
A group was created (RBAC admin or SCIM provisioning).
"group_deleted"
A group was deleted (RBAC admin or SCIM provisioning).
"group_list_viewed"
Admin viewed the list of RBAC groups.
"group_member_added"
One or more members were added to a group.
"group_member_addition_failed"
A request to add members to a group failed. Some of the requested members may have been added before the failure.
"group_member_list_viewed"
Admin viewed the members of an RBAC group.
"group_member_removal_failed"
A request to remove members from a group failed. Some of the requested members may have been removed before the failure.
"group_member_removed"
One or more members were removed from a group.
"group_project_shares_revoked"
An RBAC group's project shares in one organization were revoked in bulk.
"group_skill_shares_revoked"
An RBAC group's skill shares in one organization were revoked in bulk.
"group_updated"
A group was updated (RBAC admin or SCIM provisioning).
"group_viewed"
A group was viewed.
"group_visibility_updated"
An RBAC group's visibility policy was updated.
"inference_hooks_circuit_breaker_tripped"
The organization's Inference hooks circuit breaker tripped automatically: calls to the organization's Inference hooks endpoint crossed a failure threshold, and inspection was suspended to protect live traffic. While tripped, requests are handled according to the organization's failure handling setting — allowed through uninspected (fail open) or rejected (fail closed) — and no per-request Inference hooks activities are recorded. Inspection turns back on by itself once the organization's Inference hooks endpoint returns a valid allow or deny answer to Anthropic's test request again, at least 10 minutes after the trip. An administrator can also end the tripped state by re-enabling Inference hooks inspection. If an administrator saves the Inference hooks settings after the trip (even without changing anything) or generates a new signing secret, inspection no longer turns back on by itself and stays off until an administrator re-enables it.
"inference_hooks_config_deleted"
Inference hooks configuration was removed for the organization.
"inference_hooks_config_updated"
Inference hooks configuration was created or updated for the organization.
"inference_hooks_request_denied"
Inference hooks inspection denied a request. The request was blocked.
"inference_hooks_request_failed_open"
A request proceeded without Inference hooks inspection because a verdict could not be obtained and the organization's Inference hooks configuration is set to fail open.
"inference_hooks_signing_secret_generated"
A request signing secret was generated for the organization's Inference hooks configuration.
"integration_user_connected"
User connected to an integration.
"integration_user_disconnected"
User disconnected from an integration.
"invoice_collection_method_updated"
Invoice collection method was changed.
"lti_launch_initiated"
LTI launch was initiated.
"lti_launch_success"
LTI launch completed successfully.
"lti_platform_created"
Anthropic staff created an LTI platform integration on behalf of an org.
"lti_platform_updated"
Anthropic staff updated an LTI platform integration on behalf of an org.
"magic_link_login_failed"
A magic link sign-in attempt failed.
"magic_link_login_initiated"
A user requested a magic link sign-in email.
"magic_link_login_succeeded"
A user successfully signed in with a magic link email.
"managed_organization_setup_completed"
Managed (AWS Marketplace) organization setup was completed.
"marketplace_created"
Admin created an organization marketplace.
"marketplace_deleted"
Admin deleted an organization marketplace.
"marketplace_updated"
Admin updated an organization marketplace.
"marketplace_webhook_deleted"
Admin removed the GitHub push webhook for a marketplace.
"marketplace_webhook_provisioned"
Admin provisioned a GitHub push webhook for a marketplace.
"mcp_directory_server_published"
The organization published its approved MCP directory listing.
"mcp_server_created"
An MCP server was added to the organization.
"mcp_server_deleted"
An MCP server was removed from the organization.
"mcp_server_managed_auth_token_exchanged"
A user attempted to obtain an access token for an MCP server via enterprise managed authorization. This event reports the outcomes of attempted token exchanges. Repeated failures with the same cause may be reported once until the cause changes, and requests refused before a token exchange is attempted are not reported, except the "connector_scope_not_granted" and "identity_assertion_refused" failures described under error_type.
"mcp_server_managed_auth_updated"
An MCP server's enterprise managed authorization settings were set, changed, or cleared, including when they were supplied while the server was being added or edited. Fields without a "previous\_" prefix describe the settings after the change and are null when the server has no managed authorization settings afterwards; "previous\_" fields describe the settings before the change and are null when the server had none before (always the case for a newly added server).
"mcp_server_updated"
An MCP server's configuration was updated.
"mcp_tool_policy_updated"
The permission restriction for an MCP tool was set or cleared.
"org_analytics_api_capability_updated"
Organization analytics_api capability was enabled or disabled.
"org_bulk_delete_initiated"
Organization bulk deletion was initiated.
"org_capability_grant_added"
A capability grant was added to a workspace or role.
"org_capability_grant_removed"
A capability grant was removed from a workspace or role.
"org_chat_cowork_unified_disabled"
The organization's setting for the unified Chat and Cowork experience was turned off.
"org_chat_cowork_unified_enabled"
The organization's setting for the unified Chat and Cowork experience was turned on.
"org_claude_code_data_sharing_disabled"
Organization Claude Code data sharing was disabled.
"org_claude_code_data_sharing_enabled"
Organization Claude Code data sharing was enabled.
"org_claude_code_desktop_disabled"
Organization Claude Code Desktop was disabled.
"org_claude_code_desktop_enabled"
Organization Claude Code Desktop was enabled.
"org_claude_code_zero_data_retention_disabled"
A primary owner disabled zero data retention for Claude Code, so Claude Code content is retained according to the organization's data retention settings.
"org_compliance_api_settings_updated"
Organization compliance API settings were updated.
"org_connector_domain_guard_updated"
Enterprise admin changed whether connectors are restricted to verified domains.
"org_cowork_act_without_asking_mode_disabled"
The "Act without asking" mode in Cowork was disabled for the organization, so members can no longer let Claude act without asking for approval.
"org_cowork_act_without_asking_mode_enabled"
The "Act without asking" mode in Cowork was enabled for the organization, allowing members to let Claude act without asking for approval.
"org_cowork_agent_disabled"
Organization Cowork Agent was disabled.
"org_cowork_agent_enabled"
Organization Cowork Agent was enabled.
"org_cowork_auto_mode_disabled"
The "Auto" permission mode in Cowork was disabled for the organization, so members can no longer let Claude approve its own actions after a safety check.
"org_cowork_auto_mode_enabled"
The "Auto" permission mode in Cowork was enabled for the organization, allowing members to let Claude approve its own actions after a safety check.
"org_cowork_browser_pane_disabled"
The in-app browser in Cowork was disabled for the organization, so Claude can no longer open or use websites in a browser pane during members' Cowork sessions.
"org_cowork_browser_pane_enabled"
The in-app browser in Cowork was enabled for the organization, letting Claude open and use websites in a browser pane during members' Cowork sessions.
"org_cowork_disabled"
Organization cowork was disabled.
"org_cowork_enabled"
Organization cowork was enabled.
"org_cowork_mcp_always_allow_disabled"
The "Always allow" option for connector tools in Cowork was disabled for the organization, so each use of a connector tool that can make changes requires approval. Read-only connector tools are not affected by this setting.
"org_cowork_mcp_always_allow_enabled"
The "Always allow" option for connector tools in Cowork was enabled for the organization, letting members approve a connector tool that can make changes once and allow its later uses automatically. Read-only connector tools are not affected by this setting.
"org_cowork_otlp_settings_updated"
The organization's Cowork OpenTelemetry monitoring export settings were updated.
"org_cowork_remote_disabled"
Running Cowork in the cloud was disabled for the organization, so members can no longer run Cowork sessions in Anthropic-hosted remote environments.
"org_cowork_remote_enabled"
Running Cowork in the cloud was enabled for the organization, allowing members to run Cowork sessions in Anthropic-hosted remote environments.
"org_creation_blocked"
Organization creation was blocked.
"org_data_export_accessed"
Organization data export file was accessed/downloaded via signed URL.
"org_data_export_completed"
Organization data export was completed.
"org_data_export_started"
Organization data export was started.
"org_data_residency_updated"
The organization's inference data residency settings were updated.
"org_deleted_via_bulk"
Organization was deleted via bulk operation.
"org_deletion_requested"
Organization deletion was requested.
"org_directory_resync_completed"
Organization directory resync completed successfully.
"org_directory_resync_failed"
Organization directory resync failed.
"org_directory_resync_started"
Organization directory resync was started asynchronously.
"org_directory_sync_activated"
Organization directory sync was activated.
"org_directory_sync_add_initiated"
Organization directory sync setup was initiated.
"org_directory_sync_deleted"
Organization directory sync was deleted.
"org_discoverability_disabled"
Admin disabled organization discoverability.
"org_discoverability_enabled"
Admin enabled organization discoverability.
"org_discoverability_settings_updated"
Admin updated organization discoverability settings.
"org_domain_add_initiated"
Organization domain verification was initiated.
"org_domain_removed"
Organization domain was removed.
"org_domain_verified"
Organization domain was verified.
"org_external_key_created"
A CMEK external key config was created.
"org_external_key_deleted"
A CMEK external key config was deleted.
"org_external_key_updated"
A CMEK external key config was updated.
"org_external_key_validated"
A CMEK external key config was validated against the customer's KMS.
"org_hipaa_artifacts_terms_accepted"
An owner of the organization accepted the terms for using artifacts with the HIPAA configuration enabled.
"org_hipaa_claude_code_cowork_restrictions_deferred"
The HIPAA configuration for Claude Code (local mode) and Cowork (local mode) was left off for the organization when the configuration launched, and stays off until it is applied.
"org_hipaa_claude_code_cowork_restrictions_enabled"
The HIPAA configuration was applied to Claude Code (local mode) and Cowork (local mode) for the organization.
"org_hipaa_self_serve_enabled"
A primary owner accepted the Business Associate Agreement and enabled the HIPAA configuration for the organization through the self-serve flow.
"org_invite_link_disabled"
Organization invite link was disabled.
"org_invite_link_generated"
Organization invite link was generated.
"org_invite_link_regenerated"
Organization invite link was regenerated (previous link invalidated).
"org_invite_viewed"
An organization invite was viewed.
"org_invites_listed"
Organization invites were listed.
"org_ip_restriction_created"
Organization IP restriction was created.
"org_ip_restriction_deleted"
Organization IP restriction was deleted.
"org_ip_restriction_updated"
Organization IP restriction was updated.
"org_join_proposal_decided"
Approve or reject decision on a parent-org join proposal.
"org_join_request_approved"
Admin approved a join request.
"org_join_request_created"
User requested to join an organization.
"org_join_request_dismissed"
Admin dismissed a join request.
"org_join_request_instant_approved"
Join request was instantly approved.
"org_join_requests_bulk_dismissed"
Admin bulk-dismissed join requests.
"org_library_submission_created"
A member submitted one of their own skills or plugins for publication into the organization library.
"org_library_submission_resolved"
A member's submission of a skill or plugin to the organization library was accepted or denied, or an accepted one finished publishing.
"org_library_submission_withdrawn"
A pending submission to the organization library was withdrawn before any reviewer decided on it.
"org_magic_link_second_factor_toggled"
Organization magic link second factor was toggled.
"org_member_avatar_removed"
An administrator removed another member's profile picture.
"org_member_invites_disabled"
Admin disabled member invites for the organization.
"org_member_invites_enabled"
Admin enabled member invites for the organization.
"org_members_exported"
Organization members list was exported as CSV.
"org_model_default_updated"
An organization or role default model setting was changed by an administrator.
"org_parent_join_proposal_created"
Organization parent join proposal was created.
"org_parent_search_performed"
Organization parent search was performed.
"org_sso_add_initiated"
Organization SSO setup was initiated.
"org_sso_connection_activated"
Organization SSO connection was activated.
"org_sso_connection_deactivated"
Organization SSO connection was deactivated.
"org_sso_connection_deleted"
Organization SSO connection was deleted.
"org_sso_group_role_mappings_updated"
Organization SSO group role mappings were updated.
"org_sso_provisioning_mode_changed"
Organization SSO provisioning mode was changed.
"org_sso_scim_welcome_email_toggled"
Organization SCIM-provisioned welcome email was toggled.
"org_sso_seat_tier_assignment_toggled"
Organization SSO seat tier assignment was toggled.
"org_sso_seat_tier_mappings_updated"
Organization SSO seat tier mappings were updated.
"org_sso_toggled"
Organization SSO was toggled on or off.
"org_sync_deleting_synchronized_files_started"
Organization started deleting synchronized files.
"org_sync_synchronized_files_deleted"
Organization synchronized files were deleted.
"org_taint_added"
A compliance marker (taint) was added to an organization, for example the marker that records its HIPAA configuration.
"org_taint_removed"
A compliance marker (taint) was removed from an organization.
"org_user_deleted"
User was removed from organization.
"org_user_invite_accepted"
Organization user invite was accepted.
"org_user_invite_deleted"
Organization user invite was deleted.
"org_user_invite_re_sent"
Organization user invite was re-sent.
"org_user_invite_rejected"
Organization user invite was rejected.
"org_user_invite_sent"
Organization user invite was sent.
"org_user_left"
User removed themselves from organization.
"org_user_shares_retained"
A member left or was removed from the organization while projects, skills, plugins, or chats they had shared were still shared, and those shares were kept.
"org_user_trusted_devices_revoked"
An organization admin revoked a member's trusted devices and signed the member out of all active sessions.
"org_user_viewed"
An organization user was viewed.
"org_users_listed"
Organization users were listed.
"org_work_across_apps_disabled"
The organization's "Let Claude work across apps" setting was turned off.
"org_work_across_apps_enabled"
The organization's "Let Claude work across apps" setting was turned on.
"organization_address_updated"
The organization's billing or shipping address was updated.
"organization_icon_deleted"
Organization's custom icon deleted.
"organization_icon_updated"
Organization's custom icon uploaded or replaced.
"owned_projects_access_restored"
Access to owned projects was restored.
"payment_method_updated"
The organization's default payment method was updated.
"pending_share_created"
A pending share of a project or skill was created for an email address that is not yet an organization member.
"pending_share_revoked"
A pending share of a project or skill was revoked before the invitee joined the organization.
"phone_code_sent"
User requested a phone verification code.
"phone_code_verified"
User successfully verified their phone code.
"platform_agent_archived"
An agent was archived on the API platform.
"platform_agent_created"
An agent was created on the API platform.
"platform_agent_deleted"
An agent was deleted from the API platform.
"platform_agent_deployment_archived"
An agent deployment was archived on the API platform.
"platform_agent_deployment_created"
An agent deployment was created on the API platform.
"platform_agent_deployment_deleted"
An agent deployment was deleted from the API platform.
"platform_agent_deployment_paused"
An agent deployment was paused on the API platform.
"platform_agent_deployment_run_triggered"
An agent deployment was run on demand on the API platform.
"platform_agent_deployment_unpaused"
An agent deployment was resumed on the API platform.
"platform_agent_deployment_updated"
An agent deployment was updated on the API platform.
"platform_agent_session_archived"
An agent session was archived on the API platform.
"platform_agent_session_created"
An agent session was created on the API platform.
"platform_agent_session_deleted"
An agent session was deleted from the API platform.
"platform_agent_session_resource_added"
A resource was attached to an agent session.
"platform_agent_session_resource_deleted"
A resource attached to an agent session was removed.
"platform_agent_session_resource_updated"
A resource attached to an agent session was updated.
"platform_agent_session_thread_archived"
A thread within an agent session was archived.
"platform_agent_session_updated"
An agent session was updated on the API platform.
"platform_agent_updated"
An agent was updated on the API platform.
"platform_api_key_created"
An API key was created.
"platform_api_key_updated"
An API key was updated.
"platform_app_attest_authentication"
An attested mobile device attempted to exchange an Apple App Attest assertion for Anthropic API credentials.
"platform_billing_upgraded_to_prepaid"
The organization's API billing was upgraded to the prepaid plan.
"platform_clearance_workspace_program_request_cleared"
A workspace's clearance program assignment was removed.
"platform_clearance_workspace_program_request_set"
A workspace's clearance program assignment was created or updated.
"platform_cost_report_viewed"
The cost report was viewed.
"platform_dream_archived"
A Dream (asynchronous memory-consolidation job) was archived.
"platform_dream_cancelled"
A Dream (asynchronous memory-consolidation job) was cancelled before it completed.
"platform_dream_created"
A Dream (asynchronous memory-consolidation job) was created.
"platform_federated_authentication"
A federated workload identity attempted to exchange an OIDC token for Anthropic API credentials.
"platform_federation_issuer_archived"
An OIDC federation issuer was archived.
"platform_federation_issuer_created"
An OIDC federation issuer was created, registering an external identity provider that federation rules can trust for workload authentication.
"platform_federation_issuer_updated"
An OIDC federation issuer was updated.
"platform_federation_rule_archived"
An OIDC federation rule was archived.
"platform_federation_rule_created"
An OIDC federation rule was created, allowing tokens from a federation issuer to authenticate as a service account or user. Rules may additionally match on token claims or a condition expression, which are not included in this event.
"platform_federation_rule_updated"
An OIDC federation rule was updated.
"platform_federation_rule_workspace_added"
A federation rule was enabled for a workspace.
"platform_federation_rule_workspace_removed"
A federation rule was disabled for a workspace.
"platform_file_content_downloaded"
Activity logged when file content is downloaded via GET /v1/files/{file_id}/content.
"platform_file_deleted"
Activity logged when a file is deleted via DELETE /v1/files/{file_id}.
"platform_file_uploaded"
Activity logged when a file is uploaded via POST /v1/files.
"platform_memory_created"
An agent memory document was created.
"platform_memory_deleted"
An agent memory document was deleted.
"platform_memory_store_archived"
An agent memory store was archived. Archived stores reject new memory writes and cannot be attached to new sessions; deletion and redaction remain permitted for privacy scrubbing.
"platform_memory_store_created"
An agent memory store was created.
"platform_memory_store_deleted"
An agent memory store was deleted. Memory content removal may complete asynchronously for very large stores.
"platform_memory_store_updated"
An agent memory store's name, description, or metadata was updated.
"platform_memory_updated"
An agent memory document's content or path was updated.
"platform_memory_version_redacted"
A historical version of an agent memory document was redacted. Redaction scrubs the stored content of a specific version while preserving the version's existence in the history.
"platform_oauth_app_created"
An OAuth app was created.
"platform_oauth_app_revoked"
An OAuth app was revoked.
"platform_oauth_app_updated"
An OAuth app was updated.
"platform_organization_created"
An owner of the organization created a Claude Console organization under the same parent organization.
"platform_plugin_directory_submission_created"
A plugin directory submission was created on the API platform. A plugin directory submission is a request to list a plugin in the public plugin directory.
"platform_plugin_directory_submission_deleted"
A plugin directory submission was deleted on the API platform.
"platform_plugin_directory_submission_updated"
A plugin directory submission was updated on the API platform.
"platform_service_account_archived"
A service account was archived.
"platform_service_account_created"
A service account was created.
"platform_service_account_updated"
A service account was updated.
"platform_service_account_workspace_member_added"
A service account was added as a member of a workspace.
"platform_service_account_workspace_member_removed"
A service account was removed from a workspace.
"platform_service_account_workspace_member_updated"
A service account's workspace membership role was updated.
"platform_signing_key_created"
Activity logged when a new request-signing key is registered for the org.
"platform_signing_key_deleted"
Activity logged when a signing key is permanently deleted.
"platform_signing_key_rotated"
Activity logged when an in-memory signing key is rotated.
"platform_skill_version_content_downloaded"
The content of a skill version was downloaded through the Skills API.
"platform_skill_version_created"
Activity logged when a skill version is created via POST /v1/skills/{skill_id}/versions.
"platform_skill_version_deleted"
Activity logged when a skill version is deleted via DELETE /v1/skills/{skill_id}/versions/{version}.
"platform_spend_limit_alert_emails_updated"
Spend limit alert email addresses and role targets were updated for an org.
"platform_spend_limit_created"
An org-level fixed-dollar spend limit was created.
"platform_spend_limit_deleted"
An org-level spend limit was removed.
"platform_spend_limit_updated"
An org-level spend limit snooze/ignore state was changed.
"platform_usage_report_claude_code_viewed"
The Claude Code usage report was viewed.
"platform_usage_report_messages_viewed"
The messages usage report was viewed.
"platform_workspace_archived"
A workspace was archived.
"platform_workspace_created"
A workspace was created.
"platform_workspace_inference_data_retention_disabled"
The zero data retention override was disabled for a workspace.
"platform_workspace_inference_data_retention_enabled"
The zero data retention override was enabled for a workspace.
"platform_workspace_member_added"
A member was added to a workspace.
"platform_workspace_member_removed"
A member was removed from a workspace.
"platform_workspace_member_updated"
A workspace member was updated.
"platform_workspace_member_viewed"
A workspace member was viewed.
"platform_workspace_members_listed"
Workspace members were listed.
"platform_workspace_rate_limit_deleted"
A workspace rate limit was deleted.
"platform_workspace_rate_limit_updated"
A workspace rate limit was created or updated.
"platform_workspace_updated"
A workspace was updated.
"plugin_installation_preference_updated"
An org admin changed the installation preference for a plugin.
"prepaid_auto_recharge_disabled"
Auto-recharge was disabled for API prepaid org.
"prepaid_auto_recharge_updated"
Auto-recharge settings were updated for API prepaid org.
"prepaid_extra_usage_auto_reload_disabled"
Prepaid usage credit auto-reload was disabled.
"prepaid_extra_usage_auto_reload_enabled"
Prepaid usage credit auto-reload was enabled.
"prepaid_extra_usage_auto_reload_settings_updated"
Prepaid usage credit auto-reload settings were updated.
"primary_owner_transferred"
Primary owner role was transferred to another org member.
"rbac_role_assigned"
Admin assigned an RBAC custom role to a principal.
"rbac_role_created"
Admin created an RBAC custom role.
"rbac_role_deleted"
Admin deleted an RBAC custom role.
"rbac_role_grant_updated"
Admin requested a capability grant for an RBAC custom role, or removed it.
Records the admin's change to the role. Whether the grant is currently in effect on the role is reported separately.
"rbac_role_permission_added"
Admin added a permission to an RBAC custom role.
Emitted once per requested permission, including permissions the role already had, so a retried request still produces a complete audit record.
"rbac_role_permission_removed"
Admin removed a permission from an RBAC custom role.
Emitted once per requested permission, including permissions the role already lacked, so a retried request still produces a complete audit record.
"rbac_role_unassigned"
Admin unassigned an RBAC custom role from a principal.
"rbac_role_updated"
Admin updated an RBAC custom role.
"role_assignment_granted"
Role assignment was granted.
"role_assignment_revoked"
Role assignment was revoked.
"scim_user_created"
A SCIM user was provisioned.
"scim_user_deleted"
A SCIM user was deleted.
"scim_user_updated"
A SCIM user was updated.
"scoped_api_key_deleted"
A scoped API key was deleted.
"scoped_api_key_updated"
A scoped API key was renamed or its activation state changed.
"seat_tier_changes_cancelled"
Scheduled seat tier downgrades were cancelled.
"seat_tiers_purchased"
Seat tiers were purchased or upgraded on a subscription.
"service_created"
Activity logged when an org service is explicitly created.
"service_deleted"
Activity logged when an org service is deleted.
"service_key_created"
Activity logged when a new org service key is created.
"service_key_revoked"
Activity logged when an org service key is revoked.
"session_revoked"
User revoked a specific session.
"session_share_accessed"
Session share was accessed.
"session_share_created"
Session share was created.
"session_share_revoked"
Session share was revoked.
"slack_workspace_claim_revoked"
A Slack workspace or Enterprise Grid organization was disconnected from the organization for Claude in Slack.
"slack_workspace_claimed"
A Slack workspace or Enterprise Grid organization was connected to the organization for Claude in Slack.
"social_login_succeeded"
A user successfully signed in with a social identity provider (Google, Apple, or Microsoft).
"sso_login_failed"
An SSO sign-in attempt failed.
"sso_login_initiated"
A user started an SSO sign-in flow.
"sso_login_succeeded"
A user successfully signed in with SSO.
"sso_second_factor_magic_link"
SSO second factor magic link was used.
"step_up_authentication_failed"
An additional identity check failed.
"step_up_authentication_succeeded"
The user completed an additional identity check to confirm a sensitive action.
"step_up_credential_enrolled"
A user enrolled a passkey for confirming sensitive actions on their account.
"subscription_cancellation_scheduled"
Subscription cancellation was scheduled at end of billing period.
"subscription_quantity_updated"
Contracted subscription seat quantity was updated.
"subscription_renewed"
A cancelled subscription was renewed.
"subscription_resumed"
A scheduled subscription cancellation was reversed.
"subscription_started"
A new subscription was created (Team or Enterprise).
"subscription_upgraded"
Subscription plan was upgraded (e.g. Team to Enterprise).
"trusted_device_credential_rotated"
The identity-verification credential of a trusted device was rotated to a new key.
"trusted_device_enrolled"
A device was enrolled as a trusted device for the user's account. Trusted devices can be used to confirm the user's identity for sensitive actions.
"trusted_device_revoked"
A trusted device was removed from the user's account.
"tunnel_archived"
An MCP tunnel was archived.
"tunnel_certificate_added"
An inner-TLS CA certificate was added to a tunnel.
"tunnel_certificate_revoked"
An inner-TLS CA certificate was revoked from a tunnel.
"tunnel_created"
An MCP tunnel was created.
"tunnel_token_minted"
An OAuth bearer token for the tunnel management API was minted.
"tunnel_token_revealed"
The Cloudflare connector secret for a tunnel was revealed to the caller.
"tunnel_token_revoked"
An OAuth bearer token for the tunnel management API was revoked.
"tunnel_token_rotated"
The Cloudflare connector secret for a tunnel was rotated.
`tunnel_token_id` is the id of the *newly-issued* token. The previous token is invalidated by the rotation and its id is not recorded here.
"user_consent_recorded"
User granted a consent for a specific entity (e.g. consumer health consent for an MCP server).
"user_consent_revoked"
User revoked a previously granted consent for a specific entity.
"user_logged_out"
A user signed out of one or all sessions.
"verification_evidence_submitted"
Verification evidence was submitted for an organization's verification.
"verification_program_application_created"
An organization applied to a verification program.
"workspace_member_spend_limit_created"
A per-member or workspace-default Claude Code spend limit was created.
"workspace_member_spend_limit_deleted"
A per-member or workspace-default Claude Code spend limit was deleted.
"workspace_member_spend_limit_updated"
A per-member Claude Code spend limit amount was updated.
"workspace_spend_limit_alert_emails_updated"
Spend limit alert email recipients were updated for a workspace.
"workspace_spend_limit_created"
A workspace-level API spend limit was created.
"workspace_spend_limit_deleted"
A workspace-level API spend limit was deleted.
actor_ids: optional array of string
Filter activities by actor IDs (currently only `user_...` IDs are supported). Enumerate IDs via `GET /v1/compliance/organizations/{org_uuid}/users`.
after_id: optional string
Pagination cursor for retrieving the next page of results. To paginate, pass the `last_id` value from the most recent response. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.
before_id: optional string
Pagination cursor for retrieving the previous page of results. To paginate, pass the `first_id` value from the most recent response. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.
created_at: optional object{ gt, gte, lt, lte }
gt: optional string
Filter activities created after this time (RFC 3339 format)
formatdate-time
gte: optional string
Filter activities created at or after this time (RFC 3339 format)
formatdate-time
lt: optional string
Filter activities created before this time (RFC 3339 format)
formatdate-time
lte: optional string
Filter activities created at or before this time (RFC 3339 format)
formatdate-time
exclude_activity_types: optional array of "abuse_decision_received" or "account_deleted" or "admin_api_key_created" or 533 more
Exclude activities of these types. Cannot be combined with `activity_types[]`.
One of the following:
"abuse_decision_received"
An external anti-abuse service reported a consequential decision about a sign-in or sign-up attempt.
"account_deleted"
User-initiated self-service account deletion.
"admin_api_key_created"
An admin API key was created.
"admin_api_key_deleted"
An admin API key was deleted.
"admin_api_key_updated"
An admin API key was updated (renamed or activated/deactivated).
"admin_connector_request_resolved"
Admin approved or dismissed pending member requests to enable an MCP connector.
"admin_request_created"
Admin request created by an org member (seat upgrade, limit increase, join org, end-user invite).
"admin_setup_checklist_step_delegated"
A step of the Claude Enterprise admin setup checklist was delegated to a teammate — an organization member, or an email address that has not joined the organization yet — replacing any earlier delegation of that step.
"admin_setup_checklist_step_delegation_cancelled"
The delegation of a Claude Enterprise admin setup checklist step was cancelled.
"age_verified"
User age was verified.
"anonymous_mobile_login_attempted"
Anonymous mobile login was attempted.
"api_key_created"
Activity logged when a new API key is created.
"audit_log_export_accessed"
Audit log export file was accessed/downloaded via signed URL.
"audit_log_export_started"
Audit log export was initiated.
"billing_emails_updated"
The organization's billing email recipients were updated.
"ccr_agent_created"
A Claude Code agent was created.
"ccr_agent_deleted"
A Claude Code agent was deleted.
"ccr_agent_proxy_anthropic_oidc_token_exchanged"
The Claude Code agent proxy exchanged a minted identity token for short-lived credentials in the organization's own cloud. Recorded for exchange targets only (such as "aws" and "gcp"; the "direct" target has no exchange step). One event is recorded per exchange call; a request served from the proxy's exchanged-credential cache does not exchange again and is not recorded here. Per-request detail for traffic the credentials were injected into is available in the agent proxy network events.
"ccr_agent_proxy_anthropic_oidc_token_minted"
The Claude Code agent proxy minted a short-lived identity token for an anthropic_oidc credential. One event is recorded per fresh token issuance; a request served from the proxy's short-lived token cache does not mint a new token and is not recorded here. Per-request detail for traffic the credential was injected into is available in the agent proxy network events.
"ccr_agent_proxy_credential_created"
A Claude Code agent proxy credential was created. Credentials hold the secrets the agent proxy injects into requests Claude Code sessions send to approved external services; each credential belongs to an agent proxy profile. Audit events carry only credential names and settings, never the secret material itself.
"ccr_agent_proxy_credential_deleted"
A Claude Code agent proxy credential was deleted. Its secret material was removed and can no longer be sent to any host.
"ccr_agent_proxy_credential_rotated"
A Claude Code agent proxy credential's secret material was replaced. The replacement keeps the same name, profile, and allowed hosts under a new credential identifier, and everything that referenced the old credential now uses the replacement.
"ccr_agent_proxy_credential_updated"
A Claude Code agent proxy credential's settings were updated. Only the display name and the allowed host patterns can be updated; the secret material can only be replaced through a rotation.
"ccr_agent_proxy_destination_deleted"
An agent proxy destination was deleted.
"ccr_agent_proxy_network_events_listed"
A Claude Code network activity export was accessed for the given hour.
"ccr_agent_proxy_profile_bound"
A Claude Code agent proxy profile was bound to a scope, applying its policy to Claude Code sessions in that scope.
"ccr_agent_proxy_profile_created"
A Claude Code agent proxy profile was created. Agent proxy profiles are named, reusable bundles of access policy that administrators bind to parts of the organization.
"ccr_agent_proxy_profile_deleted"
A Claude Code agent proxy profile was deleted, removing its policy from everything it was bound to.
"ccr_agent_proxy_profile_unbound"
A Claude Code agent proxy profile was unbound from a scope, removing its policy from Claude Code sessions in that scope.
"ccr_agent_proxy_profile_updated"
A Claude Code agent proxy profile's configuration was updated.
"ccr_agent_proxy_provisioning_credential_rejected"
An organization owner rejected a credential that a teammate submitted via an agent proxy provisioning link: the credential and its disabled rule were deleted and the link was revoked. The actor is the owner; the submitter is recorded for attribution.
"ccr_agent_proxy_provisioning_link_enabled"
An organization owner enabled a credential that a teammate submitted via an agent proxy provisioning link: the disabled rule created at submission was switched to enforce, so the credential now takes traffic. The actor is the owner; the submitter is the actor on the prior ccr_agent_proxy_provisioning_link_submitted event.
"ccr_agent_proxy_provisioning_link_generated"
An organization owner generated a one-time agent proxy credential provisioning link so a teammate can submit a credential into the target agent proxy profile without holding the owner role.
"ccr_agent_proxy_provisioning_link_revoked"
An organization owner revoked an unfilled agent proxy provisioning link.
"ccr_agent_proxy_provisioning_link_submitted"
A teammate submitted a credential via an agent proxy provisioning link. The credential and a disabled rule are created; the credential takes traffic only after an organization owner enables the submitted credential. This event records the link-mediated lifecycle; the credential itself additionally emits ccr_agent_proxy_credential_created.
"ccr_agent_proxy_rule_created"
An agent proxy rule was created. A rule decides what happens to a session's outbound requests that match it.
"ccr_agent_proxy_rule_deleted"
An agent proxy rule was deleted.
"ccr_agent_proxy_rule_updated"
An agent proxy rule was updated. An update replaces everything the rule matches and does, so the host name patterns here are the rule's complete set after the update.
"ccr_agent_slack_access_scope_created"
A Claude Code agent was granted access to read or write in an additional Slack channel beyond the one it is assigned to.
"ccr_agent_slack_access_scope_deleted"
A Claude Code agent's access to an additional Slack channel was revoked.
"ccr_agent_slack_binding_created"
A Claude Code agent was assigned to a Slack channel or workspace as its dedicated agent.
"ccr_agent_slack_binding_deleted"
A Claude Code agent's assignment to a Slack channel or workspace was removed.
"ccr_agent_updated"
A Claude Code agent's configuration was updated. Also emitted with updated_fields \["is_virtual"\] alone when an auto-provisioned agent is promoted to a configured one, whether by an update request targeting it or by binding an agent proxy profile to it.
"ccr_channel_manager_added"
An org owner/admin assigned an organization member to manage the Claude-in-Slack configuration of one Slack channel.
"ccr_channel_manager_removed"
An org owner/admin removed an organization member's assignment to manage the Claude-in-Slack configuration of one Slack channel.
"ccr_role_channel_assignment_deleted"
CcrRoleChannelAssignmentDeleted is emitted when an org owner/admin removes an RBAC role's channel assignment row (the role reverts to granting zero channels).
"ccr_role_channel_assignment_updated"
CcrRoleChannelAssignmentUpdated is emitted when an org owner/admin sets or replaces the list of Slack channels an RBAC role's holders may configure via the delegated Claude-in-Slack channel-manage surface.
"ccr_session_created"
A Claude Code session was created. A session is one coding interaction with Claude.
"ccr_session_deleted"
A Claude Code session was deleted.
"ccr_session_updated"
A Claude Code session's settings were updated.
"ccr_slack_channel_joined"
Claude's Slack app joined a public Slack channel at an organization administrator's request.
"claude_artifact_access_failed"
An attempt to access an artifact failed.
"claude_artifact_commented"
Comment activity on a published artifact: a comment was added, a thread's resolved state was changed, or a thread was deleted. The actor is the user who performed the action; the comment text itself is stored with the artifact and is not part of this record.
"claude_artifact_comments_viewed"
An artifact's comments were viewed.
"claude_artifact_created"
An artifact was created.
"claude_artifact_duplicated"
A user duplicated an artifact they could view into a new artifact that they own. The actor is the user who created the copy; the source artifact is not modified.
"claude_artifact_external_sharing_permission_updated"
An organization admin allowed one artifact to be shared outside the organization by link while the organization-wide external sharing setting was off, or revoked that permission.
"claude_artifact_invite_accepted"
Someone outside the organization signed in with a verified account for the invited address and accepted an invitation to an artifact, and can now open it; recorded in the artifact owner's organization. The person who accepted is identified by `invitee_email` and `invitee_user_id`.
"claude_artifact_invite_created"
A member invited (or re-invited) an email address outside the organization to an artifact; recorded in the artifact owner's organization with the inviting member as the actor.
"claude_artifact_invite_revoked"
A member withdrew an invitation to an artifact for someone outside the organization, removing any access that invitation had granted; recorded in the artifact owner's organization with that member as the actor.
"claude_artifact_invite_role_updated"
A member changed the access level of an email invitation to an artifact for someone outside the organization, whether the invitation was still pending or had been accepted; recorded in the artifact owner's organization with that member as the actor.
"claude_artifact_published"
A new version of an artifact was published — for an artifact created in a chat this is the action that made it publicly viewable; for an artifact created outside a chat it is recorded when the artifact is saved, including saves of private artifacts, except that automatic saves made while a person keeps editing may be recorded periodically for that person rather than once per save; changes to who can access the artifact are recorded separately as claude_artifact_sharing_updated.
"claude_artifact_sent_to_partner"
A member sent an export of an artifact to a partner application ("Send to …" on the artifact; a partner is a third-party application listed in Claude's connector directory): a file exported from the artifact was made available over a temporary link for the chosen partner to fetch. One activity is recorded per send, in the artifact owner's organization with the sending member as actor, whether or not the partner then retrieved the file; the partner's own import of the file is not part of this record. The file's name and contents are not recorded.
"claude_artifact_sharing_updated"
An artifact's sharing settings were updated.
"claude_artifact_type_default_updated"
An organization's default artifact for an artifact type (for example, its default design system) was set or cleared. Neither artifact named is itself modified.
"claude_artifact_type_pin_updated"
An artifact was pinned or unpinned for an artifact type (for example, a design system was pinned so every member sees it in their picker). Neither artifact named is itself modified, and pinning does not change who can open it.
"claude_artifact_viewed"
An artifact was viewed.
"claude_chat_access_failed"
A user was denied access to a Claude.ai chat conversation.
"claude_chat_created"
User created a chat.
"claude_chat_deleted"
A user deleted a Claude.ai chat conversation.
"claude_chat_deletion_failed"
A request to delete a Claude.ai chat conversation failed.
"claude_chat_settings_updated"
User updated the settings for a conversation.
"claude_chat_snapshot_created"
User created/shared a chat snapshot.
"claude_chat_snapshot_deleted"
User deleted/unshared a chat snapshot.
"claude_chat_snapshot_viewed"
User viewed a chat snapshot (authenticated or public/unauthenticated).
"claude_chat_sync_source_created"
A sync source was connected for syncing external content into Claude chats.
"claude_chat_sync_source_deleted"
A sync source was disconnected from Claude chats.
"claude_chat_sync_source_updated"
A Claude chat sync source's configuration was updated.
"claude_chat_updated"
User updated the chat metadata (e.g name, model).
"claude_chat_viewed"
A user viewed a Claude.ai chat conversation.
"claude_code_credential_revoked"
A Claude Code credential (runner pool key, runner token, or session token) was revoked. The credential itself is never recorded.
"claude_code_review_config_updated"
Claude Code Review configuration was enabled/disabled for an org.
"claude_code_review_repository_added"
A repository was added to org-level Claude Code Review configuration.
"claude_code_review_repository_removed"
A repository was removed from org-level Claude Code Review configuration.
"claude_code_review_repository_updated"
A Claude Code Review repository configuration was updated.
"claude_code_runner_deleted"
A self-hosted runner was forcibly removed from its pool. Sessions assigned to the runner were returned to the pool queue, unless a session had already been requeued repeatedly, in which case it was marked stuck instead of being requeued again.
"claude_code_runner_pool_created"
A self-hosted runner pool for Claude Code was created.
"claude_code_runner_pool_deleted"
A self-hosted runner pool was deleted.
"claude_code_runner_pool_secret_minted"
A registration key for a self-hosted runner pool was minted. Runners present this key to join the pool. The key itself is never recorded.
"claude_code_runner_pool_session_queue_updated"
An admin changed a session's position in its self-hosted runner pool's queue: requeued it onto a different runner, dismissed it from the queue, or re-admitted it for another runner provisioning attempt.
"claude_code_runner_pool_updated"
A self-hosted runner pool's settings were updated.
"claude_code_security_center_config_updated"
Claude Code Security Center scanning was enabled/disabled for an org.
"claude_code_security_scan_cancelled"
In-flight Claude Code Security scans were cancelled for a project.
"claude_code_security_scan_created"
A Claude Code Security scan was started.
"claude_code_security_scan_project_member_updated"
A person's access to a Claude Code Security scan project was granted, changed, or revoked.
"claude_code_security_scan_project_updated"
A Claude Code Security scan project was archived, unarchived, created, or migrated to a new product experience.
"claude_code_security_scan_project_visibility_updated"
A Claude Code Security scan project was shared with the organization or made private.
"claude_code_security_scan_run_updated"
A single Claude Code Security scan run was archived, unarchived, or resumed after a billing pause.
"claude_code_security_scan_schedule_deleted"
A recurring scan schedule was deleted for a Claude Code Security project.
"claude_code_security_scan_schedule_updated"
A recurring scan schedule was set or replaced for a Claude Code Security project.
"claude_code_security_vulnerability_deleted"
A Claude Code Security vulnerability finding was permanently deleted.
"claude_code_security_vulnerability_fix_session_created"
A Claude Code remediation session was created for a Claude Code Security vulnerability finding.
"claude_code_security_vulnerability_updated"
A Claude Code Security vulnerability finding was dismissed, restored, marked fixed, or reopened.
"claude_code_security_webhook_created"
A Claude Code Security outbound webhook was created.
"claude_code_security_webhook_deleted"
A Claude Code Security outbound webhook was deleted.
"claude_code_security_webhook_secret_updated"
The HMAC signing secret for a Claude Code Security webhook was rotated.
"claude_code_security_webhook_updated"
A Claude Code Security outbound webhook was updated.
"claude_code_team_memory_acl_updated"
An RBAC group was added to or removed from the Claude Code team-memory ACL.
"claude_code_team_memory_updated"
Claude Code team memory shared with the organization was updated.
"claude_code_team_onboarding_guide_updated"
A Claude Code team onboarding guide was created, updated, or deleted.
"claude_code_user_marketplaces_updated"
A user's Claude Code plugin marketplace selections were updated on Anthropic servers.
"claude_code_user_memory_updated"
A user's synced private Claude Code memory was updated or deleted on Anthropic servers.
"claude_code_user_plugins_updated"
A user's Claude Code plugin selections — which plugins are installed and enabled — were updated on Anthropic servers.
"claude_code_user_settings_updated"
A user's synced Claude Code settings were updated or deleted on Anthropic servers.
"claude_command_created"
Command was created.
"claude_command_deleted"
Command was deleted.
"claude_command_replaced"
Command was replaced.
"claude_enterprise_upgrade_credit_updated"
An organization admin cancelled, or turned back on, the monthly usage credit the organization receives for upgrading from the Team plan to the Enterprise plan, together with the recurring monthly charge that accompanies it.
"claude_file_access_failed"
A user was denied access to a file in Claude.ai.
"claude_file_deleted"
A file was deleted.
"claude_file_exported"
A file was exported from Claude to an external storage destination.
"claude_file_uploaded"
A file was uploaded.
"claude_file_viewed"
A user viewed a file in Claude.ai.
"claude_gdrive_integration_created"
A Google Drive integration was enabled for the organization.
"claude_gdrive_integration_deleted"
A Google Drive integration was disabled for the organization.
"claude_gdrive_integration_updated"
A Google Drive integration's configuration was updated.
"claude_github_integration_created"
A GitHub integration was enabled for the organization.
"claude_github_integration_deleted"
A GitHub integration was disabled for the organization.
"claude_github_integration_updated"
A GitHub integration's configuration was updated.
"claude_organization_settings_updated"
Organization settings were updated.
"claude_plugin_archive_accessed"
A version archive of a member-owned plugin, containing that member's own files, was downloaded.
"claude_plugin_created"
Plugin was created.
"claude_plugin_deleted"
Plugin was deleted.
"claude_plugin_disabled"
User disabled a plugin for their account.
"claude_plugin_downloaded"
The archive of the plugin version a member was served was downloaded to install or update the plugin in one of the member's Claude apps (Claude in the browser, the Claude desktop app, Claude Code, or a cloud session). Recorded when the member explicitly installs, updates or downloads the plugin (user_action), and when a fetch creates the member's install record for the plugin — its first delivery to them, whether a background sync of a plugin distributed to them or their own first install, which then carries both records (first_delivery). A plugin the member enabled in Claude is on the feed as claude_plugin_enabled and its later delivery by a client's background sync is not recorded again; nor are re-syncs, or fetches that only display the plugin's files in the browser.
"claude_plugin_enabled"
User enabled a plugin for their account.
"claude_plugin_replaced"
Plugin was replaced.
"claude_plugin_security_scan_completed"
A security scan of a plugin completed and produced a verdict.
"claude_plugin_served_version_updated"
A plugin's served version was updated: an administrator or the owner chose a version, a saved version became the served version, or an accepted library submission was published into the plugin.
"claude_plugin_updated"
Plugin was updated.
"claude_plugin_version_created"
A new version of a plugin was created.
"claude_project_archived"
A Claude project was archived.
"claude_project_created"
A Claude project was created.
"claude_project_deleted"
A Claude project was deleted.
"claude_project_document_access_failed"
An attempt to access a document in a Claude project failed.
"claude_project_document_bulk_deletion_audit_truncated"
A bulk request to delete documents from a Claude project failed with more documents requested than were individually recorded in the audit log.
"claude_project_document_deleted"
A document was deleted from a Claude project.
"claude_project_document_deletion_failed"
A request to delete a document from a Claude project failed.
"claude_project_document_updated"
The content of a document in a Claude project was replaced in place.
"claude_project_document_uploaded"
A document was uploaded to a Claude project.
"claude_project_document_viewed"
A document in a Claude project was viewed.
"claude_project_file_access_failed"
An attempt to access a file in a Claude project failed.
"claude_project_file_bulk_deletion_audit_truncated"
A bulk request to delete files from a Claude project failed with more files requested than were individually recorded in the audit log.
"claude_project_file_deleted"
A file was deleted from a Claude project.
"claude_project_file_deletion_failed"
A request to delete a file from a Claude project failed.
"claude_project_file_uploaded"
A file was uploaded to a Claude project.
"claude_project_reported"
A Claude project was reported.
"claude_project_sharing_updated"
A Claude project's sharing settings were updated.
"claude_project_sync_source_created"
A sync source was connected to a Claude project's knowledge base.
"claude_project_sync_source_deleted"
A sync source was disconnected from a Claude project's knowledge base.
"claude_project_sync_source_updated"
A Claude project sync source's configuration was updated.
"claude_project_viewed"
A Claude project was viewed.
"claude_published_artifact_deleted"
A published artifact was deleted or unpublished — by its creator, by an organization admin, or by Anthropic (for example, when it was removed for a policy violation).
"claude_pubsec_identity_configured"
SAML IdP configuration updated for a public sector organization.
"claude_skill_created"
Skill was created.
"claude_skill_deleted"
Skill was deleted.
"claude_skill_disabled"
User disabled a skill for their account.
"claude_skill_downloaded"
A member explicitly downloaded a skill's files to their device: the Download action in Claude, a single file saved from the skill viewer, or an install they asked one of their Claude apps for. Background syncs to the Claude apps, viewing a skill in the app and services reading a skill on the member's behalf are not recorded.
"claude_skill_enabled"
User enabled a skill for their account.
"claude_skill_replaced"
Skill was replaced.
"claude_skill_security_scan_completed"
A security scan of a skill completed and produced a verdict.
"claude_survey_closed"
An organization admin closed an in-app survey before its end date, ending the collection of responses; a survey that reaches its end date records no event.
"claude_survey_created"
An organization admin launched an in-app survey to its chosen audience, opening it immediately or at a scheduled start time.
"claude_survey_deleted"
An organization admin permanently deleted a closed in-app survey together with every response collected for it.
"claude_survey_response_submitted"
A member submitted their response to an in-app survey run by their organization; the record omits the response content, and a retried submission can produce more than one record for the same response.
"claude_survey_responses_exported"
An organization admin downloaded a survey's responses as a CSV file, one row per response with the member's email address (blank if it is no longer available, for example because they left the organization), the groups, department and cost center they were invited through, the product they answered in, the submission time, and their answers.
"claude_user_role_updated"
A user's role within the organization was changed, or the user was added to or removed from the organization.
"claude_user_seat_tier_updated"
An organization member's seat tier was changed. A null `previous_seat_tier` means the member previously had no seat assigned; a null `current_seat_tier` means the seat was removed.
"claude_user_settings_updated"
User updated their personal settings.
"cli_plugin_exec_policy_updated"
Admin set or cleared the per-op permission ceiling for a plugin CLI.
"compliance_api_accessed"
Logging event auto-generated for each compliance API request.
"cowork_session_updated"
A Cowork session was updated.
"design_project_artifact_published"
A Claude Design project's content was published as a claude.ai artifact, making a snapshot of one of its files viewable outside the project's sharing settings.
"design_project_created"
A Claude Design project was created.
"design_project_deleted"
A Claude Design project was deleted.
"design_project_member_added"
A member was granted access to a Claude Design project.
"design_project_member_removed"
A member's access to a Claude Design project was revoked.
"design_project_member_role_updated"
A Claude Design project member's role was changed.
"design_project_published"
A Claude Design template or design system was published, making it discoverable by everyone in its organization.
"design_project_sharing_updated"
A Claude Design project's link-sharing settings were changed — who the project's link works for, and what people opening it through the link may do. Access granted to individual members is reported separately (see design_project_member_added).
"design_project_unpublished"
A Claude Design template or design system was unpublished, removing it from its organization's shared gallery.
"design_project_updated"
A Claude Design project's metadata was updated.
"design_project_version_restored"
A Claude Design project's working tree was rolled back to a previously saved version, replacing its current files with that version's files.
"design_project_viewed"
A Claude Design project's content was read. The surface field records which kind of read — a project open, a full-content read, a single-file read, a saved-version read, or an export request. The actor is the reader.
This activity type is retired: project content reads are no longer recorded. Events of this type may still appear in feeds for reads that occurred while it was active.
"desktop_extension_allowlisted"
A desktop extension was added to an org's allowlist.
"desktop_extension_blocklisted"
A desktop extension was added to the global blocklist.
"desktop_extension_deleted"
A desktop extension was deleted, either globally by an admin or org-scoped by an org owner.
"desktop_extension_removed_from_allowlist"
A desktop extension was removed from an org's allowlist.
"desktop_extension_unblocked"
A desktop extension was removed from the global blocklist.
"desktop_extension_uploaded"
A desktop extension was uploaded, either globally by an admin or org-scoped by an org owner.
"desktop_extension_version_uploaded"
A new version of an existing org-owned desktop extension was uploaded.
"domain_claim_initiated"
Domain capture claim initiated over personal accounts on verified domains.
"end_user_invite_requested"
Non-admin member submitted an invite request for a new org member.
"extra_usage_billing_enabled"
Usage credit billing was enabled for an organization.
"extra_usage_credit_granted"
A promotional usage credit grant was claimed.
"extra_usage_spend_limit_created"
Usage credit spend limit was created.
"extra_usage_spend_limit_deleted"
Usage credit spend limit was deleted.
"extra_usage_spend_limit_increase_request_approved"
A usage credit spend limit increase request was approved.
"extra_usage_spend_limit_increase_request_denied"
A usage credit spend limit increase request was denied.
"extra_usage_spend_limit_updated"
Usage credit spend limit was updated.
"ghe_configuration_created"
Admin created a GHE configuration.
"ghe_configuration_deleted"
Admin deleted a GHE configuration.
"ghe_configuration_updated"
Admin updated a GHE configuration. Previous/new field pairs are recorded only for settings that changed in the update; secret credentials are never recorded, only whether they were replaced.
"ghe_user_connected"
User connected to a GHE instance.
"ghe_user_disconnected"
User disconnected from a GHE instance.
"ghe_webhook_signature_invalid"
Webhook signature validation failed.
"github_app_installation_linked"
An installation of the Claude GitHub App (a GitHub organization or user account where the App is installed) was linked to the organization, letting the organization's Claude Code features act on that GitHub account's repositories.
"github_app_installation_unlinked"
An installation of the Claude GitHub App was unlinked from the organization, so the organization's Claude Code features can no longer act on that GitHub account's repositories through it.
"github_token_import"
A user attempted to import a personal GitHub access token for use with Claude Code. The `result` field indicates the outcome of the import (imported, rejected, or failed).
"gitlab_configuration_created"
An organization admin created a self-managed GitLab configuration for syncing plugin marketplaces.
"gitlab_configuration_deleted"
An organization admin deleted a self-managed GitLab configuration.
"gitlab_configuration_updated"
An organization admin updated a self-managed GitLab configuration. Previous/new field pairs are recorded only for settings that changed in the update; secret credentials are never recorded, only whether they were replaced.
"group_created"
A group was created (RBAC admin or SCIM provisioning).
"group_deleted"
A group was deleted (RBAC admin or SCIM provisioning).
"group_list_viewed"
Admin viewed the list of RBAC groups.
"group_member_added"
One or more members were added to a group.
"group_member_addition_failed"
A request to add members to a group failed. Some of the requested members may have been added before the failure.
"group_member_list_viewed"
Admin viewed the members of an RBAC group.
"group_member_removal_failed"
A request to remove members from a group failed. Some of the requested members may have been removed before the failure.
"group_member_removed"
One or more members were removed from a group.
"group_project_shares_revoked"
An RBAC group's project shares in one organization were revoked in bulk.
"group_skill_shares_revoked"
An RBAC group's skill shares in one organization were revoked in bulk.
"group_updated"
A group was updated (RBAC admin or SCIM provisioning).
"group_viewed"
A group was viewed.
"group_visibility_updated"
An RBAC group's visibility policy was updated.
"inference_hooks_circuit_breaker_tripped"
The organization's Inference hooks circuit breaker tripped automatically: calls to the organization's Inference hooks endpoint crossed a failure threshold, and inspection was suspended to protect live traffic. While tripped, requests are handled according to the organization's failure handling setting — allowed through uninspected (fail open) or rejected (fail closed) — and no per-request Inference hooks activities are recorded. Inspection turns back on by itself once the organization's Inference hooks endpoint returns a valid allow or deny answer to Anthropic's test request again, at least 10 minutes after the trip. An administrator can also end the tripped state by re-enabling Inference hooks inspection. If an administrator saves the Inference hooks settings after the trip (even without changing anything) or generates a new signing secret, inspection no longer turns back on by itself and stays off until an administrator re-enables it.
"inference_hooks_config_deleted"
Inference hooks configuration was removed for the organization.
"inference_hooks_config_updated"
Inference hooks configuration was created or updated for the organization.
"inference_hooks_request_denied"
Inference hooks inspection denied a request. The request was blocked.
"inference_hooks_request_failed_open"
A request proceeded without Inference hooks inspection because a verdict could not be obtained and the organization's Inference hooks configuration is set to fail open.
"inference_hooks_signing_secret_generated"
A request signing secret was generated for the organization's Inference hooks configuration.
"integration_user_connected"
User connected to an integration.
"integration_user_disconnected"
User disconnected from an integration.
"invoice_collection_method_updated"
Invoice collection method was changed.
"lti_launch_initiated"
LTI launch was initiated.
"lti_launch_success"
LTI launch completed successfully.
"lti_platform_created"
Anthropic staff created an LTI platform integration on behalf of an org.
"lti_platform_updated"
Anthropic staff updated an LTI platform integration on behalf of an org.
"magic_link_login_failed"
A magic link sign-in attempt failed.
"magic_link_login_initiated"
A user requested a magic link sign-in email.
"magic_link_login_succeeded"
A user successfully signed in with a magic link email.
"managed_organization_setup_completed"
Managed (AWS Marketplace) organization setup was completed.
"marketplace_created"
Admin created an organization marketplace.
"marketplace_deleted"
Admin deleted an organization marketplace.
"marketplace_updated"
Admin updated an organization marketplace.
"marketplace_webhook_deleted"
Admin removed the GitHub push webhook for a marketplace.
"marketplace_webhook_provisioned"
Admin provisioned a GitHub push webhook for a marketplace.
"mcp_directory_server_published"
The organization published its approved MCP directory listing.
"mcp_server_created"
An MCP server was added to the organization.
"mcp_server_deleted"
An MCP server was removed from the organization.
"mcp_server_managed_auth_token_exchanged"
A user attempted to obtain an access token for an MCP server via enterprise managed authorization. This event reports the outcomes of attempted token exchanges. Repeated failures with the same cause may be reported once until the cause changes, and requests refused before a token exchange is attempted are not reported, except the "connector_scope_not_granted" and "identity_assertion_refused" failures described under error_type.
"mcp_server_managed_auth_updated"
An MCP server's enterprise managed authorization settings were set, changed, or cleared, including when they were supplied while the server was being added or edited. Fields without a "previous\_" prefix describe the settings after the change and are null when the server has no managed authorization settings afterwards; "previous\_" fields describe the settings before the change and are null when the server had none before (always the case for a newly added server).
"mcp_server_updated"
An MCP server's configuration was updated.
"mcp_tool_policy_updated"
The permission restriction for an MCP tool was set or cleared.
"org_analytics_api_capability_updated"
Organization analytics_api capability was enabled or disabled.
"org_bulk_delete_initiated"
Organization bulk deletion was initiated.
"org_capability_grant_added"
A capability grant was added to a workspace or role.
"org_capability_grant_removed"
A capability grant was removed from a workspace or role.
"org_chat_cowork_unified_disabled"
The organization's setting for the unified Chat and Cowork experience was turned off.
"org_chat_cowork_unified_enabled"
The organization's setting for the unified Chat and Cowork experience was turned on.
"org_claude_code_data_sharing_disabled"
Organization Claude Code data sharing was disabled.
"org_claude_code_data_sharing_enabled"
Organization Claude Code data sharing was enabled.
"org_claude_code_desktop_disabled"
Organization Claude Code Desktop was disabled.
"org_claude_code_desktop_enabled"
Organization Claude Code Desktop was enabled.
"org_claude_code_zero_data_retention_disabled"
A primary owner disabled zero data retention for Claude Code, so Claude Code content is retained according to the organization's data retention settings.
"org_compliance_api_settings_updated"
Organization compliance API settings were updated.
"org_connector_domain_guard_updated"
Enterprise admin changed whether connectors are restricted to verified domains.
"org_cowork_act_without_asking_mode_disabled"
The "Act without asking" mode in Cowork was disabled for the organization, so members can no longer let Claude act without asking for approval.
"org_cowork_act_without_asking_mode_enabled"
The "Act without asking" mode in Cowork was enabled for the organization, allowing members to let Claude act without asking for approval.
"org_cowork_agent_disabled"
Organization Cowork Agent was disabled.
"org_cowork_agent_enabled"
Organization Cowork Agent was enabled.
"org_cowork_auto_mode_disabled"
The "Auto" permission mode in Cowork was disabled for the organization, so members can no longer let Claude approve its own actions after a safety check.
"org_cowork_auto_mode_enabled"
The "Auto" permission mode in Cowork was enabled for the organization, allowing members to let Claude approve its own actions after a safety check.
"org_cowork_browser_pane_disabled"
The in-app browser in Cowork was disabled for the organization, so Claude can no longer open or use websites in a browser pane during members' Cowork sessions.
"org_cowork_browser_pane_enabled"
The in-app browser in Cowork was enabled for the organization, letting Claude open and use websites in a browser pane during members' Cowork sessions.
"org_cowork_disabled"
Organization cowork was disabled.
"org_cowork_enabled"
Organization cowork was enabled.
"org_cowork_mcp_always_allow_disabled"
The "Always allow" option for connector tools in Cowork was disabled for the organization, so each use of a connector tool that can make changes requires approval. Read-only connector tools are not affected by this setting.
"org_cowork_mcp_always_allow_enabled"
The "Always allow" option for connector tools in Cowork was enabled for the organization, letting members approve a connector tool that can make changes once and allow its later uses automatically. Read-only connector tools are not affected by this setting.
"org_cowork_otlp_settings_updated"
The organization's Cowork OpenTelemetry monitoring export settings were updated.
"org_cowork_remote_disabled"
Running Cowork in the cloud was disabled for the organization, so members can no longer run Cowork sessions in Anthropic-hosted remote environments.
"org_cowork_remote_enabled"
Running Cowork in the cloud was enabled for the organization, allowing members to run Cowork sessions in Anthropic-hosted remote environments.
"org_creation_blocked"
Organization creation was blocked.
"org_data_export_accessed"
Organization data export file was accessed/downloaded via signed URL.
"org_data_export_completed"
Organization data export was completed.
"org_data_export_started"
Organization data export was started.
"org_data_residency_updated"
The organization's inference data residency settings were updated.
"org_deleted_via_bulk"
Organization was deleted via bulk operation.
"org_deletion_requested"
Organization deletion was requested.
"org_directory_resync_completed"
Organization directory resync completed successfully.
"org_directory_resync_failed"
Organization directory resync failed.
"org_directory_resync_started"
Organization directory resync was started asynchronously.
"org_directory_sync_activated"
Organization directory sync was activated.
"org_directory_sync_add_initiated"
Organization directory sync setup was initiated.
"org_directory_sync_deleted"
Organization directory sync was deleted.
"org_discoverability_disabled"
Admin disabled organization discoverability.
"org_discoverability_enabled"
Admin enabled organization discoverability.
"org_discoverability_settings_updated"
Admin updated organization discoverability settings.
"org_domain_add_initiated"
Organization domain verification was initiated.
"org_domain_removed"
Organization domain was removed.
"org_domain_verified"
Organization domain was verified.
"org_external_key_created"
A CMEK external key config was created.
"org_external_key_deleted"
A CMEK external key config was deleted.
"org_external_key_updated"
A CMEK external key config was updated.
"org_external_key_validated"
A CMEK external key config was validated against the customer's KMS.
"org_hipaa_artifacts_terms_accepted"
An owner of the organization accepted the terms for using artifacts with the HIPAA configuration enabled.
"org_hipaa_claude_code_cowork_restrictions_deferred"
The HIPAA configuration for Claude Code (local mode) and Cowork (local mode) was left off for the organization when the configuration launched, and stays off until it is applied.
"org_hipaa_claude_code_cowork_restrictions_enabled"
The HIPAA configuration was applied to Claude Code (local mode) and Cowork (local mode) for the organization.
"org_hipaa_self_serve_enabled"
A primary owner accepted the Business Associate Agreement and enabled the HIPAA configuration for the organization through the self-serve flow.
"org_invite_link_disabled"
Organization invite link was disabled.
"org_invite_link_generated"
Organization invite link was generated.
"org_invite_link_regenerated"
Organization invite link was regenerated (previous link invalidated).
"org_invite_viewed"
An organization invite was viewed.
"org_invites_listed"
Organization invites were listed.
"org_ip_restriction_created"
Organization IP restriction was created.
"org_ip_restriction_deleted"
Organization IP restriction was deleted.
"org_ip_restriction_updated"
Organization IP restriction was updated.
"org_join_proposal_decided"
Approve or reject decision on a parent-org join proposal.
"org_join_request_approved"
Admin approved a join request.
"org_join_request_created"
User requested to join an organization.
"org_join_request_dismissed"
Admin dismissed a join request.
"org_join_request_instant_approved"
Join request was instantly approved.
"org_join_requests_bulk_dismissed"
Admin bulk-dismissed join requests.
"org_library_submission_created"
A member submitted one of their own skills or plugins for publication into the organization library.
"org_library_submission_resolved"
A member's submission of a skill or plugin to the organization library was accepted or denied, or an accepted one finished publishing.
"org_library_submission_withdrawn"
A pending submission to the organization library was withdrawn before any reviewer decided on it.
"org_magic_link_second_factor_toggled"
Organization magic link second factor was toggled.
"org_member_avatar_removed"
An administrator removed another member's profile picture.
"org_member_invites_disabled"
Admin disabled member invites for the organization.
"org_member_invites_enabled"
Admin enabled member invites for the organization.
"org_members_exported"
Organization members list was exported as CSV.
"org_model_default_updated"
An organization or role default model setting was changed by an administrator.
"org_parent_join_proposal_created"
Organization parent join proposal was created.
"org_parent_search_performed"
Organization parent search was performed.
"org_sso_add_initiated"
Organization SSO setup was initiated.
"org_sso_connection_activated"
Organization SSO connection was activated.
"org_sso_connection_deactivated"
Organization SSO connection was deactivated.
"org_sso_connection_deleted"
Organization SSO connection was deleted.
"org_sso_group_role_mappings_updated"
Organization SSO group role mappings were updated.
"org_sso_provisioning_mode_changed"
Organization SSO provisioning mode was changed.
"org_sso_scim_welcome_email_toggled"
Organization SCIM-provisioned welcome email was toggled.
"org_sso_seat_tier_assignment_toggled"
Organization SSO seat tier assignment was toggled.
"org_sso_seat_tier_mappings_updated"
Organization SSO seat tier mappings were updated.
"org_sso_toggled"
Organization SSO was toggled on or off.
"org_sync_deleting_synchronized_files_started"
Organization started deleting synchronized files.
"org_sync_synchronized_files_deleted"
Organization synchronized files were deleted.
"org_taint_added"
A compliance marker (taint) was added to an organization, for example the marker that records its HIPAA configuration.
"org_taint_removed"
A compliance marker (taint) was removed from an organization.
"org_user_deleted"
User was removed from organization.
"org_user_invite_accepted"
Organization user invite was accepted.
"org_user_invite_deleted"
Organization user invite was deleted.
"org_user_invite_re_sent"
Organization user invite was re-sent.
"org_user_invite_rejected"
Organization user invite was rejected.
"org_user_invite_sent"
Organization user invite was sent.
"org_user_left"
User removed themselves from organization.
"org_user_shares_retained"
A member left or was removed from the organization while projects, skills, plugins, or chats they had shared were still shared, and those shares were kept.
"org_user_trusted_devices_revoked"
An organization admin revoked a member's trusted devices and signed the member out of all active sessions.
"org_user_viewed"
An organization user was viewed.
"org_users_listed"
Organization users were listed.
"org_work_across_apps_disabled"
The organization's "Let Claude work across apps" setting was turned off.
"org_work_across_apps_enabled"
The organization's "Let Claude work across apps" setting was turned on.
"organization_address_updated"
The organization's billing or shipping address was updated.
"organization_icon_deleted"
Organization's custom icon deleted.
"organization_icon_updated"
Organization's custom icon uploaded or replaced.
"owned_projects_access_restored"
Access to owned projects was restored.
"payment_method_updated"
The organization's default payment method was updated.
"pending_share_created"
A pending share of a project or skill was created for an email address that is not yet an organization member.
"pending_share_revoked"
A pending share of a project or skill was revoked before the invitee joined the organization.
"phone_code_sent"
User requested a phone verification code.
"phone_code_verified"
User successfully verified their phone code.
"platform_agent_archived"
An agent was archived on the API platform.
"platform_agent_created"
An agent was created on the API platform.
"platform_agent_deleted"
An agent was deleted from the API platform.
"platform_agent_deployment_archived"
An agent deployment was archived on the API platform.
"platform_agent_deployment_created"
An agent deployment was created on the API platform.
"platform_agent_deployment_deleted"
An agent deployment was deleted from the API platform.
"platform_agent_deployment_paused"
An agent deployment was paused on the API platform.
"platform_agent_deployment_run_triggered"
An agent deployment was run on demand on the API platform.
"platform_agent_deployment_unpaused"
An agent deployment was resumed on the API platform.
"platform_agent_deployment_updated"
An agent deployment was updated on the API platform.
"platform_agent_session_archived"
An agent session was archived on the API platform.
"platform_agent_session_created"
An agent session was created on the API platform.
"platform_agent_session_deleted"
An agent session was deleted from the API platform.
"platform_agent_session_resource_added"
A resource was attached to an agent session.
"platform_agent_session_resource_deleted"
A resource attached to an agent session was removed.
"platform_agent_session_resource_updated"
A resource attached to an agent session was updated.
"platform_agent_session_thread_archived"
A thread within an agent session was archived.
"platform_agent_session_updated"
An agent session was updated on the API platform.
"platform_agent_updated"
An agent was updated on the API platform.
"platform_api_key_created"
An API key was created.
"platform_api_key_updated"
An API key was updated.
"platform_app_attest_authentication"
An attested mobile device attempted to exchange an Apple App Attest assertion for Anthropic API credentials.
"platform_billing_upgraded_to_prepaid"
The organization's API billing was upgraded to the prepaid plan.
"platform_clearance_workspace_program_request_cleared"
A workspace's clearance program assignment was removed.
"platform_clearance_workspace_program_request_set"
A workspace's clearance program assignment was created or updated.
"platform_cost_report_viewed"
The cost report was viewed.
"platform_dream_archived"
A Dream (asynchronous memory-consolidation job) was archived.
"platform_dream_cancelled"
A Dream (asynchronous memory-consolidation job) was cancelled before it completed.
"platform_dream_created"
A Dream (asynchronous memory-consolidation job) was created.
"platform_federated_authentication"
A federated workload identity attempted to exchange an OIDC token for Anthropic API credentials.
"platform_federation_issuer_archived"
An OIDC federation issuer was archived.
"platform_federation_issuer_created"
An OIDC federation issuer was created, registering an external identity provider that federation rules can trust for workload authentication.
"platform_federation_issuer_updated"
An OIDC federation issuer was updated.
"platform_federation_rule_archived"
An OIDC federation rule was archived.
"platform_federation_rule_created"
An OIDC federation rule was created, allowing tokens from a federation issuer to authenticate as a service account or user. Rules may additionally match on token claims or a condition expression, which are not included in this event.
"platform_federation_rule_updated"
An OIDC federation rule was updated.
"platform_federation_rule_workspace_added"
A federation rule was enabled for a workspace.
"platform_federation_rule_workspace_removed"
A federation rule was disabled for a workspace.
"platform_file_content_downloaded"
Activity logged when file content is downloaded via GET /v1/files/{file_id}/content.
"platform_file_deleted"
Activity logged when a file is deleted via DELETE /v1/files/{file_id}.
"platform_file_uploaded"
Activity logged when a file is uploaded via POST /v1/files.
"platform_memory_created"
An agent memory document was created.
"platform_memory_deleted"
An agent memory document was deleted.
"platform_memory_store_archived"
An agent memory store was archived. Archived stores reject new memory writes and cannot be attached to new sessions; deletion and redaction remain permitted for privacy scrubbing.
"platform_memory_store_created"
An agent memory store was created.
"platform_memory_store_deleted"
An agent memory store was deleted. Memory content removal may complete asynchronously for very large stores.
"platform_memory_store_updated"
An agent memory store's name, description, or metadata was updated.
"platform_memory_updated"
An agent memory document's content or path was updated.
"platform_memory_version_redacted"
A historical version of an agent memory document was redacted. Redaction scrubs the stored content of a specific version while preserving the version's existence in the history.
"platform_oauth_app_created"
An OAuth app was created.
"platform_oauth_app_revoked"
An OAuth app was revoked.
"platform_oauth_app_updated"
An OAuth app was updated.
"platform_organization_created"
An owner of the organization created a Claude Console organization under the same parent organization.
"platform_plugin_directory_submission_created"
A plugin directory submission was created on the API platform. A plugin directory submission is a request to list a plugin in the public plugin directory.
"platform_plugin_directory_submission_deleted"
A plugin directory submission was deleted on the API platform.
"platform_plugin_directory_submission_updated"
A plugin directory submission was updated on the API platform.
"platform_service_account_archived"
A service account was archived.
"platform_service_account_created"
A service account was created.
"platform_service_account_updated"
A service account was updated.
"platform_service_account_workspace_member_added"
A service account was added as a member of a workspace.
"platform_service_account_workspace_member_removed"
A service account was removed from a workspace.
"platform_service_account_workspace_member_updated"
A service account's workspace membership role was updated.
"platform_signing_key_created"
Activity logged when a new request-signing key is registered for the org.
"platform_signing_key_deleted"
Activity logged when a signing key is permanently deleted.
"platform_signing_key_rotated"
Activity logged when an in-memory signing key is rotated.
"platform_skill_version_content_downloaded"
The content of a skill version was downloaded through the Skills API.
"platform_skill_version_created"
Activity logged when a skill version is created via POST /v1/skills/{skill_id}/versions.
"platform_skill_version_deleted"
Activity logged when a skill version is deleted via DELETE /v1/skills/{skill_id}/versions/{version}.
"platform_spend_limit_alert_emails_updated"
Spend limit alert email addresses and role targets were updated for an org.
"platform_spend_limit_created"
An org-level fixed-dollar spend limit was created.
"platform_spend_limit_deleted"
An org-level spend limit was removed.
"platform_spend_limit_updated"
An org-level spend limit snooze/ignore state was changed.
"platform_usage_report_claude_code_viewed"
The Claude Code usage report was viewed.
"platform_usage_report_messages_viewed"
The messages usage report was viewed.
"platform_workspace_archived"
A workspace was archived.
"platform_workspace_created"
A workspace was created.
"platform_workspace_inference_data_retention_disabled"
The zero data retention override was disabled for a workspace.
"platform_workspace_inference_data_retention_enabled"
The zero data retention override was enabled for a workspace.
"platform_workspace_member_added"
A member was added to a workspace.
"platform_workspace_member_removed"
A member was removed from a workspace.
"platform_workspace_member_updated"
A workspace member was updated.
"platform_workspace_member_viewed"
A workspace member was viewed.
"platform_workspace_members_listed"
Workspace members were listed.
"platform_workspace_rate_limit_deleted"
A workspace rate limit was deleted.
"platform_workspace_rate_limit_updated"
A workspace rate limit was created or updated.
"platform_workspace_updated"
A workspace was updated.
"plugin_installation_preference_updated"
An org admin changed the installation preference for a plugin.
"prepaid_auto_recharge_disabled"
Auto-recharge was disabled for API prepaid org.
"prepaid_auto_recharge_updated"
Auto-recharge settings were updated for API prepaid org.
"prepaid_extra_usage_auto_reload_disabled"
Prepaid usage credit auto-reload was disabled.
"prepaid_extra_usage_auto_reload_enabled"
Prepaid usage credit auto-reload was enabled.
"prepaid_extra_usage_auto_reload_settings_updated"
Prepaid usage credit auto-reload settings were updated.
"primary_owner_transferred"
Primary owner role was transferred to another org member.
"rbac_role_assigned"
Admin assigned an RBAC custom role to a principal.
"rbac_role_created"
Admin created an RBAC custom role.
"rbac_role_deleted"
Admin deleted an RBAC custom role.
"rbac_role_grant_updated"
Admin requested a capability grant for an RBAC custom role, or removed it.
Records the admin's change to the role. Whether the grant is currently in effect on the role is reported separately.
"rbac_role_permission_added"
Admin added a permission to an RBAC custom role.
Emitted once per requested permission, including permissions the role already had, so a retried request still produces a complete audit record.
"rbac_role_permission_removed"
Admin removed a permission from an RBAC custom role.
Emitted once per requested permission, including permissions the role already lacked, so a retried request still produces a complete audit record.
"rbac_role_unassigned"
Admin unassigned an RBAC custom role from a principal.
"rbac_role_updated"
Admin updated an RBAC custom role.
"role_assignment_granted"
Role assignment was granted.
"role_assignment_revoked"
Role assignment was revoked.
"scim_user_created"
A SCIM user was provisioned.
"scim_user_deleted"
A SCIM user was deleted.
"scim_user_updated"
A SCIM user was updated.
"scoped_api_key_deleted"
A scoped API key was deleted.
"scoped_api_key_updated"
A scoped API key was renamed or its activation state changed.
"seat_tier_changes_cancelled"
Scheduled seat tier downgrades were cancelled.
"seat_tiers_purchased"
Seat tiers were purchased or upgraded on a subscription.
"service_created"
Activity logged when an org service is explicitly created.
"service_deleted"
Activity logged when an org service is deleted.
"service_key_created"
Activity logged when a new org service key is created.
"service_key_revoked"
Activity logged when an org service key is revoked.
"session_revoked"
User revoked a specific session.
"session_share_accessed"
Session share was accessed.
"session_share_created"
Session share was created.
"session_share_revoked"
Session share was revoked.
"slack_workspace_claim_revoked"
A Slack workspace or Enterprise Grid organization was disconnected from the organization for Claude in Slack.
"slack_workspace_claimed"
A Slack workspace or Enterprise Grid organization was connected to the organization for Claude in Slack.
"social_login_succeeded"
A user successfully signed in with a social identity provider (Google, Apple, or Microsoft).
"sso_login_failed"
An SSO sign-in attempt failed.
"sso_login_initiated"
A user started an SSO sign-in flow.
"sso_login_succeeded"
A user successfully signed in with SSO.
"sso_second_factor_magic_link"
SSO second factor magic link was used.
"step_up_authentication_failed"
An additional identity check failed.
"step_up_authentication_succeeded"
The user completed an additional identity check to confirm a sensitive action.
"step_up_credential_enrolled"
A user enrolled a passkey for confirming sensitive actions on their account.
"subscription_cancellation_scheduled"
Subscription cancellation was scheduled at end of billing period.
"subscription_quantity_updated"
Contracted subscription seat quantity was updated.
"subscription_renewed"
A cancelled subscription was renewed.
"subscription_resumed"
A scheduled subscription cancellation was reversed.
"subscription_started"
A new subscription was created (Team or Enterprise).
"subscription_upgraded"
Subscription plan was upgraded (e.g. Team to Enterprise).
"trusted_device_credential_rotated"
The identity-verification credential of a trusted device was rotated to a new key.
"trusted_device_enrolled"
A device was enrolled as a trusted device for the user's account. Trusted devices can be used to confirm the user's identity for sensitive actions.
"trusted_device_revoked"
A trusted device was removed from the user's account.
"tunnel_archived"
An MCP tunnel was archived.
"tunnel_certificate_added"
An inner-TLS CA certificate was added to a tunnel.
"tunnel_certificate_revoked"
An inner-TLS CA certificate was revoked from a tunnel.
"tunnel_created"
An MCP tunnel was created.
"tunnel_token_minted"
An OAuth bearer token for the tunnel management API was minted.
"tunnel_token_revealed"
The Cloudflare connector secret for a tunnel was revealed to the caller.
"tunnel_token_revoked"
An OAuth bearer token for the tunnel management API was revoked.
"tunnel_token_rotated"
The Cloudflare connector secret for a tunnel was rotated.
`tunnel_token_id` is the id of the *newly-issued* token. The previous token is invalidated by the rotation and its id is not recorded here.
"user_consent_recorded"
User granted a consent for a specific entity (e.g. consumer health consent for an MCP server).
"user_consent_revoked"
User revoked a previously granted consent for a specific entity.
"user_logged_out"
A user signed out of one or all sessions.
"verification_evidence_submitted"
Verification evidence was submitted for an organization's verification.
"verification_program_application_created"
An organization applied to a verification program.
"workspace_member_spend_limit_created"
A per-member or workspace-default Claude Code spend limit was created.
"workspace_member_spend_limit_deleted"
A per-member or workspace-default Claude Code spend limit was deleted.
"workspace_member_spend_limit_updated"
A per-member Claude Code spend limit amount was updated.
"workspace_spend_limit_alert_emails_updated"
Spend limit alert email recipients were updated for a workspace.
"workspace_spend_limit_created"
A workspace-level API spend limit was created.
"workspace_spend_limit_deleted"
A workspace-level API spend limit was deleted.
limit: optional number
Maximum results (default: 100, max: 5000)
default100
minimum1
maximum5000
order: optional "asc" or "desc"
Sort direction by `created_at`. `desc` (default) returns newest-first; `asc` returns oldest-first for incremental sync. Activities become queryable after a short asynchronous ingestion delay. When using `asc` with `after_id` for incremental sync, late-arriving rows with timestamps behind the cursor will be skipped; consumers that need at-least-once delivery should periodically re-poll an overlap window via `created_at.gte` and deduplicate by `id`. `after_id` and `before_id` are relative to this order.
defaultdesc
One of the following:
"asc"
"desc"
organization_ids: optional array of string
Filter activities by organization IDs (accepts `org_...` or organization UUID). Enumerate IDs via `GET /v1/compliance/organizations`.
user_ids: optional array of string
Alias for `actor_ids[]`, for consistency with other compliance routes. If both are provided, the lists are merged.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"x-api-key": optional string
##### Returns
data: optional array of AbuseDecisionReceived or AccountDeleted or AdminAPIKeyCreated or 533 more
List of activity records. Each element's `type` field identifies which activity it is and which additional fields are present.
One of the following:
AbuseDecisionReceived object{ type: "abuse_decision_received", actor, decision, 5 more }
An external anti-abuse service reported a consequential decision about a sign-in or sign-up attempt.
AccountDeleted object{ type: "account_deleted", actor, id, 3 more }
User-initiated self-service account deletion.
AdminAPIKeyCreated object{ type: "admin_api_key_created", actor, admin_api_key_id, 5 more }
An admin API key was created.
AdminAPIKeyDeleted object{ type: "admin_api_key_deleted", actor, admin_api_key_id, 4 more }
An admin API key was deleted.
AdminAPIKeyUpdated object{ type: "admin_api_key_updated", actor, admin_api_key_id, 5 more }
An admin API key was updated (renamed or activated/deactivated).
AdminConnectorRequestResolved object{ type: "admin_connector_request_resolved", actor, decision, 6 more }
Admin approved or dismissed pending member requests to enable an MCP connector.
AdminRequestCreated object{ type: "admin_request_created", actor, request_type, 4 more }
Admin request created by an org member (seat upgrade, limit increase, join org, end-user invite).
AdminSetupChecklistStepDelegated object{ type: "admin_setup_checklist_step_delegated", actor, step, 6 more }
A step of the Claude Enterprise admin setup checklist was delegated to a teammate — an organization member, or an email address that has not joined the organization yet — replacing any earlier delegation of that step.
AdminSetupChecklistStepDelegationCancelled object{ type: "admin_setup_checklist_step_delegation_cancelled", actor, step, 4 more }
The delegation of a Claude Enterprise admin setup checklist step was cancelled.
AgeVerified object{ type: "age_verified", actor, id, 3 more }
User age was verified.
AnonymousMobileLoginAttempted object{ type: "anonymous_mobile_login_attempted", actor, id, 3 more }
Anonymous mobile login was attempted.
APIKeyCreated object{ type: "api_key_created", actor, api_key_id, 6 more }
Activity logged when a new API key is created.
ClaudeArtifactAccessFailed object{ type: "claude_artifact_access_failed", actor, id, 6 more }
An attempt to access an artifact failed.
ClaudeArtifactCommented object{ type: "claude_artifact_commented", actor, claude_artifact_id, 9 more }
Comment activity on a published artifact: a comment was added, a thread's resolved state was changed, or a thread was deleted. The actor is the user who performed the action; the comment text itself is stored with the artifact and is not part of this record.
ClaudeArtifactCommentsViewed object{ type: "claude_artifact_comments_viewed", actor, claude_artifact_id, 5 more }
An artifact's comments were viewed.
ClaudeArtifactCreated object{ type: "claude_artifact_created", actor, claude_artifact_id, 4 more }
An artifact was created.
ClaudePublishedArtifactDeleted object{ type: "claude_published_artifact_deleted", actor, claude_published_artifact_id, 4 more }
A published artifact was deleted or unpublished — by its creator, by an organization admin, or by Anthropic (for example, when it was removed for a policy violation).
ClaudeArtifactPublished object{ type: "claude_artifact_published", actor, artifact_type, 10 more }
A new version of an artifact was published — for an artifact created in a chat this is the action that made it publicly viewable; for an artifact created outside a chat it is recorded when the artifact is saved, including saves of private artifacts, except that automatic saves made while a person keeps editing may be recorded periodically for that person rather than once per save; changes to who can access the artifact are recorded separately as claude_artifact_sharing_updated.
ClaudeArtifactSharingUpdated object{ type: "claude_artifact_sharing_updated", actor, audience, 22 more }
An artifact's sharing settings were updated.
ClaudeArtifactViewed object{ type: "claude_artifact_viewed", actor, claude_artifact_id, 5 more }
An artifact was viewed.
AuditLogExportAccessed object{ type: "audit_log_export_accessed", actor, id, 3 more }
Audit log export file was accessed/downloaded via signed URL.
AuditLogExportStarted object{ type: "audit_log_export_started", actor, id, 5 more }
Audit log export was initiated.
BillingEmailsUpdated object{ type: "billing_emails_updated", actor, id, 6 more }
The organization's billing email recipients were updated.
CcrAgentCreated object{ type: "ccr_agent_created", actor, agent_id, 11 more }
A Claude Code agent was created.
CcrAgentDeleted object{ type: "ccr_agent_deleted", actor, agent_id, 7 more }
A Claude Code agent was deleted.
CcrAgentProxyAnthropicOidcTokenExchanged object{ type: "ccr_agent_proxy_anthropic_oidc_token_exchanged", actor, agent_id, 13 more }
The Claude Code agent proxy exchanged a minted identity token for short-lived credentials in the organization's own cloud. Recorded for exchange targets only (such as "aws" and "gcp"; the "direct" target has no exchange step). One event is recorded per exchange call; a request served from the proxy's exchanged-credential cache does not exchange again and is not recorded here. Per-request detail for traffic the credentials were injected into is available in the agent proxy network events.
CcrAgentProxyAnthropicOidcTokenMinted object{ type: "ccr_agent_proxy_anthropic_oidc_token_minted", actor, agent_id, 16 more }
The Claude Code agent proxy minted a short-lived identity token for an anthropic_oidc credential. One event is recorded per fresh token issuance; a request served from the proxy's short-lived token cache does not mint a new token and is not recorded here. Per-request detail for traffic the credential was injected into is available in the agent proxy network events.
CcrAgentProxyCredentialCreated object{ type: "ccr_agent_proxy_credential_created", actor, credential_id, 10 more }
A Claude Code agent proxy credential was created. Credentials hold the secrets the agent proxy injects into requests Claude Code sessions send to approved external services; each credential belongs to an agent proxy profile. Audit events carry only credential names and settings, never the secret material itself.
CcrAgentProxyCredentialDeleted object{ type: "ccr_agent_proxy_credential_deleted", actor, credential_id, 6 more }
A Claude Code agent proxy credential was deleted. Its secret material was removed and can no longer be sent to any host.
CcrAgentProxyCredentialRotated object{ type: "ccr_agent_proxy_credential_rotated", actor, credential_id, 11 more }
A Claude Code agent proxy credential's secret material was replaced. The replacement keeps the same name, profile, and allowed hosts under a new credential identifier, and everything that referenced the old credential now uses the replacement.
CcrAgentProxyCredentialUpdated object{ type: "ccr_agent_proxy_credential_updated", actor, credential_id, 10 more }
A Claude Code agent proxy credential's settings were updated. Only the display name and the allowed host patterns can be updated; the secret material can only be replaced through a rotation.
CcrAgentProxyDestinationDeleted object{ type: "ccr_agent_proxy_destination_deleted", actor, deleted_with_profile, 7 more }
An agent proxy destination was deleted.
CcrAgentProxyNetworkEventsListed object{ type: "ccr_agent_proxy_network_events_listed", actor, failed, 5 more }
A Claude Code network activity export was accessed for the given hour.
CcrAgentProxyProfileBound object{ type: "ccr_agent_proxy_profile_bound", actor, profile_id, 6 more }
A Claude Code agent proxy profile was bound to a scope, applying its policy to Claude Code sessions in that scope.
CcrAgentProxyProfileCreated object{ type: "ccr_agent_proxy_profile_created", actor, display_name, 7 more }
A Claude Code agent proxy profile was created. Agent proxy profiles are named, reusable bundles of access policy that administrators bind to parts of the organization.
CcrAgentProxyProfileDeleted object{ type: "ccr_agent_proxy_profile_deleted", actor, deleted_credential_count, 10 more }
A Claude Code agent proxy profile was deleted, removing its policy from everything it was bound to.
CcrAgentProxyProfileUnbound object{ type: "ccr_agent_proxy_profile_unbound", actor, profile_id, 6 more }
A Claude Code agent proxy profile was unbound from a scope, removing its policy from Claude Code sessions in that scope.
CcrAgentProxyProfileUpdated object{ type: "ccr_agent_proxy_profile_updated", actor, profile_id, 6 more }
A Claude Code agent proxy profile's configuration was updated.
CcrAgentProxyProvisioningCredentialRejected object{ type: "ccr_agent_proxy_provisioning_credential_rejected", actor, credential_id, 8 more }
An organization owner rejected a credential that a teammate submitted via an agent proxy provisioning link: the credential and its disabled rule were deleted and the link was revoked. The actor is the owner; the submitter is recorded for attribution.
CcrAgentProxyProvisioningLinkEnabled object{ type: "ccr_agent_proxy_provisioning_link_enabled", actor, credential_id, 7 more }
An organization owner enabled a credential that a teammate submitted via an agent proxy provisioning link: the disabled rule created at submission was switched to enforce, so the credential now takes traffic. The actor is the owner; the submitter is the actor on the prior ccr_agent_proxy_provisioning_link_submitted event.
CcrAgentProxyProvisioningLinkGenerated object{ type: "ccr_agent_proxy_provisioning_link_generated", actor, link_id, 5 more }
An organization owner generated a one-time agent proxy credential provisioning link so a teammate can submit a credential into the target agent proxy profile without holding the owner role.
CcrAgentProxyProvisioningLinkRevoked object{ type: "ccr_agent_proxy_provisioning_link_revoked", actor, link_id, 5 more }
An organization owner revoked an unfilled agent proxy provisioning link.
CcrAgentProxyProvisioningLinkSubmitted object{ type: "ccr_agent_proxy_provisioning_link_submitted", actor, credential_id, 8 more }
A teammate submitted a credential via an agent proxy provisioning link. The credential and a disabled rule are created; the credential takes traffic only after an organization owner enables the submitted credential. This event records the link-mediated lifecycle; the credential itself additionally emits ccr_agent_proxy_credential_created.
CcrAgentProxyRuleCreated object{ type: "ccr_agent_proxy_rule_created", action, actor, 20 more }
An agent proxy rule was created. A rule decides what happens to a session's outbound requests that match it.
CcrAgentProxyRuleDeleted object{ type: "ccr_agent_proxy_rule_deleted", actor, deleted_with_profile, 7 more }
An agent proxy rule was deleted.
CcrAgentProxyRuleUpdated object{ type: "ccr_agent_proxy_rule_updated", action, actor, 21 more }
An agent proxy rule was updated. An update replaces everything the rule matches and does, so the host name patterns here are the rule's complete set after the update.
CcrAgentSlackAccessScopeCreated object{ type: "ccr_agent_slack_access_scope_created", actor, agent_id, 7 more }
A Claude Code agent was granted access to read or write in an additional Slack channel beyond the one it is assigned to.
CcrAgentSlackAccessScopeDeleted object{ type: "ccr_agent_slack_access_scope_deleted", actor, agent_id, 6 more }
A Claude Code agent's access to an additional Slack channel was revoked.
CcrAgentSlackBindingCreated object{ type: "ccr_agent_slack_binding_created", actor, agent_id, 6 more }
A Claude Code agent was assigned to a Slack channel or workspace as its dedicated agent.
CcrAgentSlackBindingDeleted object{ type: "ccr_agent_slack_binding_deleted", actor, agent_id, 6 more }
A Claude Code agent's assignment to a Slack channel or workspace was removed.
CcrAgentUpdated object{ type: "ccr_agent_updated", actor, agent_id, 10 more }
A Claude Code agent's configuration was updated. Also emitted with updated_fields \["is_virtual"\] alone when an auto-provisioned agent is promoted to a configured one, whether by an update request targeting it or by binding an agent proxy profile to it.
CcrChannelManagerAdded object{ type: "ccr_channel_manager_added", actor, agent_id, 7 more }
An org owner/admin assigned an organization member to manage the Claude-in-Slack configuration of one Slack channel.
CcrChannelManagerRemoved object{ type: "ccr_channel_manager_removed", actor, agent_id, 7 more }
An org owner/admin removed an organization member's assignment to manage the Claude-in-Slack configuration of one Slack channel.
CcrRoleChannelAssignmentDeleted object{ type: "ccr_role_channel_assignment_deleted", actor, previous_channel_count, 5 more }
CcrRoleChannelAssignmentDeleted is emitted when an org owner/admin removes an RBAC role's channel assignment row (the role reverts to granting zero channels).
CcrRoleChannelAssignmentUpdated object{ type: "ccr_role_channel_assignment_updated", actor, channel_count, 7 more }
CcrRoleChannelAssignmentUpdated is emitted when an org owner/admin sets or replaces the list of Slack channels an RBAC role's holders may configure via the delegated Claude-in-Slack channel-manage surface.
CcrSessionCreated object{ type: "ccr_session_created", actor, session_id, 5 more }
A Claude Code session was created. A session is one coding interaction with Claude.
CcrSessionDeleted object{ type: "ccr_session_deleted", actor, session_id, 4 more }
A Claude Code session was deleted.
CcrSessionUpdated object{ type: "ccr_session_updated", actor, session_id, 5 more }
A Claude Code session's settings were updated.
CcrSlackChannelJoined object{ type: "ccr_slack_channel_joined", actor, slack_channel_id, 5 more }
Claude's Slack app joined a public Slack channel at an organization administrator's request.
ClaudeChatSettingsUpdated object{ type: "claude_chat_settings_updated", actor, claude_chat_id, 5 more }
User updated the settings for a conversation.
ClaudeChatSnapshotCreated object{ type: "claude_chat_snapshot_created", actor, claude_chat_id, 5 more }
User created/shared a chat snapshot.
ClaudeChatSnapshotDeleted object{ type: "claude_chat_snapshot_deleted", actor, claude_chat_snapshot_id, 5 more }
User deleted/unshared a chat snapshot.
ClaudeChatSnapshotViewed object{ type: "claude_chat_snapshot_viewed", actor, claude_chat_snapshot_id, 5 more }
User viewed a chat snapshot (authenticated or public/unauthenticated).
ClaudeArtifactDuplicated object{ type: "claude_artifact_duplicated", actor, claude_artifact_id, 6 more }
A user duplicated an artifact they could view into a new artifact that they own. The actor is the user who created the copy; the source artifact is not modified.
ClaudeArtifactExternalSharingPermissionUpdated object{ type: "claude_artifact_external_sharing_permission_updated", action, actor, 5 more }
An organization admin allowed one artifact to be shared outside the organization by link while the organization-wide external sharing setting was off, or revoked that permission.
ClaudeArtifactInviteAccepted object{ type: "claude_artifact_invite_accepted", actor, claude_artifact_id, 8 more }
Someone outside the organization signed in with a verified account for the invited address and accepted an invitation to an artifact, and can now open it; recorded in the artifact owner's organization. The person who accepted is identified by `invitee_email` and `invitee_user_id`.
ClaudeArtifactInviteCreated object{ type: "claude_artifact_invite_created", actor, claude_artifact_id, 7 more }
A member invited (or re-invited) an email address outside the organization to an artifact; recorded in the artifact owner's organization with the inviting member as the actor.
ClaudeArtifactInviteRevoked object{ type: "claude_artifact_invite_revoked", actor, claude_artifact_id, 8 more }
A member withdrew an invitation to an artifact for someone outside the organization, removing any access that invitation had granted; recorded in the artifact owner's organization with that member as the actor.
ClaudeArtifactInviteRoleUpdated object{ type: "claude_artifact_invite_role_updated", actor, claude_artifact_id, 9 more }
A member changed the access level of an email invitation to an artifact for someone outside the organization, whether the invitation was still pending or had been accepted; recorded in the artifact owner's organization with that member as the actor.
ClaudeArtifactSentToPartner object{ type: "claude_artifact_sent_to_partner", actor, claude_artifact_id, 9 more }
A member sent an export of an artifact to a partner application ("Send to …" on the artifact; a partner is a third-party application listed in Claude's connector directory): a file exported from the artifact was made available over a temporary link for the chosen partner to fetch. One activity is recorded per send, in the artifact owner's organization with the sending member as actor, whether or not the partner then retrieved the file; the partner's own import of the file is not part of this record. The file's name and contents are not recorded.
ClaudeArtifactTypeDefaultUpdated object{ type: "claude_artifact_type_default_updated", action, actor, 7 more }
An organization's default artifact for an artifact type (for example, its default design system) was set or cleared. Neither artifact named is itself modified.
ClaudeArtifactTypePinUpdated object{ type: "claude_artifact_type_pin_updated", action, actor, 6 more }
An artifact was pinned or unpinned for an artifact type (for example, a design system was pinned so every member sees it in their picker). Neither artifact named is itself modified, and pinning does not change who can open it.
ClaudeChatAccessFailed object{ type: "claude_chat_access_failed", actor, claude_chat_id, 4 more }
A user was denied access to a Claude.ai chat conversation.
ClaudeChatCreated object{ type: "claude_chat_created", actor, claude_chat_id, 5 more }
User created a chat.
ClaudeChatDeleted object{ type: "claude_chat_deleted", actor, claude_chat_id, 5 more }
A user deleted a Claude.ai chat conversation.
ClaudeChatDeletionFailed object{ type: "claude_chat_deletion_failed", actor, claude_chat_id, 4 more }
A request to delete a Claude.ai chat conversation failed.
ClaudeChatSyncSourceCreated object{ type: "claude_chat_sync_source_created", actor, claude_chat_sync_source_id, 6 more }
A sync source was connected for syncing external content into Claude chats.
ClaudeChatSyncSourceDeleted object{ type: "claude_chat_sync_source_deleted", actor, claude_chat_sync_source_id, 5 more }
A sync source was disconnected from Claude chats.
ClaudeChatSyncSourceUpdated object{ type: "claude_chat_sync_source_updated", actor, claude_chat_sync_source_id, 7 more }
A Claude chat sync source's configuration was updated.
ClaudeChatUpdated object{ type: "claude_chat_updated", actor, claude_chat_id, 5 more }
User updated the chat metadata (e.g name, model).
ClaudeChatViewed object{ type: "claude_chat_viewed", actor, claude_chat_id, 5 more }
A user viewed a Claude.ai chat conversation.
ClaudeCodeCredentialRevoked object{ type: "claude_code_credential_revoked", actor, credential_type, 11 more }
A Claude Code credential (runner pool key, runner token, or session token) was revoked. The credential itself is never recorded.
ClaudeCodeReviewConfigUpdated object{ type: "claude_code_review_config_updated", actor, enabled, 15 more }
Claude Code Review configuration was enabled/disabled for an org.
ClaudeCodeReviewRepositoryAdded object{ type: "claude_code_review_repository_added", actor, config_id, 7 more }
A repository was added to org-level Claude Code Review configuration.
ClaudeCodeReviewRepositoryRemoved object{ type: "claude_code_review_repository_removed", actor, config_id, 6 more }
A repository was removed from org-level Claude Code Review configuration.
ClaudeCodeReviewRepositoryUpdated object{ type: "claude_code_review_repository_updated", actor, config_id, 8 more }
A Claude Code Review repository configuration was updated.
ClaudeCodeRunnerDeleted object{ type: "claude_code_runner_deleted", actor, runner_id, 5 more }
A self-hosted runner was forcibly removed from its pool. Sessions assigned to the runner were returned to the pool queue, unless a session had already been requeued repeatedly, in which case it was marked stuck instead of being requeued again.
ClaudeCodeRunnerPoolCreated object{ type: "claude_code_runner_pool_created", actor, display_name, 5 more }
A self-hosted runner pool for Claude Code was created.
ClaudeCodeRunnerPoolDeleted object{ type: "claude_code_runner_pool_deleted", actor, runner_pool_id, 5 more }
A self-hosted runner pool was deleted.
ClaudeCodeRunnerPoolSecretMinted object{ type: "claude_code_runner_pool_secret_minted", actor, jti, 7 more }
A registration key for a self-hosted runner pool was minted. Runners present this key to join the pool. The key itself is never recorded.
ClaudeCodeRunnerPoolSessionQueueUpdated object{ type: "claude_code_runner_pool_session_queue_updated", action, actor, 7 more }
An admin changed a session's position in its self-hosted runner pool's queue: requeued it onto a different runner, dismissed it from the queue, or re-admitted it for another runner provisioning attempt.
ClaudeCodeRunnerPoolUpdated object{ type: "claude_code_runner_pool_updated", actor, display_name, 6 more }
A self-hosted runner pool's settings were updated.
ClaudeCodeSecurityCenterConfigUpdated object{ type: "claude_code_security_center_config_updated", actor, enabled, 5 more }
Claude Code Security Center scanning was enabled/disabled for an org.
ClaudeCodeSecurityScanCancelled object{ type: "claude_code_security_scan_cancelled", actor, scan_project_id, 5 more }
In-flight Claude Code Security scans were cancelled for a project.
ClaudeCodeSecurityScanCreated object{ type: "claude_code_security_scan_created", actor, scan_id, 5 more }
A Claude Code Security scan was started.
ClaudeCodeSecurityScanProjectMemberUpdated object{ type: "claude_code_security_scan_project_member_updated", action, actor, 8 more }
A person's access to a Claude Code Security scan project was granted, changed, or revoked.
ClaudeCodeSecurityScanProjectUpdated object{ type: "claude_code_security_scan_project_updated", action, actor, 6 more }
A Claude Code Security scan project was archived, unarchived, created, or migrated to a new product experience.
ClaudeCodeSecurityScanProjectVisibilityUpdated object{ type: "claude_code_security_scan_project_visibility_updated", action, actor, 7 more }
A Claude Code Security scan project was shared with the organization or made private.
ClaudeCodeSecurityScanRunUpdated object{ type: "claude_code_security_scan_run_updated", action, actor, 5 more }
A single Claude Code Security scan run was archived, unarchived, or resumed after a billing pause.
ClaudeCodeSecurityScanScheduleDeleted object{ type: "claude_code_security_scan_schedule_deleted", actor, scan_project_id, 4 more }
A recurring scan schedule was deleted for a Claude Code Security project.
ClaudeCodeSecurityScanScheduleUpdated object{ type: "claude_code_security_scan_schedule_updated", actor, cadence, 5 more }
A recurring scan schedule was set or replaced for a Claude Code Security project.
ClaudeCodeSecurityVulnerabilityDeleted object{ type: "claude_code_security_vulnerability_deleted", actor, scan_id, 5 more }
A Claude Code Security vulnerability finding was permanently deleted.
ClaudeCodeSecurityVulnerabilityFixSessionCreated object{ type: "claude_code_security_vulnerability_fix_session_created", actor, scan_id, 6 more }
A Claude Code remediation session was created for a Claude Code Security vulnerability finding.
ClaudeCodeSecurityVulnerabilityUpdated object{ type: "claude_code_security_vulnerability_updated", action, actor, 6 more }
A Claude Code Security vulnerability finding was dismissed, restored, marked fixed, or reopened.
ClaudeCodeSecurityWebhookCreated object{ type: "claude_code_security_webhook_created", actor, url, 6 more }
A Claude Code Security outbound webhook was created.
ClaudeCodeSecurityWebhookDeleted object{ type: "claude_code_security_webhook_deleted", actor, webhook_id, 5 more }
A Claude Code Security outbound webhook was deleted.
ClaudeCodeSecurityWebhookSecretUpdated object{ type: "claude_code_security_webhook_secret_updated", actor, webhook_id, 5 more }
The HMAC signing secret for a Claude Code Security webhook was rotated.
ClaudeCodeSecurityWebhookUpdated object{ type: "claude_code_security_webhook_updated", actor, webhook_id, 5 more }
A Claude Code Security outbound webhook was updated.
ClaudeCodeTeamMemoryACLUpdated object{ type: "claude_code_team_memory_acl_updated", action, actor, 7 more }
An RBAC group was added to or removed from the Claude Code team-memory ACL.
ClaudeCodeTeamMemoryUpdated object{ type: "claude_code_team_memory_updated", actor, deleted_all, 12 more }
Claude Code team memory shared with the organization was updated.
ClaudeCodeTeamOnboardingGuideUpdated object{ type: "claude_code_team_onboarding_guide_updated", action, actor, 9 more }
A Claude Code team onboarding guide was created, updated, or deleted.
ClaudeCodeUserMarketplacesUpdated object{ type: "claude_code_user_marketplaces_updated", actor, deleted_all, 10 more }
A user's Claude Code plugin marketplace selections were updated on Anthropic servers.
ClaudeCodeUserMemoryUpdated object{ type: "claude_code_user_memory_updated", actor, deleted_all, 11 more }
A user's synced private Claude Code memory was updated or deleted on Anthropic servers.
ClaudeCodeUserPluginsUpdated object{ type: "claude_code_user_plugins_updated", actor, deleted_all, 10 more }
A user's Claude Code plugin selections — which plugins are installed and enabled — were updated on Anthropic servers.
ClaudeCodeUserSettingsUpdated object{ type: "claude_code_user_settings_updated", actor, deleted_all, 10 more }
A user's synced Claude Code settings were updated or deleted on Anthropic servers.
ClaudeEnterpriseUpgradeCreditUpdated object{ type: "claude_enterprise_upgrade_credit_updated", action, actor, 4 more }
An organization admin cancelled, or turned back on, the monthly usage credit the organization receives for upgrading from the Team plan to the Enterprise plan, together with the recurring monthly charge that accompanies it.
ClaudeFileAccessFailed object{ type: "claude_file_access_failed", actor, claude_file_id, 7 more }
A user was denied access to a file in Claude.ai.
ClaudeFileExported object{ type: "claude_file_exported", actor, export_destination, 7 more }
A file was exported from Claude to an external storage destination.
ClaudeFileViewed object{ type: "claude_file_viewed", actor, claude_file_id, 7 more }
A user viewed a file in Claude.ai.
ClaudePluginArchiveAccessed object{ type: "claude_plugin_archive_accessed", actor, marketplace_id, 7 more }
A version archive of a member-owned plugin, containing that member's own files, was downloaded.
ClaudePluginDownloaded object{ type: "claude_plugin_downloaded", actor, marketplace_id, 7 more }
The archive of the plugin version a member was served was downloaded to install or update the plugin in one of the member's Claude apps (Claude in the browser, the Claude desktop app, Claude Code, or a cloud session). Recorded when the member explicitly installs, updates or downloads the plugin (user_action), and when a fetch creates the member's install record for the plugin — its first delivery to them, whether a background sync of a plugin distributed to them or their own first install, which then carries both records (first_delivery). A plugin the member enabled in Claude is on the feed as claude_plugin_enabled and its later delivery by a client's background sync is not recorded again; nor are re-syncs, or fetches that only display the plugin's files in the browser.
ClaudePluginServedVersionUpdated object{ type: "claude_plugin_served_version_updated", actor, marketplace_id, 8 more }
A plugin's served version was updated: an administrator or the owner chose a version, a saved version became the served version, or an accepted library submission was published into the plugin.
ClaudePluginVersionCreated object{ type: "claude_plugin_version_created", actor, is_initial_version, 9 more }
A new version of a plugin was created.
ClaudeProjectSyncSourceCreated object{ type: "claude_project_sync_source_created", actor, claude_project_id, 7 more }
A sync source was connected to a Claude project's knowledge base.
ClaudeProjectSyncSourceDeleted object{ type: "claude_project_sync_source_deleted", actor, claude_project_id, 6 more }
A sync source was disconnected from a Claude project's knowledge base.
ClaudeProjectSyncSourceUpdated object{ type: "claude_project_sync_source_updated", actor, claude_project_id, 8 more }
A Claude project sync source's configuration was updated.
ClaudeSkillDownloaded object{ type: "claude_skill_downloaded", actor, download_kind, 11 more }
A member explicitly downloaded a skill's files to their device: the Download action in Claude, a single file saved from the skill viewer, or an install they asked one of their Claude apps for. Background syncs to the Claude apps, viewing a skill in the app and services reading a skill on the member's behalf are not recorded.
ClaudeSurveyClosed object{ type: "claude_survey_closed", actor, survey_id, 4 more }
An organization admin closed an in-app survey before its end date, ending the collection of responses; a survey that reaches its end date records no event.
ClaudeSurveyCreated object{ type: "claude_survey_created", actor, all_members, 9 more }
An organization admin launched an in-app survey to its chosen audience, opening it immediately or at a scheduled start time.
ClaudeSurveyDeleted object{ type: "claude_survey_deleted", actor, response_count, 5 more }
An organization admin permanently deleted a closed in-app survey together with every response collected for it.
ClaudeSurveyResponseSubmitted object{ type: "claude_survey_response_submitted", actor, survey_id, 4 more }
A member submitted their response to an in-app survey run by their organization; the record omits the response content, and a retried submission can produce more than one record for the same response.
ClaudeSurveyResponsesExported object{ type: "claude_survey_responses_exported", actor, response_count, 5 more }
An organization admin downloaded a survey's responses as a CSV file, one row per response with the member's email address (blank if it is no longer available, for example because they left the organization), the groups, department and cost center they were invited through, the product they answered in, the submission time, and their answers.
ClaudeUserSeatTierUpdated object{ type: "claude_user_seat_tier_updated", actor, user_email, 7 more }
An organization member's seat tier was changed. A null `previous_seat_tier` means the member previously had no seat assigned; a null `current_seat_tier` means the seat was removed.
CliPluginExecPolicyUpdated object{ type: "cli_plugin_exec_policy_updated", actor, cli_name, 10 more }
Admin set or cleared the per-op permission ceiling for a plugin CLI.
ClaudeCommandCreated object{ type: "claude_command_created", actor, id, 5 more }
Command was created.
ClaudeCommandDeleted object{ type: "claude_command_deleted", actor, id, 5 more }
Command was deleted.
ClaudeCommandReplaced object{ type: "claude_command_replaced", actor, id, 5 more }
Command was replaced.
ComplianceAPIAccessed object{ type: "compliance_api_accessed", actor, request_id, 8 more }
Logging event auto-generated for each compliance API request.
CoworkSessionUpdated object{ type: "cowork_session_updated", actor, cowork_session_id, 5 more }
A Cowork session was updated.
DesignProjectArtifactPublished object{ type: "design_project_artifact_published", actor, design_project_id, 6 more }
A Claude Design project's content was published as a claude.ai artifact, making a snapshot of one of its files viewable outside the project's sharing settings.
DesignProjectCreated object{ type: "design_project_created", actor, creation_method, 7 more }
A Claude Design project was created.
DesignProjectDeleted object{ type: "design_project_deleted", actor, design_project_id, 4 more }
A Claude Design project was deleted.
DesignProjectMemberAdded object{ type: "design_project_member_added", actor, design_project_id, 8 more }
A member was granted access to a Claude Design project.
DesignProjectMemberRemoved object{ type: "design_project_member_removed", actor, design_project_id, 7 more }
A member's access to a Claude Design project was revoked.
DesignProjectMemberRoleUpdated object{ type: "design_project_member_role_updated", actor, design_project_id, 9 more }
A Claude Design project member's role was changed.
DesignProjectPublished object{ type: "design_project_published", actor, design_project_id, 5 more }
A Claude Design template or design system was published, making it discoverable by everyone in its organization.
DesignProjectSharingUpdated object{ type: "design_project_sharing_updated", actor, design_project_id, 9 more }
A Claude Design project's link-sharing settings were changed — who the project's link works for, and what people opening it through the link may do. Access granted to individual members is reported separately (see design_project_member_added).
DesignProjectUnpublished object{ type: "design_project_unpublished", actor, design_project_id, 5 more }
A Claude Design template or design system was unpublished, removing it from its organization's shared gallery.
DesignProjectUpdated object{ type: "design_project_updated", actor, design_project_id, 6 more }
A Claude Design project's metadata was updated.
DesignProjectVersionRestored object{ type: "design_project_version_restored", actor, design_project_id, 5 more }
A Claude Design project's working tree was rolled back to a previously saved version, replacing its current files with that version's files.
DesignProjectViewed object{ type: "design_project_viewed", actor, design_project_id, 7 more }
A Claude Design project's content was read. The surface field records which kind of read — a project open, a full-content read, a single-file read, a saved-version read, or an export request. The actor is the reader.
This activity type is retired: project content reads are no longer recorded. Events of this type may still appear in feeds for reads that occurred while it was active.
DesktopExtensionAllowlisted object{ type: "desktop_extension_allowlisted", actor, extension_id, 5 more }
A desktop extension was added to an org's allowlist.
DesktopExtensionBlocklisted object{ type: "desktop_extension_blocklisted", actor, extension_id, 4 more }
A desktop extension was added to the global blocklist.
DesktopExtensionDeleted object{ type: "desktop_extension_deleted", actor, extension_id, 5 more }
A desktop extension was deleted, either globally by an admin or org-scoped by an org owner.
DesktopExtensionRemovedFromAllowlist object{ type: "desktop_extension_removed_from_allowlist", actor, extension_id, 4 more }
A desktop extension was removed from an org's allowlist.
DesktopExtensionUnblocked object{ type: "desktop_extension_unblocked", actor, extension_id, 4 more }
A desktop extension was removed from the global blocklist.
DesktopExtensionUploaded object{ type: "desktop_extension_uploaded", actor, extension_id, 6 more }
A desktop extension was uploaded, either globally by an admin or org-scoped by an org owner.
DesktopExtensionVersionUploaded object{ type: "desktop_extension_version_uploaded", actor, extension_id, 6 more }
A new version of an existing org-owned desktop extension was uploaded.
InferenceHooksConfigDeleted object{ type: "inference_hooks_config_deleted", actor, id, 3 more }
Inference hooks configuration was removed for the organization.
InferenceHooksConfigUpdated object{ type: "inference_hooks_config_updated", actor, enabled, 16 more }
Inference hooks configuration was created or updated for the organization.
InferenceHooksSigningSecretGenerated object{ type: "inference_hooks_signing_secret_generated", actor, rotated, 4 more }
A request signing secret was generated for the organization's Inference hooks configuration.
DomainClaimInitiated object{ type: "domain_claim_initiated", actor, id, 3 more }
Domain capture claim initiated over personal accounts on verified domains.
EndUserInviteRequested object{ type: "end_user_invite_requested", actor, invitee_email, 4 more }
Non-admin member submitted an invite request for a new org member.
ExtraUsageBillingEnabled object{ type: "extra_usage_billing_enabled", actor, id, 3 more }
Usage credit billing was enabled for an organization.
ExtraUsageCreditGranted object{ type: "extra_usage_credit_granted", actor, id, 3 more }
A promotional usage credit grant was claimed.
ExtraUsageSpendLimitCreated object{ type: "extra_usage_spend_limit_created", actor, id, 8 more }
Usage credit spend limit was created.
ExtraUsageSpendLimitDeleted object{ type: "extra_usage_spend_limit_deleted", actor, id, 5 more }
Usage credit spend limit was deleted.
ExtraUsageSpendLimitIncreaseRequestApproved object{ type: "extra_usage_spend_limit_increase_request_approved", actor, id, 7 more }
A usage credit spend limit increase request was approved.
ExtraUsageSpendLimitIncreaseRequestDenied object{ type: "extra_usage_spend_limit_increase_request_denied", actor, id, 5 more }
A usage credit spend limit increase request was denied.
ExtraUsageSpendLimitUpdated object{ type: "extra_usage_spend_limit_updated", actor, id, 8 more }
Usage credit spend limit was updated.
ClaudeFileDeleted object{ type: "claude_file_deleted", actor, claude_file_id, 5 more }
A file was deleted.
ClaudeFileUploaded object{ type: "claude_file_uploaded", actor, claude_file_id, 7 more }
A file was uploaded.
GheConfigurationCreated object{ type: "ghe_configuration_created", actor, ghe_configuration_id, 7 more }
Admin created a GHE configuration.
GheConfigurationDeleted object{ type: "ghe_configuration_deleted", actor, ghe_configuration_id, 7 more }
Admin deleted a GHE configuration.
GheConfigurationUpdated object{ type: "ghe_configuration_updated", actor, ghe_configuration_id, 20 more }
Admin updated a GHE configuration. Previous/new field pairs are recorded only for settings that changed in the update; secret credentials are never recorded, only whether they were replaced.
GheUserConnected object{ type: "ghe_user_connected", actor, id, 4 more }
User connected to a GHE instance.
GheUserDisconnected object{ type: "ghe_user_disconnected", actor, id, 4 more }
User disconnected from a GHE instance.
GheWebhookSignatureInvalid object{ type: "ghe_webhook_signature_invalid", actor, ghe_configuration_id, 4 more }
Webhook signature validation failed.
ClaudeGitHubIntegrationCreated object{ type: "claude_github_integration_created", actor, integration_id, 9 more }
A GitHub integration was enabled for the organization.
ClaudeGitHubIntegrationDeleted object{ type: "claude_github_integration_deleted", actor, integration_id, 8 more }
A GitHub integration was disabled for the organization.
ClaudeGitHubIntegrationUpdated object{ type: "claude_github_integration_updated", actor, integration_id, 6 more }
A GitHub integration's configuration was updated.
An installation of the Claude GitHub App (a GitHub organization or user account where the App is installed) was linked to the organization, letting the organization's Claude Code features act on that GitHub account's repositories.
An installation of the Claude GitHub App was unlinked from the organization, so the organization's Claude Code features can no longer act on that GitHub account's repositories through it.
A user attempted to import a personal GitHub access token for use with Claude Code. The `result` field indicates the outcome of the import (imported, rejected, or failed).
GitlabConfigurationCreated object{ type: "gitlab_configuration_created", actor, gitlab_configuration_id, 7 more }
An organization admin created a self-managed GitLab configuration for syncing plugin marketplaces.
GitlabConfigurationDeleted object{ type: "gitlab_configuration_deleted", actor, gitlab_configuration_id, 7 more }
An organization admin deleted a self-managed GitLab configuration.
GitlabConfigurationUpdated object{ type: "gitlab_configuration_updated", actor, gitlab_configuration_id, 13 more }
An organization admin updated a self-managed GitLab configuration. Previous/new field pairs are recorded only for settings that changed in the update; secret credentials are never recorded, only whether they were replaced.
ClaudeGdriveIntegrationCreated object{ type: "claude_gdrive_integration_created", actor, integration_id, 6 more }
A Google Drive integration was enabled for the organization.
ClaudeGdriveIntegrationDeleted object{ type: "claude_gdrive_integration_deleted", actor, integration_id, 5 more }
A Google Drive integration was disabled for the organization.
ClaudeGdriveIntegrationUpdated object{ type: "claude_gdrive_integration_updated", actor, integration_id, 5 more }
A Google Drive integration's configuration was updated.
GroupCreated object{ type: "group_created", actor, group_id, 5 more }
A group was created (RBAC admin or SCIM provisioning).
GroupDeleted object{ type: "group_deleted", actor, group_id, 4 more }
A group was deleted (RBAC admin or SCIM provisioning).
GroupListViewed object{ type: "group_list_viewed", actor, id, 3 more }
Admin viewed the list of RBAC groups.
GroupMemberAdded object{ type: "group_member_added", actor, group_id, 5 more }
One or more members were added to a group.
GroupMemberAdditionFailed object{ type: "group_member_addition_failed", actor, group_id, 5 more }
A request to add members to a group failed. Some of the requested members may have been added before the failure.
GroupMemberListViewed object{ type: "group_member_list_viewed", actor, group_id, 4 more }
Admin viewed the members of an RBAC group.
GroupMemberRemovalFailed object{ type: "group_member_removal_failed", actor, group_id, 5 more }
A request to remove members from a group failed. Some of the requested members may have been removed before the failure.
GroupMemberRemoved object{ type: "group_member_removed", actor, group_id, 5 more }
One or more members were removed from a group.
GroupProjectSharesRevoked object{ type: "group_project_shares_revoked", actor, group_id, 6 more }
An RBAC group's project shares in one organization were revoked in bulk.
GroupSkillSharesRevoked object{ type: "group_skill_shares_revoked", actor, group_id, 7 more }
An RBAC group's skill shares in one organization were revoked in bulk.
GroupUpdated object{ type: "group_updated", actor, group_id, 4 more }
A group was updated (RBAC admin or SCIM provisioning).
GroupViewed object{ type: "group_viewed", actor, group_id, 4 more }
A group was viewed.
GroupVisibilityUpdated object{ type: "group_visibility_updated", actor, group_id, 6 more }
An RBAC group's visibility policy was updated.
InferenceHooksCircuitBreakerTripped object{ type: "inference_hooks_circuit_breaker_tripped", actor, fail_mode, 6 more }
The organization's Inference hooks circuit breaker tripped automatically: calls to the organization's Inference hooks endpoint crossed a failure threshold, and inspection was suspended to protect live traffic. While tripped, requests are handled according to the organization's failure handling setting — allowed through uninspected (fail open) or rejected (fail closed) — and no per-request Inference hooks activities are recorded. Inspection turns back on by itself once the organization's Inference hooks endpoint returns a valid allow or deny answer to Anthropic's test request again, at least 10 minutes after the trip. An administrator can also end the tripped state by re-enabling Inference hooks inspection. If an administrator saves the Inference hooks settings after the trip (even without changing anything) or generates a new signing secret, inspection no longer turns back on by itself and stays off until an administrator re-enables it.
InferenceHooksRequestDenied object{ type: "inference_hooks_request_denied", actor, id, 8 more }
Inference hooks inspection denied a request. The request was blocked.
InferenceHooksRequestFailedOpen object{ type: "inference_hooks_request_failed_open", actor, reason, 7 more }
A request proceeded without Inference hooks inspection because a verdict could not be obtained and the organization's Inference hooks configuration is set to fail open.
IntegrationUserConnected object{ type: "integration_user_connected", actor, id, 7 more }
User connected to an integration.
IntegrationUserDisconnected object{ type: "integration_user_disconnected", actor, id, 6 more }
User disconnected from an integration.
InvoiceCollectionMethodUpdated object{ type: "invoice_collection_method_updated", actor, id, 4 more }
Invoice collection method was changed.
UserLoggedOut object{ type: "user_logged_out", actor, id, 3 more }
A user signed out of one or all sessions.
LtiLaunchInitiated object{ type: "lti_launch_initiated", actor, id, 3 more }
LTI launch was initiated.
LtiLaunchSuccess object{ type: "lti_launch_success", actor, id, 3 more }
LTI launch completed successfully.
LtiPlatformCreated object{ type: "lti_platform_created", actor, lti_platform_id, 5 more }
Anthropic staff created an LTI platform integration on behalf of an org.
LtiPlatformUpdated object{ type: "lti_platform_updated", actor, lti_platform_id, 5 more }
Anthropic staff updated an LTI platform integration on behalf of an org.
MagicLinkLoginFailed object{ type: "magic_link_login_failed", actor, id, 3 more }
A magic link sign-in attempt failed.
MagicLinkLoginInitiated object{ type: "magic_link_login_initiated", actor, id, 3 more }
A user requested a magic link sign-in email.
MagicLinkLoginSucceeded object{ type: "magic_link_login_succeeded", actor, id, 5 more }
A user successfully signed in with a magic link email.
ManagedOrganizationSetupCompleted object{ type: "managed_organization_setup_completed", actor, id, 3 more }
Managed (AWS Marketplace) organization setup was completed.
MarketplaceCreated object{ type: "marketplace_created", actor, marketplace_id, 6 more }
Admin created an organization marketplace.
MarketplaceDeleted object{ type: "marketplace_deleted", actor, marketplace_id, 4 more }
Admin deleted an organization marketplace.
MarketplaceUpdated object{ type: "marketplace_updated", actor, marketplace_id, 6 more }
Admin updated an organization marketplace.
MarketplaceWebhookDeleted object{ type: "marketplace_webhook_deleted", actor, marketplace_id, 4 more }
Admin removed the GitHub push webhook for a marketplace.
MarketplaceWebhookProvisioned object{ type: "marketplace_webhook_provisioned", actor, marketplace_id, 5 more }
Admin provisioned a GitHub push webhook for a marketplace.
McpDirectoryServerPublished object{ type: "mcp_directory_server_published", actor, mcp_directory_server_id, 5 more }
The organization published its approved MCP directory listing.
McpServerCreated object{ type: "mcp_server_created", actor, mcp_server_id, 6 more }
An MCP server was added to the organization.
McpServerDeleted object{ type: "mcp_server_deleted", actor, mcp_server_id, 5 more }
An MCP server was removed from the organization.
McpServerManagedAuthTokenExchanged object{ type: "mcp_server_managed_auth_token_exchanged", actor, managed_auth_mode, 12 more }
A user attempted to obtain an access token for an MCP server via enterprise managed authorization. This event reports the outcomes of attempted token exchanges. Repeated failures with the same cause may be reported once until the cause changes, and requests refused before a token exchange is attempted are not reported, except the "connector_scope_not_granted" and "identity_assertion_refused" failures described under error_type.
McpServerManagedAuthUpdated object{ type: "mcp_server_managed_auth_updated", actor, mcp_server_id, 15 more }
An MCP server's enterprise managed authorization settings were set, changed, or cleared, including when they were supplied while the server was being added or edited. Fields without a "previous\_" prefix describe the settings after the change and are null when the server has no managed authorization settings afterwards; "previous\_" fields describe the settings before the change and are null when the server had none before (always the case for a newly added server).
McpServerUpdated object{ type: "mcp_server_updated", actor, mcp_server_id, 6 more }
An MCP server's configuration was updated.
McpToolPolicyUpdated object{ type: "mcp_tool_policy_updated", actor, mcp_server_id, 9 more }
The permission restriction for an MCP tool was set or cleared.
OrgAnalyticsAPICapabilityUpdated object{ type: "org_analytics_api_capability_updated", actor, id, 5 more }
Organization analytics_api capability was enabled or disabled.
OrgBulkDeleteInitiated object{ type: "org_bulk_delete_initiated", actor, id, 3 more }
Organization bulk deletion was initiated.
OrgCapabilityGrantAdded object{ type: "org_capability_grant_added", actor, grant_type, 6 more }
A capability grant was added to a workspace or role.
OrgCapabilityGrantRemoved object{ type: "org_capability_grant_removed", actor, grant_type, 6 more }
A capability grant was removed from a workspace or role.
OrgChatCoworkUnifiedDisabled object{ type: "org_chat_cowork_unified_disabled", actor, id, 5 more }
The organization's setting for the unified Chat and Cowork experience was turned off.
OrgChatCoworkUnifiedEnabled object{ type: "org_chat_cowork_unified_enabled", actor, id, 5 more }
The organization's setting for the unified Chat and Cowork experience was turned on.
OrgClaudeCodeDataSharingDisabled object{ type: "org_claude_code_data_sharing_disabled", actor, id, 5 more }
Organization Claude Code data sharing was disabled.
OrgClaudeCodeDataSharingEnabled object{ type: "org_claude_code_data_sharing_enabled", actor, id, 5 more }
Organization Claude Code data sharing was enabled.
OrgClaudeCodeDesktopDisabled object{ type: "org_claude_code_desktop_disabled", actor, id, 5 more }
Organization Claude Code Desktop was disabled.
OrgClaudeCodeDesktopEnabled object{ type: "org_claude_code_desktop_enabled", actor, id, 5 more }
Organization Claude Code Desktop was enabled.
OrgClaudeCodeZeroDataRetentionDisabled object{ type: "org_claude_code_zero_data_retention_disabled", actor, id, 3 more }
A primary owner disabled zero data retention for Claude Code, so Claude Code content is retained according to the organization's data retention settings.
OrgComplianceAPISettingsUpdated object{ type: "org_compliance_api_settings_updated", actor, id, 5 more }
Organization compliance API settings were updated.
OrgConnectorDomainGuardUpdated object{ type: "org_connector_domain_guard_updated", actor, enforced, 4 more }
Enterprise admin changed whether connectors are restricted to verified domains.
OrgCoworkActWithoutAskingModeDisabled object{ type: "org_cowork_act_without_asking_mode_disabled", actor, id, 3 more }
The "Act without asking" mode in Cowork was disabled for the organization, so members can no longer let Claude act without asking for approval.
OrgCoworkActWithoutAskingModeEnabled object{ type: "org_cowork_act_without_asking_mode_enabled", actor, id, 3 more }
The "Act without asking" mode in Cowork was enabled for the organization, allowing members to let Claude act without asking for approval.
OrgCoworkAgentDisabled object{ type: "org_cowork_agent_disabled", actor, id, 5 more }
Organization Cowork Agent was disabled.
OrgCoworkAgentEnabled object{ type: "org_cowork_agent_enabled", actor, id, 5 more }
Organization Cowork Agent was enabled.
OrgCoworkAutoModeDisabled object{ type: "org_cowork_auto_mode_disabled", actor, id, 3 more }
The "Auto" permission mode in Cowork was disabled for the organization, so members can no longer let Claude approve its own actions after a safety check.
OrgCoworkAutoModeEnabled object{ type: "org_cowork_auto_mode_enabled", actor, id, 3 more }
The "Auto" permission mode in Cowork was enabled for the organization, allowing members to let Claude approve its own actions after a safety check.
OrgCoworkBrowserPaneDisabled object{ type: "org_cowork_browser_pane_disabled", actor, id, 3 more }
The in-app browser in Cowork was disabled for the organization, so Claude can no longer open or use websites in a browser pane during members' Cowork sessions.
OrgCoworkBrowserPaneEnabled object{ type: "org_cowork_browser_pane_enabled", actor, id, 3 more }
The in-app browser in Cowork was enabled for the organization, letting Claude open and use websites in a browser pane during members' Cowork sessions.
OrgCoworkDisabled object{ type: "org_cowork_disabled", actor, id, 5 more }
Organization cowork was disabled.
OrgCoworkEnabled object{ type: "org_cowork_enabled", actor, id, 5 more }
Organization cowork was enabled.
OrgCoworkMcpAlwaysAllowDisabled object{ type: "org_cowork_mcp_always_allow_disabled", actor, id, 3 more }
The "Always allow" option for connector tools in Cowork was disabled for the organization, so each use of a connector tool that can make changes requires approval. Read-only connector tools are not affected by this setting.
OrgCoworkMcpAlwaysAllowEnabled object{ type: "org_cowork_mcp_always_allow_enabled", actor, id, 3 more }
The "Always allow" option for connector tools in Cowork was enabled for the organization, letting members approve a connector tool that can make changes once and allow its later uses automatically. Read-only connector tools are not affected by this setting.
OrgCoworkOtlpSettingsUpdated object{ type: "org_cowork_otlp_settings_updated", actor, id, 12 more }
The organization's Cowork OpenTelemetry monitoring export settings were updated.
OrgCoworkRemoteDisabled object{ type: "org_cowork_remote_disabled", actor, id, 3 more }
Running Cowork in the cloud was disabled for the organization, so members can no longer run Cowork sessions in Anthropic-hosted remote environments.
OrgCoworkRemoteEnabled object{ type: "org_cowork_remote_enabled", actor, id, 3 more }
Running Cowork in the cloud was enabled for the organization, allowing members to run Cowork sessions in Anthropic-hosted remote environments.
OrgCreationBlocked object{ type: "org_creation_blocked", actor, id, 4 more }
Organization creation was blocked.
OrgDataExportAccessed object{ type: "org_data_export_accessed", actor, id, 4 more }
Organization data export file was accessed/downloaded via signed URL.
OrgDataExportCompleted object{ type: "org_data_export_completed", actor, id, 4 more }
Organization data export was completed.
OrgDataExportStarted object{ type: "org_data_export_started", actor, id, 5 more }
Organization data export was started.
OrgDataResidencyUpdated object{ type: "org_data_residency_updated", actor, id, 4 more }
The organization's inference data residency settings were updated.
OrgDeletedViaBulk object{ type: "org_deleted_via_bulk", actor, id, 3 more }
Organization was deleted via bulk operation.
OrgDeletionRequested object{ type: "org_deletion_requested", actor, id, 3 more }
Organization deletion was requested.
OrgDirectoryResyncCompleted object{ type: "org_directory_resync_completed", actor, resync_uuid, 4 more }
Organization directory resync completed successfully.
OrgDirectoryResyncFailed object{ type: "org_directory_resync_failed", actor, resync_uuid, 4 more }
Organization directory resync failed.
OrgDirectoryResyncStarted object{ type: "org_directory_resync_started", actor, resync_uuid, 5 more }
Organization directory resync was started asynchronously.
OrgDirectorySyncActivated object{ type: "org_directory_sync_activated", actor, id, 3 more }
Organization directory sync was activated.
OrgDirectorySyncAddInitiated object{ type: "org_directory_sync_add_initiated", actor, id, 3 more }
Organization directory sync setup was initiated.
OrgDirectorySyncDeleted object{ type: "org_directory_sync_deleted", actor, id, 3 more }
Organization directory sync was deleted.
OrgDiscoverabilityDisabled object{ type: "org_discoverability_disabled", actor, id, 3 more }
Admin disabled organization discoverability.
OrgDiscoverabilityEnabled object{ type: "org_discoverability_enabled", actor, id, 3 more }
Admin enabled organization discoverability.
OrgDiscoverabilitySettingsUpdated object{ type: "org_discoverability_settings_updated", actor, id, 3 more }
Admin updated organization discoverability settings.
OrgDomainAddInitiated object{ type: "org_domain_add_initiated", actor, id, 3 more }
Organization domain verification was initiated.
OrgDomainRemoved object{ type: "org_domain_removed", actor, id, 4 more }
Organization domain was removed.
OrgDomainVerified object{ type: "org_domain_verified", actor, id, 4 more }
Organization domain was verified.
OrgExternalKeyCreated object{ type: "org_external_key_created", actor, external_key_id, 5 more }
A CMEK external key config was created.
OrgExternalKeyDeleted object{ type: "org_external_key_deleted", actor, external_key_id, 4 more }
A CMEK external key config was deleted.
OrgExternalKeyUpdated object{ type: "org_external_key_updated", actor, external_key_id, 5 more }
A CMEK external key config was updated.
OrgExternalKeyValidated object{ type: "org_external_key_validated", actor, external_key_id, 5 more }
A CMEK external key config was validated against the customer's KMS.
OrgHipaaArtifactsTermsAccepted object{ type: "org_hipaa_artifacts_terms_accepted", actor, terms_content_hash, 5 more }
An owner of the organization accepted the terms for using artifacts with the HIPAA configuration enabled.
OrgHipaaClaudeCodeCoworkRestrictionsDeferred object{ type: "org_hipaa_claude_code_cowork_restrictions_deferred", actor, id, 3 more }
The HIPAA configuration for Claude Code (local mode) and Cowork (local mode) was left off for the organization when the configuration launched, and stays off until it is applied.
OrgHipaaClaudeCodeCoworkRestrictionsEnabled object{ type: "org_hipaa_claude_code_cowork_restrictions_enabled", actor, reason, 4 more }
The HIPAA configuration was applied to Claude Code (local mode) and Cowork (local mode) for the organization.
OrgHipaaSelfServeEnabled object{ type: "org_hipaa_self_serve_enabled", actor, baa_content_hash, 6 more }
A primary owner accepted the Business Associate Agreement and enabled the HIPAA configuration for the organization through the self-serve flow.
OrgIPRestrictionCreated object{ type: "org_ip_restriction_created", actor, id, 4 more }
Organization IP restriction was created.
OrgIPRestrictionDeleted object{ type: "org_ip_restriction_deleted", actor, id, 4 more }
Organization IP restriction was deleted.
OrgIPRestrictionUpdated object{ type: "org_ip_restriction_updated", actor, id, 7 more }
Organization IP restriction was updated.
OrgInviteLinkDisabled object{ type: "org_invite_link_disabled", actor, id, 3 more }
Organization invite link was disabled.
OrgInviteLinkGenerated object{ type: "org_invite_link_generated", actor, id, 3 more }
Organization invite link was generated.
OrgInviteLinkRegenerated object{ type: "org_invite_link_regenerated", actor, id, 3 more }
Organization invite link was regenerated (previous link invalidated).
OrgInviteViewed object{ type: "org_invite_viewed", actor, invite_id, 4 more }
An organization invite was viewed.
OrgInvitesListed object{ type: "org_invites_listed", actor, id, 3 more }
Organization invites were listed.
OrgJoinProposalDecided object{ type: "org_join_proposal_decided", actor, approved, 4 more }
Approve or reject decision on a parent-org join proposal.
OrgJoinRequestApproved object{ type: "org_join_request_approved", actor, id, 3 more }
Admin approved a join request.
OrgJoinRequestCreated object{ type: "org_join_request_created", actor, id, 3 more }
User requested to join an organization.
OrgJoinRequestDismissed object{ type: "org_join_request_dismissed", actor, id, 3 more }
Admin dismissed a join request.
OrgJoinRequestInstantApproved object{ type: "org_join_request_instant_approved", actor, id, 3 more }
Join request was instantly approved.
OrgJoinRequestsBulkDismissed object{ type: "org_join_requests_bulk_dismissed", actor, id, 3 more }
Admin bulk-dismissed join requests.
OrgLibrarySubmissionCreated object{ type: "org_library_submission_created", actor, library_submission_id, 9 more }
A member submitted one of their own skills or plugins for publication into the organization library.
OrgLibrarySubmissionResolved object{ type: "org_library_submission_resolved", actor, content_hash, 16 more }
A member's submission of a skill or plugin to the organization library was accepted or denied, or an accepted one finished publishing.
OrgLibrarySubmissionWithdrawn object{ type: "org_library_submission_withdrawn", actor, library_submission_id, 8 more }
A pending submission to the organization library was withdrawn before any reviewer decided on it.
OrgMagicLinkSecondFactorToggled object{ type: "org_magic_link_second_factor_toggled", actor, enabled, 4 more }
Organization magic link second factor was toggled.
OrgMemberAvatarRemoved object{ type: "org_member_avatar_removed", actor, user_id, 4 more }
An administrator removed another member's profile picture.
OrgMemberInvitesDisabled object{ type: "org_member_invites_disabled", actor, id, 3 more }
Admin disabled member invites for the organization.
OrgMemberInvitesEnabled object{ type: "org_member_invites_enabled", actor, id, 3 more }
Admin enabled member invites for the organization.
OrgMembersExported object{ type: "org_members_exported", actor, id, 3 more }
Organization members list was exported as CSV.
OrgModelDefaultUpdated object{ type: "org_model_default_updated", action, actor, 9 more }
An organization or role default model setting was changed by an administrator.
OrgParentJoinProposalCreated object{ type: "org_parent_join_proposal_created", actor, id, 3 more }
Organization parent join proposal was created.
OrgParentSearchPerformed object{ type: "org_parent_search_performed", actor, id, 3 more }
Organization parent search was performed.
OrgSSOAddInitiated object{ type: "org_sso_add_initiated", actor, id, 3 more }
Organization SSO setup was initiated.
OrgSSOConnectionActivated object{ type: "org_sso_connection_activated", actor, id, 5 more }
Organization SSO connection was activated.
OrgSSOConnectionDeactivated object{ type: "org_sso_connection_deactivated", actor, id, 4 more }
Organization SSO connection was deactivated.
OrgSSOConnectionDeleted object{ type: "org_sso_connection_deleted", actor, id, 4 more }
Organization SSO connection was deleted.
OrgSSOGroupRoleMappingsUpdated object{ type: "org_sso_group_role_mappings_updated", actor, id, 3 more }
Organization SSO group role mappings were updated.
OrgSSOProvisioningModeChanged object{ type: "org_sso_provisioning_mode_changed", actor, id, 5 more }
Organization SSO provisioning mode was changed.
OrgSSOScimWelcomeEmailToggled object{ type: "org_sso_scim_welcome_email_toggled", actor, enabled, 5 more }
Organization SCIM-provisioned welcome email was toggled.
OrgSSOSeatTierAssignmentToggled object{ type: "org_sso_seat_tier_assignment_toggled", actor, enabled, 5 more }
Organization SSO seat tier assignment was toggled.
OrgSSOSeatTierMappingsUpdated object{ type: "org_sso_seat_tier_mappings_updated", actor, id, 5 more }
Organization SSO seat tier mappings were updated.
OrgSSOToggled object{ type: "org_sso_toggled", actor, enabled, 4 more }
Organization SSO was toggled on or off.
OrgSyncDeletingSynchronizedFilesStarted object{ type: "org_sync_deleting_synchronized_files_started", actor, id, 3 more }
Organization started deleting synchronized files.
OrgSyncSynchronizedFilesDeleted object{ type: "org_sync_synchronized_files_deleted", actor, id, 3 more }
Organization synchronized files were deleted.
OrgTaintAdded object{ type: "org_taint_added", actor, id, 5 more }
A compliance marker (taint) was added to an organization, for example the marker that records its HIPAA configuration.
OrgTaintRemoved object{ type: "org_taint_removed", actor, id, 4 more }
A compliance marker (taint) was removed from an organization.
OrgUserDeleted object{ type: "org_user_deleted", actor, id, 5 more }
User was removed from organization.
OrgUserInviteAccepted object{ type: "org_user_invite_accepted", actor, id, 5 more }
Organization user invite was accepted.
OrgUserInviteDeleted object{ type: "org_user_invite_deleted", actor, id, 4 more }
Organization user invite was deleted.
OrgUserInviteReSent object{ type: "org_user_invite_re_sent", actor, id, 6 more }
Organization user invite was re-sent.
OrgUserInviteRejected object{ type: "org_user_invite_rejected", actor, id, 4 more }
Organization user invite was rejected.
OrgUserInviteSent object{ type: "org_user_invite_sent", actor, id, 7 more }
Organization user invite was sent.
OrgUserLeft object{ type: "org_user_left", actor, id, 4 more }
User removed themselves from organization.
OrgUserSharesRetained object{ type: "org_user_shares_retained", actor, resource_count, 11 more }
A member left or was removed from the organization while projects, skills, plugins, or chats they had shared were still shared, and those shares were kept.
OrgUserTrustedDevicesRevoked object{ type: "org_user_trusted_devices_revoked", actor, completed, 7 more }
An organization admin revoked a member's trusted devices and signed the member out of all active sessions.
OrgUserViewed object{ type: "org_user_viewed", actor, user_id, 4 more }
An organization user was viewed.
OrgUsersListed object{ type: "org_users_listed", actor, id, 3 more }
Organization users were listed.
OrgWorkAcrossAppsDisabled object{ type: "org_work_across_apps_disabled", actor, id, 5 more }
The organization's "Let Claude work across apps" setting was turned off.
OrgWorkAcrossAppsEnabled object{ type: "org_work_across_apps_enabled", actor, id, 5 more }
The organization's "Let Claude work across apps" setting was turned on.
OrganizationAddressUpdated object{ type: "organization_address_updated", actor, id, 7 more }
The organization's billing or shipping address was updated.
OrganizationIconDeleted object{ type: "organization_icon_deleted", actor, id, 3 more }
Organization's custom icon deleted.
OrganizationIconUpdated object{ type: "organization_icon_updated", actor, id, 3 more }
Organization's custom icon uploaded or replaced.
ClaudeOrganizationSettingsUpdated object{ type: "claude_organization_settings_updated", actor, updates, 5 more }
Organization settings were updated.
OwnedProjectsAccessRestored object{ type: "owned_projects_access_restored", actor, id, 4 more }
Access to owned projects was restored.
PaymentMethodUpdated object{ type: "payment_method_updated", actor, id, 3 more }
The organization's default payment method was updated.
PendingShareCreated object{ type: "pending_share_created", actor, invitee_email, 7 more }
A pending share of a project or skill was created for an email address that is not yet an organization member.
PendingShareRevoked object{ type: "pending_share_revoked", actor, invitee_email, 6 more }
A pending share of a project or skill was revoked before the invitee joined the organization.
PhoneCodeSent object{ type: "phone_code_sent", actor, id, 3 more }
User requested a phone verification code.
PhoneCodeVerified object{ type: "phone_code_verified", actor, id, 3 more }
User successfully verified their phone code.
PlatformAgentArchived object{ type: "platform_agent_archived", actor, agent_id, 5 more }
An agent was archived on the API platform.
PlatformAgentCreated object{ type: "platform_agent_created", actor, agent_id, 5 more }
An agent was created on the API platform.
PlatformAgentDeleted object{ type: "platform_agent_deleted", actor, agent_id, 5 more }
An agent was deleted from the API platform.
PlatformAgentDeploymentArchived object{ type: "platform_agent_deployment_archived", actor, deployment_id, 5 more }
An agent deployment was archived on the API platform.
PlatformAgentDeploymentCreated object{ type: "platform_agent_deployment_created", actor, deployment_id, 5 more }
An agent deployment was created on the API platform.
PlatformAgentDeploymentDeleted object{ type: "platform_agent_deployment_deleted", actor, deployment_id, 5 more }
An agent deployment was deleted from the API platform.
PlatformAgentDeploymentPaused object{ type: "platform_agent_deployment_paused", actor, deployment_id, 5 more }
An agent deployment was paused on the API platform.
PlatformAgentDeploymentRunTriggered object{ type: "platform_agent_deployment_run_triggered", actor, deployment_id, 5 more }
An agent deployment was run on demand on the API platform.
PlatformAgentDeploymentUnpaused object{ type: "platform_agent_deployment_unpaused", actor, deployment_id, 5 more }
An agent deployment was resumed on the API platform.
PlatformAgentDeploymentUpdated object{ type: "platform_agent_deployment_updated", actor, deployment_id, 5 more }
An agent deployment was updated on the API platform.
PlatformAgentSessionArchived object{ type: "platform_agent_session_archived", actor, session_id, 5 more }
An agent session was archived on the API platform.
PlatformAgentSessionCreated object{ type: "platform_agent_session_created", actor, session_id, 5 more }
An agent session was created on the API platform.
PlatformAgentSessionDeleted object{ type: "platform_agent_session_deleted", actor, session_id, 5 more }
An agent session was deleted from the API platform.
PlatformAgentSessionResourceAdded object{ type: "platform_agent_session_resource_added", actor, resource_id, 6 more }
A resource was attached to an agent session.
PlatformAgentSessionResourceDeleted object{ type: "platform_agent_session_resource_deleted", actor, resource_id, 6 more }
A resource attached to an agent session was removed.
PlatformAgentSessionResourceUpdated object{ type: "platform_agent_session_resource_updated", actor, resource_id, 6 more }
A resource attached to an agent session was updated.
PlatformAgentSessionThreadArchived object{ type: "platform_agent_session_thread_archived", actor, session_id, 6 more }
A thread within an agent session was archived.
PlatformAgentSessionUpdated object{ type: "platform_agent_session_updated", actor, session_id, 5 more }
An agent session was updated on the API platform.
PlatformAgentUpdated object{ type: "platform_agent_updated", actor, agent_id, 5 more }
An agent was updated on the API platform.
PlatformAPIKeyCreated object{ type: "platform_api_key_created", actor, api_key_id, 7 more }
An API key was created.
PlatformAPIKeyUpdated object{ type: "platform_api_key_updated", actor, api_key_id, 5 more }
An API key was updated.
PlatformAppAttestAuthentication object{ type: "platform_app_attest_authentication", actor, id, 6 more }
An attested mobile device attempted to exchange an Apple App Attest assertion for Anthropic API credentials.
PlatformBillingUpgradedToPrepaid object{ type: "platform_billing_upgraded_to_prepaid", actor, previous_billing_type, 4 more }
The organization's API billing was upgraded to the prepaid plan.
PlatformClearanceWorkspaceProgramRequestCleared object{ type: "platform_clearance_workspace_program_request_cleared", actor, program_slug, 5 more }
A workspace's clearance program assignment was removed.
PlatformClearanceWorkspaceProgramRequestSet object{ type: "platform_clearance_workspace_program_request_set", actor, opt_decision, 6 more }
A workspace's clearance program assignment was created or updated.
PlatformCostReportViewed object{ type: "platform_cost_report_viewed", actor, id, 3 more }
The cost report was viewed.
PlatformDreamArchived object{ type: "platform_dream_archived", actor, dream_id, 5 more }
A Dream (asynchronous memory-consolidation job) was archived.
PlatformDreamCancelled object{ type: "platform_dream_cancelled", actor, dream_id, 5 more }
A Dream (asynchronous memory-consolidation job) was cancelled before it completed.
PlatformDreamCreated object{ type: "platform_dream_created", actor, dream_id, 5 more }
A Dream (asynchronous memory-consolidation job) was created.
PlatformFederatedAuthentication object{ type: "platform_federated_authentication", actor, id, 7 more }
A federated workload identity attempted to exchange an OIDC token for Anthropic API credentials.
PlatformFederationIssuerArchived object{ type: "platform_federation_issuer_archived", actor, federation_issuer_id, 4 more }
An OIDC federation issuer was archived.
PlatformFederationIssuerCreated object{ type: "platform_federation_issuer_created", actor, federation_issuer_id, 8 more }
An OIDC federation issuer was created, registering an external identity provider that federation rules can trust for workload authentication.
PlatformFederationIssuerUpdated object{ type: "platform_federation_issuer_updated", actor, federation_issuer_id, 5 more }
An OIDC federation issuer was updated.
PlatformFederationRuleArchived object{ type: "platform_federation_rule_archived", actor, federation_rule_id, 4 more }
An OIDC federation rule was archived.
PlatformFederationRuleCreated object{ type: "platform_federation_rule_created", actor, applies_to_all_workspaces, 13 more }
An OIDC federation rule was created, allowing tokens from a federation issuer to authenticate as a service account or user. Rules may additionally match on token claims or a condition expression, which are not included in this event.
PlatformFederationRuleUpdated object{ type: "platform_federation_rule_updated", actor, federation_rule_id, 5 more }
An OIDC federation rule was updated.
PlatformFederationRuleWorkspaceAdded object{ type: "platform_federation_rule_workspace_added", actor, federation_rule_id, 5 more }
A federation rule was enabled for a workspace.
PlatformFederationRuleWorkspaceRemoved object{ type: "platform_federation_rule_workspace_removed", actor, federation_rule_id, 5 more }
A federation rule was disabled for a workspace.
PlatformFileContentDownloaded object{ type: "platform_file_content_downloaded", actor, file_id, 4 more }
Activity logged when file content is downloaded via GET /v1/files/{file_id}/content.
PlatformFileDeleted object{ type: "platform_file_deleted", actor, file_id, 4 more }
Activity logged when a file is deleted via DELETE /v1/files/{file_id}.
PlatformFileUploaded object{ type: "platform_file_uploaded", actor, file_id, 5 more }
Activity logged when a file is uploaded via POST /v1/files.
PlatformMemoryCreated object{ type: "platform_memory_created", actor, memory_id, 7 more }
An agent memory document was created.
PlatformMemoryDeleted object{ type: "platform_memory_deleted", actor, memory_id, 7 more }
An agent memory document was deleted.
PlatformMemoryStoreArchived object{ type: "platform_memory_store_archived", actor, memory_store_id, 5 more }
An agent memory store was archived. Archived stores reject new memory writes and cannot be attached to new sessions; deletion and redaction remain permitted for privacy scrubbing.
PlatformMemoryStoreCreated object{ type: "platform_memory_store_created", actor, memory_store_id, 5 more }
An agent memory store was created.
PlatformMemoryStoreDeleted object{ type: "platform_memory_store_deleted", actor, memory_store_id, 5 more }
An agent memory store was deleted. Memory content removal may complete asynchronously for very large stores.
PlatformMemoryStoreUpdated object{ type: "platform_memory_store_updated", actor, memory_store_id, 5 more }
An agent memory store's name, description, or metadata was updated.
PlatformMemoryUpdated object{ type: "platform_memory_updated", actor, memory_id, 7 more }
An agent memory document's content or path was updated.
PlatformMemoryVersionRedacted object{ type: "platform_memory_version_redacted", actor, memory_id, 7 more }
A historical version of an agent memory document was redacted. Redaction scrubs the stored content of a specific version while preserving the version's existence in the history.
PlatformOAuthAppCreated object{ type: "platform_oauth_app_created", actor, oauth_app_id, 5 more }
An OAuth app was created.
PlatformOAuthAppRevoked object{ type: "platform_oauth_app_revoked", actor, oauth_app_id, 4 more }
An OAuth app was revoked.
PlatformOAuthAppUpdated object{ type: "platform_oauth_app_updated", actor, oauth_app_id, 5 more }
An OAuth app was updated.
PlatformOrganizationCreated object{ type: "platform_organization_created", actor, admin_email, 6 more }
An owner of the organization created a Claude Console organization under the same parent organization.
PlatformPluginDirectorySubmissionCreated object{ type: "platform_plugin_directory_submission_created", actor, plugin_name, 5 more }
A plugin directory submission was created on the API platform. A plugin directory submission is a request to list a plugin in the public plugin directory.
PlatformPluginDirectorySubmissionDeleted object{ type: "platform_plugin_directory_submission_deleted", actor, submission_id, 4 more }
A plugin directory submission was deleted on the API platform.
PlatformPluginDirectorySubmissionUpdated object{ type: "platform_plugin_directory_submission_updated", actor, status, 5 more }
A plugin directory submission was updated on the API platform.
PlatformServiceAccountArchived object{ type: "platform_service_account_archived", actor, service_account_id, 4 more }
A service account was archived.
PlatformServiceAccountCreated object{ type: "platform_service_account_created", actor, organization_role, 5 more }
A service account was created.
PlatformServiceAccountUpdated object{ type: "platform_service_account_updated", actor, service_account_id, 5 more }
A service account was updated.
PlatformServiceAccountWorkspaceMemberAdded object{ type: "platform_service_account_workspace_member_added", actor, service_account_id, 6 more }
A service account was added as a member of a workspace.
PlatformServiceAccountWorkspaceMemberRemoved object{ type: "platform_service_account_workspace_member_removed", actor, service_account_id, 5 more }
A service account was removed from a workspace.
PlatformServiceAccountWorkspaceMemberUpdated object{ type: "platform_service_account_workspace_member_updated", actor, service_account_id, 6 more }
A service account's workspace membership role was updated.
PlatformSigningKeyCreated object{ type: "platform_signing_key_created", actor, algorithm, 7 more }
Activity logged when a new request-signing key is registered for the org.
PlatformSigningKeyDeleted object{ type: "platform_signing_key_deleted", actor, algorithm, 7 more }
Activity logged when a signing key is permanently deleted.
PlatformSigningKeyRotated object{ type: "platform_signing_key_rotated", actor, algorithm, 7 more }
Activity logged when an in-memory signing key is rotated.
PlatformSkillVersionContentDownloaded object{ type: "platform_skill_version_content_downloaded", actor, skill_id, 5 more }
The content of a skill version was downloaded through the Skills API.
PlatformSkillVersionCreated object{ type: "platform_skill_version_created", actor, skill_id, 5 more }
Activity logged when a skill version is created via POST /v1/skills/{skill_id}/versions.
PlatformSkillVersionDeleted object{ type: "platform_skill_version_deleted", actor, skill_id, 5 more }
Activity logged when a skill version is deleted via DELETE /v1/skills/{skill_id}/versions/{version}.
PlatformSpendLimitAlertEmailsUpdated object{ type: "platform_spend_limit_alert_emails_updated", actor, id, 5 more }
Spend limit alert email addresses and role targets were updated for an org.
PlatformSpendLimitCreated object{ type: "platform_spend_limit_created", actor, id, 5 more }
An org-level fixed-dollar spend limit was created.
PlatformSpendLimitDeleted object{ type: "platform_spend_limit_deleted", actor, id, 4 more }
An org-level spend limit was removed.
PlatformSpendLimitUpdated object{ type: "platform_spend_limit_updated", actor, id, 5 more }
An org-level spend limit snooze/ignore state was changed.
PlatformUsageReportClaudeCodeViewed object{ type: "platform_usage_report_claude_code_viewed", actor, id, 3 more }
The Claude Code usage report was viewed.
PlatformUsageReportMessagesViewed object{ type: "platform_usage_report_messages_viewed", actor, id, 3 more }
The messages usage report was viewed.
PlatformWorkspaceArchived object{ type: "platform_workspace_archived", actor, workspace_id, 4 more }
A workspace was archived.
PlatformWorkspaceCreated object{ type: "platform_workspace_created", actor, workspace_id, 10 more }
A workspace was created.
PlatformWorkspaceInferenceDataRetentionDisabled object{ type: "platform_workspace_inference_data_retention_disabled", actor, workspace_id, 5 more }
The zero data retention override was disabled for a workspace.
PlatformWorkspaceInferenceDataRetentionEnabled object{ type: "platform_workspace_inference_data_retention_enabled", actor, workspace_id, 5 more }
The zero data retention override was enabled for a workspace.
PlatformWorkspaceMemberAdded object{ type: "platform_workspace_member_added", actor, user_id, 5 more }
A member was added to a workspace.
PlatformWorkspaceMemberRemoved object{ type: "platform_workspace_member_removed", actor, user_id, 5 more }
A member was removed from a workspace.
PlatformWorkspaceMemberUpdated object{ type: "platform_workspace_member_updated", actor, user_id, 6 more }
A workspace member was updated.
PlatformWorkspaceMemberViewed object{ type: "platform_workspace_member_viewed", actor, user_id, 5 more }
A workspace member was viewed.
PlatformWorkspaceMembersListed object{ type: "platform_workspace_members_listed", actor, workspace_id, 4 more }
Workspace members were listed.
PlatformWorkspaceRateLimitDeleted object{ type: "platform_workspace_rate_limit_deleted", actor, limiter_type, 6 more }
A workspace rate limit was deleted.
PlatformWorkspaceRateLimitUpdated object{ type: "platform_workspace_rate_limit_updated", actor, limiter_type, 7 more }
A workspace rate limit was created or updated.
PlatformWorkspaceUpdated object{ type: "platform_workspace_updated", actor, workspace_id, 5 more }
A workspace was updated.
ClaudePluginCreated object{ type: "claude_plugin_created", actor, id, 5 more }
Plugin was created.
ClaudePluginDeleted object{ type: "claude_plugin_deleted", actor, id, 5 more }
Plugin was deleted.
ClaudePluginDisabled object{ type: "claude_plugin_disabled", actor, id, 6 more }
User disabled a plugin for their account.
ClaudePluginEnabled object{ type: "claude_plugin_enabled", actor, id, 6 more }
User enabled a plugin for their account.
PluginInstallationPreferenceUpdated object{ type: "plugin_installation_preference_updated", actor, marketplace_id, 11 more }
An org admin changed the installation preference for a plugin.
ClaudePluginReplaced object{ type: "claude_plugin_replaced", actor, id, 5 more }
Plugin was replaced.
ClaudePluginSecurityScanCompleted object{ type: "claude_plugin_security_scan_completed", actor, scan_id, 8 more }
A security scan of a plugin completed and produced a verdict.
ClaudePluginUpdated object{ type: "claude_plugin_updated", actor, id, 5 more }
Plugin was updated.
PrepaidAutoRechargeDisabled object{ type: "prepaid_auto_recharge_disabled", actor, id, 3 more }
Auto-recharge was disabled for API prepaid org.
PrepaidAutoRechargeUpdated object{ type: "prepaid_auto_recharge_updated", actor, id, 5 more }
Auto-recharge settings were updated for API prepaid org.
PrepaidExtraUsageAutoReloadDisabled object{ type: "prepaid_extra_usage_auto_reload_disabled", actor, id, 3 more }
Prepaid usage credit auto-reload was disabled.
PrepaidExtraUsageAutoReloadEnabled object{ type: "prepaid_extra_usage_auto_reload_enabled", actor, id, 3 more }
Prepaid usage credit auto-reload was enabled.
PrepaidExtraUsageAutoReloadSettingsUpdated object{ type: "prepaid_extra_usage_auto_reload_settings_updated", actor, id, 3 more }
Prepaid usage credit auto-reload settings were updated.
PrimaryOwnerTransferred object{ type: "primary_owner_transferred", actor, new_owner_id, 5 more }
Primary owner role was transferred to another org member.
ClaudeProjectArchived object{ type: "claude_project_archived", actor, claude_project_id, 4 more }
A Claude project was archived.
ClaudeProjectCreated object{ type: "claude_project_created", actor, claude_project_id, 4 more }
A Claude project was created.
ClaudeProjectDeleted object{ type: "claude_project_deleted", actor, claude_project_id, 4 more }
A Claude project was deleted.
ClaudeProjectDocumentAccessFailed object{ type: "claude_project_document_access_failed", actor, claude_project_id, 6 more }
An attempt to access a document in a Claude project failed.
ClaudeProjectDocumentBulkDeletionAuditTruncated object{ type: "claude_project_document_bulk_deletion_audit_truncated", actor, audited_count, 6 more }
A bulk request to delete documents from a Claude project failed with more documents requested than were individually recorded in the audit log.
ClaudeProjectDocumentDeleted object{ type: "claude_project_document_deleted", actor, claude_project_document_id, 6 more }
A document was deleted from a Claude project.
ClaudeProjectDocumentDeletionFailed object{ type: "claude_project_document_deletion_failed", actor, claude_project_id, 6 more }
A request to delete a document from a Claude project failed.
ClaudeProjectDocumentUpdated object{ type: "claude_project_document_updated", actor, claude_project_document_id, 6 more }
The content of a document in a Claude project was replaced in place.
ClaudeProjectDocumentUploaded object{ type: "claude_project_document_uploaded", actor, claude_project_document_id, 6 more }
A document was uploaded to a Claude project.
ClaudeProjectDocumentViewed object{ type: "claude_project_document_viewed", actor, claude_project_document_id, 6 more }
A document in a Claude project was viewed.
ClaudeProjectFileAccessFailed object{ type: "claude_project_file_access_failed", actor, claude_file_id, 5 more }
An attempt to access a file in a Claude project failed.
ClaudeProjectFileBulkDeletionAuditTruncated object{ type: "claude_project_file_bulk_deletion_audit_truncated", actor, audited_count, 6 more }
A bulk request to delete files from a Claude project failed with more files requested than were individually recorded in the audit log.
ClaudeProjectFileDeleted object{ type: "claude_project_file_deleted", actor, claude_file_id, 5 more }
A file was deleted from a Claude project.
ClaudeProjectFileDeletionFailed object{ type: "claude_project_file_deletion_failed", actor, claude_project_id, 5 more }
A request to delete a file from a Claude project failed.
ClaudeProjectFileUploaded object{ type: "claude_project_file_uploaded", actor, claude_file_id, 6 more }
A file was uploaded to a Claude project.
ClaudeProjectReported object{ type: "claude_project_reported", actor, claude_project_id, 4 more }
A Claude project was reported.
ClaudeProjectSharingUpdated object{ type: "claude_project_sharing_updated", actor, audience, 5 more }
A Claude project's sharing settings were updated.
ClaudeProjectViewed object{ type: "claude_project_viewed", actor, claude_project_id, 5 more }
A Claude project was viewed.
ClaudePubsecIdentityConfigured object{ type: "claude_pubsec_identity_configured", actor, idp_saml_config_updated, 6 more }
SAML IdP configuration updated for a public sector organization.
RbacRoleAssigned object{ type: "rbac_role_assigned", actor, principal_id, 6 more }
Admin assigned an RBAC custom role to a principal.
RbacRoleCreated object{ type: "rbac_role_created", actor, role_id, 5 more }
Admin created an RBAC custom role.
RbacRoleDeleted object{ type: "rbac_role_deleted", actor, role_id, 4 more }
Admin deleted an RBAC custom role.
RbacRoleGrantUpdated object{ type: "rbac_role_grant_updated", action, actor, 6 more }
Admin requested a capability grant for an RBAC custom role, or removed it.
Records the admin's change to the role. Whether the grant is currently in effect on the role is reported separately.
RbacRolePermissionAdded object{ type: "rbac_role_permission_added", action, actor, 7 more }
Admin added a permission to an RBAC custom role.
Emitted once per requested permission, including permissions the role already had, so a retried request still produces a complete audit record.
RbacRolePermissionRemoved object{ type: "rbac_role_permission_removed", action, actor, 7 more }
Admin removed a permission from an RBAC custom role.
Emitted once per requested permission, including permissions the role already lacked, so a retried request still produces a complete audit record.
RbacRoleUnassigned object{ type: "rbac_role_unassigned", actor, principal_id, 6 more }
Admin unassigned an RBAC custom role from a principal.
RbacRoleUpdated object{ type: "rbac_role_updated", actor, role_id, 4 more }
Admin updated an RBAC custom role.
RoleAssignmentGranted object{ type: "role_assignment_granted", actor, id, 9 more }
Role assignment was granted.
RoleAssignmentRevoked object{ type: "role_assignment_revoked", actor, id, 9 more }
Role assignment was revoked.
SSOLoginFailed object{ type: "sso_login_failed", actor, id, 3 more }
An SSO sign-in attempt failed.
SSOLoginInitiated object{ type: "sso_login_initiated", actor, id, 3 more }
A user started an SSO sign-in flow.
SSOLoginSucceeded object{ type: "sso_login_succeeded", actor, id, 5 more }
A user successfully signed in with SSO.
SSOSecondFactorMagicLink object{ type: "sso_second_factor_magic_link", actor, id, 3 more }
SSO second factor magic link was used.
ScimUserCreated object{ type: "scim_user_created", actor, user_id, 4 more }
A SCIM user was provisioned.
ScimUserDeleted object{ type: "scim_user_deleted", actor, user_id, 4 more }
A SCIM user was deleted.
ScimUserUpdated object{ type: "scim_user_updated", actor, user_id, 4 more }
A SCIM user was updated.
ScopedAPIKeyDeleted object{ type: "scoped_api_key_deleted", actor, api_key_id, 6 more }
A scoped API key was deleted.
ScopedAPIKeyUpdated object{ type: "scoped_api_key_updated", actor, api_key_id, 5 more }
A scoped API key was renamed or its activation state changed.
SeatTierChangesCancelled object{ type: "seat_tier_changes_cancelled", actor, id, 3 more }
Scheduled seat tier downgrades were cancelled.
SeatTiersPurchased object{ type: "seat_tiers_purchased", actor, id, 4 more }
Seat tiers were purchased or upgraded on a subscription.
ServiceCreated object{ type: "service_created", actor, service_name, 4 more }
Activity logged when an org service is explicitly created.
ServiceDeleted object{ type: "service_deleted", actor, service_name, 4 more }
Activity logged when an org service is deleted.
ServiceKeyCreated object{ type: "service_key_created", actor, is_service_created, 8 more }
Activity logged when a new org service key is created.
ServiceKeyRevoked object{ type: "service_key_revoked", actor, service_key_id, 5 more }
Activity logged when an org service key is revoked.
SessionRevoked object{ type: "session_revoked", actor, id, 3 more }
User revoked a specific session.
SessionShareAccessed object{ type: "session_share_accessed", actor, id, 4 more }
Session share was accessed.
SessionShareCreated object{ type: "session_share_created", actor, id, 5 more }
Session share was created.
SessionShareRevoked object{ type: "session_share_revoked", actor, id, 5 more }
Session share was revoked.
ClaudeSkillCreated object{ type: "claude_skill_created", actor, id, 8 more }
Skill was created.
ClaudeSkillDeleted object{ type: "claude_skill_deleted", actor, id, 10 more }
Skill was deleted.
ClaudeSkillDisabled object{ type: "claude_skill_disabled", actor, id, 5 more }
User disabled a skill for their account.
ClaudeSkillEnabled object{ type: "claude_skill_enabled", actor, id, 5 more }
User enabled a skill for their account.
ClaudeSkillReplaced object{ type: "claude_skill_replaced", actor, id, 8 more }
Skill was replaced.
ClaudeSkillSecurityScanCompleted object{ type: "claude_skill_security_scan_completed", actor, scan_id, 8 more }
A security scan of a skill completed and produced a verdict.
SlackWorkspaceClaimRevoked object{ type: "slack_workspace_claim_revoked", actor, slack_team_id, 5 more }
A Slack workspace or Enterprise Grid organization was disconnected from the organization for Claude in Slack.
SlackWorkspaceClaimed object{ type: "slack_workspace_claimed", actor, slack_team_id, 5 more }
A Slack workspace or Enterprise Grid organization was connected to the organization for Claude in Slack.
SocialLoginSucceeded object{ type: "social_login_succeeded", actor, provider, 6 more }
A user successfully signed in with a social identity provider (Google, Apple, or Microsoft).
StepUpAuthenticationFailed object{ type: "step_up_authentication_failed", actor, method, 6 more }
An additional identity check failed.
StepUpAuthenticationSucceeded object{ type: "step_up_authentication_succeeded", actor, method, 5 more }
The user completed an additional identity check to confirm a sensitive action.
StepUpCredentialEnrolled object{ type: "step_up_credential_enrolled", actor, credential_id, 4 more }
A user enrolled a passkey for confirming sensitive actions on their account.
SubscriptionCancellationScheduled object{ type: "subscription_cancellation_scheduled", actor, id, 3 more }
Subscription cancellation was scheduled at end of billing period.
SubscriptionQuantityUpdated object{ type: "subscription_quantity_updated", actor, added_seats, 6 more }
Contracted subscription seat quantity was updated.
SubscriptionRenewed object{ type: "subscription_renewed", actor, id, 5 more }
A cancelled subscription was renewed.
SubscriptionResumed object{ type: "subscription_resumed", actor, id, 3 more }
A scheduled subscription cancellation was reversed.
SubscriptionStarted object{ type: "subscription_started", actor, id, 6 more }
A new subscription was created (Team or Enterprise).
SubscriptionUpgraded object{ type: "subscription_upgraded", actor, id, 5 more }
Subscription plan was upgraded (e.g. Team to Enterprise).
TrustedDeviceCredentialRotated object{ type: "trusted_device_credential_rotated", actor, trusted_device_id, 4 more }
The identity-verification credential of a trusted device was rotated to a new key.
TrustedDeviceEnrolled object{ type: "trusted_device_enrolled", actor, enrollment_method, 6 more }
A device was enrolled as a trusted device for the user's account. Trusted devices can be used to confirm the user's identity for sensitive actions.
TrustedDeviceRevoked object{ type: "trusted_device_revoked", actor, reason, 6 more }
A trusted device was removed from the user's account.
TunnelArchived object{ type: "tunnel_archived", actor, tunnel_id, 4 more }
An MCP tunnel was archived.
TunnelCertificateAdded object{ type: "tunnel_certificate_added", actor, certificate_id, 6 more }
An inner-TLS CA certificate was added to a tunnel.
TunnelCertificateRevoked object{ type: "tunnel_certificate_revoked", actor, certificate_id, 6 more }
An inner-TLS CA certificate was revoked from a tunnel.
TunnelCreated object{ type: "tunnel_created", actor, tunnel_id, 5 more }
An MCP tunnel was created.
TunnelTokenMinted object{ type: "tunnel_token_minted", actor, token_id, 5 more }
An OAuth bearer token for the tunnel management API was minted.
TunnelTokenRevealed object{ type: "tunnel_token_revealed", actor, tunnel_id, 5 more }
The Cloudflare connector secret for a tunnel was revealed to the caller.
TunnelTokenRevoked object{ type: "tunnel_token_revoked", actor, token_id, 5 more }
An OAuth bearer token for the tunnel management API was revoked.
TunnelTokenRotated object{ type: "tunnel_token_rotated", actor, tunnel_id, 6 more }
The Cloudflare connector secret for a tunnel was rotated.
`tunnel_token_id` is the id of the *newly-issued* token. The previous token is invalidated by the rotation and its id is not recorded here.
UserConsentRecorded object{ type: "user_consent_recorded", actor, consent_type, 6 more }
User granted a consent for a specific entity (e.g. consumer health consent for an MCP server).
UserConsentRevoked object{ type: "user_consent_revoked", actor, id, 7 more }
User revoked a previously granted consent for a specific entity.
ClaudeUserRoleUpdated object{ type: "claude_user_role_updated", actor, user_email, 7 more }
A user's role within the organization was changed, or the user was added to or removed from the organization.
ClaudeUserSettingsUpdated object{ type: "claude_user_settings_updated", actor, updates, 4 more }
User updated their personal settings.
VerificationEvidenceSubmitted object{ type: "verification_evidence_submitted", actor, verification_id, 5 more }
Verification evidence was submitted for an organization's verification.
VerificationProgramApplicationCreated object{ type: "verification_program_application_created", actor, program_slug, 4 more }
An organization applied to a verification program.
WorkspaceMemberSpendLimitCreated object{ type: "workspace_member_spend_limit_created", actor, id, 7 more }
A per-member or workspace-default Claude Code spend limit was created.
WorkspaceMemberSpendLimitDeleted object{ type: "workspace_member_spend_limit_deleted", actor, id, 6 more }
A per-member or workspace-default Claude Code spend limit was deleted.
WorkspaceMemberSpendLimitUpdated object{ type: "workspace_member_spend_limit_updated", actor, id, 7 more }
A per-member Claude Code spend limit amount was updated.
WorkspaceSpendLimitAlertEmailsUpdated object{ type: "workspace_spend_limit_alert_emails_updated", actor, id, 5 more }
Spend limit alert email recipients were updated for a workspace.
WorkspaceSpendLimitCreated object{ type: "workspace_spend_limit_created", actor, id, 6 more }
A workspace-level API spend limit was created.
WorkspaceSpendLimitDeleted object{ type: "workspace_spend_limit_deleted", actor, id, 5 more }
A workspace-level API spend limit was deleted.
first_id: optional string or null
has_more: optional boolean
defaultfalse
last_id: optional string or null
Query compliance activities
cURL
```python
curl https://api.anthropic.com/v1/compliance/activities \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
```
Response 200
```python
{
"data": [
{
"actor": {
"api_key_id": "api_key_id",
"ip_address": "ip_address",
"user_agent": "user_agent",
"type": "api_actor"
},
"decision": "blocked",
"id": "id",
"abuse_session_id": "abuse_session_id",
"created_at": "2019-12-27T18:11:19.117Z",
"organization_id": "organization_id",
"organization_uuid": "organization_uuid",
"type": "abuse_decision_received"
}
],
"first_id": "first_id",
"has_more": true,
"last_id": "last_id"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"actor": {
"api_key_id": "api_key_id",
"ip_address": "ip_address",
"user_agent": "user_agent",
"type": "api_actor"
},
"decision": "blocked",
"id": "id",
"abuse_session_id": "abuse_session_id",
"created_at": "2019-12-27T18:11:19.117Z",
"organization_id": "organization_id",
"organization_uuid": "organization_uuid",
"type": "abuse_decision_received"
---
## Activities - Claude API Reference
Source: https://platform.claude.com/docs/en/api/compliance/activities
Path: 04-API-Reference/Admin/compliance-activities.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fcompliance%2Factivities)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Query compliance activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
To enable the Compliance API, see the setup guide.
[Set up the Compliance API](../Other/manage-claude-compliance-api-access.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Compliance API](../Endpoints/http-compliance.md)
# Activities
Copy page
##### [Query compliance activities](https://platform.claude.com/docs/en/api/http/compliance/activities/list)
GET/v1/compliance/activities
List compliance activities for the authenticated tenant.
##### Models
ActivityListResponse = AbuseDecisionReceived or AccountDeleted or AdminAPIKeyCreated or 533 more
---
## Download artifact content - Claude API Reference
Source: https://platform.claude.com/docs/en/api/compliance/apps/artifacts/download
Path: 04-API-Reference/Admin/compliance-apps-artifacts-download.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fcompliance%2Fapps%2Fartifacts%2Fdownload)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Chats
Projects
Artifacts
Get artifact metadata
Download artifact content
Sessions
Code
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
To enable the Compliance API, see the setup guide.
[Set up the Compliance API](../Other/manage-claude-compliance-api-access.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Compliance API](../Endpoints/http-compliance.md)
3. [Apps](https://platform.claude.com/docs/en/api/http/compliance/apps)
4. [Artifacts](https://platform.claude.com/docs/en/api/http/compliance/apps/artifacts)
# Download artifact content
Copy page
GET/v1/compliance/apps/artifacts/{artifact_version_id}/content
Download the content of an artifact version for compliance purposes.
Returns the full text content of the artifact version.
##### Path parameters
artifact_version_id: string
The artifact version ID (tagged ID, e.g., claude_artifact_version_abc123)
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"x-api-key": optional string
Download artifact content
cURL
```python
curl https://api.anthropic.com/v1/compliance/apps/artifacts/$ARTIFACT_VERSION_ID/content \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
---
## Get artifact metadata - Claude API Reference
Source: https://platform.claude.com/docs/en/api/compliance/apps/artifacts/retrieve
Path: 04-API-Reference/Admin/compliance-apps-artifacts-retrieve.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fcompliance%2Fapps%2Fartifacts%2Fretrieve)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Chats
Projects
Artifacts
Get artifact metadata
Download artifact content
Sessions
Code
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
To enable the Compliance API, see the setup guide.
[Set up the Compliance API](../Other/manage-claude-compliance-api-access.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Compliance API](../Endpoints/http-compliance.md)
3. [Apps](https://platform.claude.com/docs/en/api/http/compliance/apps)
4. [Artifacts](https://platform.claude.com/docs/en/api/http/compliance/apps/artifacts)
# Get artifact metadata
Copy page
GET/v1/compliance/apps/artifacts/{artifact_version_id}
Returns metadata for an artifact version, without the content body.
Use the sibling `/content` endpoint to fetch the artifact text. The `md5` and `size_bytes` fields here are computed over the UTF-8 encoding of that text, so a DLP consumer can dedupe or match hashes without downloading every artifact.
##### Path parameters
artifact_version_id: string
The artifact version ID (tagged ID, e.g., claude_artifact_version_abc123)
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"x-api-key": optional string
##### Returns
id: string
Artifact ID e.g. 'claude_artifact_abc123'
artifact_type: string or null
MIME-like artifact type e.g. 'application/vnd.ant.code'
claude_chat_id: string
The chat this artifact belongs to
created_at: string
Artifact version creation timestamp
formatdate-time
md5: string
Lowercase hex MD5 of the artifact content (UTF-8 encoded). Matches the `content` field returned by the sibling `/content` endpoint.
size_bytes: number
Size in bytes of the artifact content (UTF-8 encoded)
title: string or null
Artifact title
version_id: string
Artifact version ID e.g. 'claude_artifact_version_abc123'
Get artifact metadata
cURL
```python
curl https://api.anthropic.com/v1/compliance/apps/artifacts/$ARTIFACT_VERSION_ID \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
```
Response 200
```python
{
"id": "id",
"artifact_type": "artifact_type",
"claude_chat_id": "claude_chat_id",
"created_at": "2019-12-27T18:11:19.117Z",
"md5": "md5",
"size_bytes": 0,
"title": "title",
"version_id": "version_id"
}
```
##### Returns Examples
Response 200
```python
{
"id": "id",
"artifact_type": "artifact_type",
"claude_chat_id": "claude_chat_id",
"created_at": "2019-12-27T18:11:19.117Z",
---
## Artifacts - Claude API Reference
Source: https://platform.claude.com/docs/en/api/compliance/apps/artifacts
Path: 04-API-Reference/Admin/compliance-apps-artifacts.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fcompliance%2Fapps%2Fartifacts)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Chats
Projects
Artifacts
Get artifact metadata
Download artifact content
Sessions
Code
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
To enable the Compliance API, see the setup guide.
[Set up the Compliance API](../Other/manage-claude-compliance-api-access.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Compliance API](../Endpoints/http-compliance.md)
3. [Apps](https://platform.claude.com/docs/en/api/http/compliance/apps)
# Artifacts
Copy page
##### [Get artifact metadata](https://platform.claude.com/docs/en/api/http/compliance/apps/artifacts/retrieve)
GET/v1/compliance/apps/artifacts/{artifact_version_id}
Returns metadata for an artifact version, without the content body.
##### [Download artifact content](https://platform.claude.com/docs/en/api/http/compliance/apps/artifacts/download)
GET/v1/compliance/apps/artifacts/{artifact_version_id}/content
Download the content of an artifact version for compliance purposes.
##### Models
ArtifactRetrieveResponse object{ id, artifact_type, claude_chat_id, 5 more }
Artifact version metadata for GET /v1/compliance/apps/artifacts/{artifact_version_id}.
Returns metadata only. Use the sibling `/content` endpoint to fetch the artifact body.
id: string
Artifact ID e.g. 'claude_artifact_abc123'
artifact_type: string or null
MIME-like artifact type e.g. 'application/vnd.ant.code'
claude_chat_id: string
The chat this artifact belongs to
created_at: string
Artifact version creation timestamp
formatdate-time
md5: string
Lowercase hex MD5 of the artifact content (UTF-8 encoded). Matches the `content` field returned by the sibling `/content` endpoint.
size_bytes: number
Size in bytes of the artifact content (UTF-8 encoded)
title: string or null
Artifact title
version_id: string
Artifact version ID e.g. 'claude_artifact_version_abc123'
---
## Delete chat - Claude API Reference
Source: https://platform.claude.com/docs/en/api/compliance/apps/chats/delete
Path: 04-API-Reference/Admin/compliance-apps-chats-delete.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fcompliance%2Fapps%2Fchats%2Fdelete)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Chats
List chats
Delete chat
Messages
Files
Generated Files
Projects
Artifacts
Sessions
Code
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
To enable the Compliance API, see the setup guide.
[Set up the Compliance API](../Other/manage-claude-compliance-api-access.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Compliance API](../Endpoints/http-compliance.md)
3. [Apps](https://platform.claude.com/docs/en/api/http/compliance/apps)
4. [Chats](https://platform.claude.com/docs/en/api/http/compliance/apps/chats)
# Delete chat
Copy page
DELETE/v1/compliance/apps/chats/{claude_chat_id}
Permanently deletes a chat and all associated messages and files. This is a destructive operation that cannot be undone.
A chat's remote sessions are deleted first. If that deletion cannot be confirmed, the request returns a 503 with error code `chat_delete_remote_sessions_unconfirmed` and leaves the chat unchanged. You can retry the request.
##### Path parameters
claude_chat_id: string
The chat ID (tagged ID, e.g., claude_chat_abc123)
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"x-api-key": optional string
##### Returns
type: optional "claude_chat_deleted"
Constant string confirming deletion
defaultclaude_chat_deleted
id: string
The ID of the Claude chat that was deleted
Delete chat
cURL
```python
curl https://api.anthropic.com/v1/compliance/apps/chats/$CLAUDE_CHAT_ID \
-X DELETE \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
---
## Delete file - Claude API Reference
Source: https://platform.claude.com/docs/en/api/compliance/apps/chats/files/delete
Path: 04-API-Reference/Admin/compliance-apps-chats-files-delete.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fcompliance%2Fapps%2Fchats%2Ffiles%2Fdelete)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Chats
List chats
Delete chat
Messages
Files
Get file metadata
Delete file
Download file content
Generated Files
Projects
Artifacts
Sessions
Code
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
To enable the Compliance API, see the setup guide.
[Set up the Compliance API](../Other/manage-claude-compliance-api-access.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Compliance API](../Endpoints/http-compliance.md)
3. [Apps](https://platform.claude.com/docs/en/api/http/compliance/apps)
4. [Chats](https://platform.claude.com/docs/en/api/http/compliance/apps/chats)
5. [Files](https://platform.claude.com/docs/en/api/http/compliance/apps/chats/files)
# Delete file
Copy page
DELETE/v1/compliance/apps/chats/files/{claude_file_id}
Permanently deletes a specific file. This is a destructive operation that cannot be undone.
##### Path parameters
claude_file_id: string
The file ID (tagged ID, e.g., claude_file_abc123)
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"x-api-key": optional string
##### Returns
type: optional "claude_file_deleted"
Constant string confirming deletion
defaultclaude_file_deleted
id: string
The ID of the file that was deleted
Delete file
cURL
```python
curl https://api.anthropic.com/v1/compliance/apps/chats/files/$CLAUDE_FILE_ID \
-X DELETE \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
---
## Download file content - Claude API Reference
Source: https://platform.claude.com/docs/en/api/compliance/apps/chats/files/download
Path: 04-API-Reference/Admin/compliance-apps-chats-files-download.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fcompliance%2Fapps%2Fchats%2Ffiles%2Fdownload)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Chats
List chats
Delete chat
Messages
Files
Get file metadata
Delete file
Download file content
Generated Files
Projects
Artifacts
Sessions
Code
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
To enable the Compliance API, see the setup guide.
[Set up the Compliance API](../Other/manage-claude-compliance-api-access.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Compliance API](../Endpoints/http-compliance.md)
3. [Apps](https://platform.claude.com/docs/en/api/http/compliance/apps)
4. [Chats](https://platform.claude.com/docs/en/api/http/compliance/apps/chats)
5. [Files](https://platform.claude.com/docs/en/api/http/compliance/apps/chats/files)
# Download file content
Copy page
GET/v1/compliance/apps/chats/files/{claude_file_id}/content
Downloads the binary content of a file referenced in chat messages.
##### Path parameters
claude_file_id: string
The file ID (tagged ID, e.g., claude_file_abc123)
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"x-api-key": optional string
Download file content
cURL
```python
curl https://api.anthropic.com/v1/compliance/apps/chats/files/$CLAUDE_FILE_ID/content \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
---
## Get file metadata - Claude API Reference
Source: https://platform.claude.com/docs/en/api/compliance/apps/chats/files/retrieve
Path: 04-API-Reference/Admin/compliance-apps-chats-files-retrieve.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fcompliance%2Fapps%2Fchats%2Ffiles%2Fretrieve)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Chats
List chats
Delete chat
Messages
Files
Get file metadata
Delete file
Download file content
Generated Files
Projects
Artifacts
Sessions
Code
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
To enable the Compliance API, see the setup guide.
[Set up the Compliance API](../Other/manage-claude-compliance-api-access.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Compliance API](../Endpoints/http-compliance.md)
3. [Apps](https://platform.claude.com/docs/en/api/http/compliance/apps)
4. [Chats](https://platform.claude.com/docs/en/api/http/compliance/apps/chats)
5. [Files](https://platform.claude.com/docs/en/api/http/compliance/apps/chats/files)
# Get file metadata
Copy page
GET/v1/compliance/apps/chats/files/{claude_file_id}
Retrieves metadata for a file referenced in chat messages, without downloading the file content. Use the sibling `/content` endpoint to download the bytes.
##### Path parameters
claude_file_id: string
The file ID (tagged ID, e.g., claude_file_abc123)
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"x-api-key": optional string
##### Returns
id: string
File ID
claude_chat_ids: array of string
Chats this file is attached to. A file can be referenced by messages across multiple chats.
created_at: string
File creation timestamp
formatdate-time
filename: string or null
Display name of the file, if set
md5: string or null
Lowercase hex MD5 of the file's preferred downloadable variant, as recorded at upload time. Null when no stored hash is available. The sibling `/content` endpoint also sets a `Content-MD5` header (base64 per RFC 1864) computed over the exact served bytes; when the two disagree, the header is authoritative.
message_ids: array of string
Chat message IDs this file is attached to. A file can be referenced by multiple messages.
mime_type: string or null
MIME type of the file's preferred downloadable variant (e.g. 'application/pdf'). May be null for files with no downloadable content (e.g. code-interpreter outputs).
size_bytes: number or null
Size in bytes of the file's preferred downloadable variant, if known
Get file metadata
cURL
```python
curl https://api.anthropic.com/v1/compliance/apps/chats/files/$CLAUDE_FILE_ID \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
```
Response 200
```python
{
"id": "claude_file_xyz789",
"filename": "quarterly_report.pdf",
"mime_type": "application/pdf",
"size_bytes": 1048576,
"md5": "5d41402abc4b2a76b9719d911017c592",
"created_at": "2024-01-15T10:30:00Z",
"message_ids": [
"claude_chat_msg_abc123"
],
"claude_chat_ids": [
"claude_chat_def456"
]
}
```
##### Returns Examples
Response 200
```python
{
"id": "claude_file_xyz789",
"filename": "quarterly_report.pdf",
"mime_type": "application/pdf",
"size_bytes": 1048576,
"md5": "5d41402abc4b2a76b9719d911017c592",
"created_at": "2024-01-15T10:30:00Z",
---
## Files - Claude API Reference
Source: https://platform.claude.com/docs/en/api/compliance/apps/chats/files
Path: 04-API-Reference/Admin/compliance-apps-chats-files.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fcompliance%2Fapps%2Fchats%2Ffiles)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Chats
List chats
Delete chat
Messages
Files
Get file metadata
Delete file
Download file content
Generated Files
Projects
Artifacts
Sessions
Code
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
To enable the Compliance API, see the setup guide.
[Set up the Compliance API](../Other/manage-claude-compliance-api-access.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Compliance API](../Endpoints/http-compliance.md)
3. [Apps](https://platform.claude.com/docs/en/api/http/compliance/apps)
4. [Chats](https://platform.claude.com/docs/en/api/http/compliance/apps/chats)
# Files
Copy page
##### [Get file metadata](https://platform.claude.com/docs/en/api/http/compliance/apps/chats/files/retrieve)
GET/v1/compliance/apps/chats/files/{claude_file_id}
Retrieves metadata for a file referenced in chat messages, without downloading the file content. Use the sibling `/content` endpoint to download the bytes.
##### [Delete file](https://platform.claude.com/docs/en/api/http/compliance/apps/chats/files/delete)
DELETE/v1/compliance/apps/chats/files/{claude_file_id}
Permanently deletes a specific file. This is a destructive operation that cannot be undone.
##### [Download file content](https://platform.claude.com/docs/en/api/http/compliance/apps/chats/files/download)
GET/v1/compliance/apps/chats/files/{claude_file_id}/content
Downloads the binary content of a file referenced in chat messages.
##### Models
FileRetrieveResponse object{ id, claude_chat_ids, created_at, 5 more }
File metadata for GET /v1/compliance/apps/chats/files/{claude_file_id}.
Returns metadata only. Use the sibling `/content` endpoint to download the file bytes.
id: string
File ID
claude_chat_ids: array of string
Chats this file is attached to. A file can be referenced by messages across multiple chats.
created_at: string
File creation timestamp
formatdate-time
filename: string or null
Display name of the file, if set
md5: string or null
Lowercase hex MD5 of the file's preferred downloadable variant, as recorded at upload time. Null when no stored hash is available. The sibling `/content` endpoint also sets a `Content-MD5` header (base64 per RFC 1864) computed over the exact served bytes; when the two disagree, the header is authoritative.
message_ids: array of string
Chat message IDs this file is attached to. A file can be referenced by multiple messages.
mime_type: string or null
MIME type of the file's preferred downloadable variant (e.g. 'application/pdf'). May be null for files with no downloadable content (e.g. code-interpreter outputs).
size_bytes: number or null
Size in bytes of the file's preferred downloadable variant, if known
FileDeleteResponse object{ type: "claude_file_deleted", id }
Response for deleting a compliance file.
type: optional "claude_file_deleted"
Constant string confirming deletion
defaultclaude_file_deleted
id: string
The ID of the file that was deleted
---
## Download a Claude-generated file - Claude API Reference
Source: https://platform.claude.com/docs/en/api/compliance/apps/chats/generated_files/download
Path: 04-API-Reference/Admin/compliance-apps-chats-generated-files-download.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fcompliance%2Fapps%2Fchats%2Fgenerated_files%2Fdownload)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Chats
List chats
Delete chat
Messages
Files
Generated Files
Get Claude-generated file metadata
Download a Claude-generated file
Projects
Artifacts
Sessions
Code
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
To enable the Compliance API, see the setup guide.
[Set up the Compliance API](../Other/manage-claude-compliance-api-access.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Compliance API](../Endpoints/http-compliance.md)
3. [Apps](https://platform.claude.com/docs/en/api/http/compliance/apps)
4. [Chats](https://platform.claude.com/docs/en/api/http/compliance/apps/chats)
5. [Generated Files](https://platform.claude.com/docs/en/api/http/compliance/apps/chats/generated_files)
# Download a Claude-generated file
Copy page
GET/v1/compliance/apps/chats/generated-files/{claude_gen_file_id}/content
Downloads the binary content of a file the assistant created via tool use.
##### Path parameters
claude_gen_file_id: string
The generated-file id (e.g., 'claude_gen_file_abc123') as returned in `chat_messages[].generated_files[].id` from GET /apps/chats/{claude_chat_id}/messages.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"x-api-key": optional string
Download a Claude-generated file
cURL
```python
curl https://api.anthropic.com/v1/compliance/apps/chats/generated-files/$CLAUDE_GEN_FILE_ID/content \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
---
## Get Claude-generated file metadata - Claude API Reference
Source: https://platform.claude.com/docs/en/api/compliance/apps/chats/generated_files/retrieve
Path: 04-API-Reference/Admin/compliance-apps-chats-generated-files-retrieve.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fcompliance%2Fapps%2Fchats%2Fgenerated_files%2Fretrieve)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Chats
List chats
Delete chat
Messages
Files
Generated Files
Get Claude-generated file metadata
Download a Claude-generated file
Projects
Artifacts
Sessions
Code
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
To enable the Compliance API, see the setup guide.
[Set up the Compliance API](../Other/manage-claude-compliance-api-access.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Compliance API](../Endpoints/http-compliance.md)
3. [Apps](https://platform.claude.com/docs/en/api/http/compliance/apps)
4. [Chats](https://platform.claude.com/docs/en/api/http/compliance/apps/chats)
5. [Generated Files](https://platform.claude.com/docs/en/api/http/compliance/apps/chats/generated_files)
# Get Claude-generated file metadata
Copy page
GET/v1/compliance/apps/chats/generated-files/{claude_gen_file_id}
Returns metadata for a file the assistant created via tool use.
Use the sibling `/content` endpoint to download the bytes.
##### Path parameters
claude_gen_file_id: string
The generated-file id (e.g., 'claude_gen_file_abc123') as returned in `chat_messages[].generated_files[].id` from GET /apps/chats/{claude_chat_id}/messages.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"x-api-key": optional string
##### Returns
id: string
Opaque generated-file id, e.g. 'claude_gen_file_abc123'.
claude_chat_id: string
The chat this generated file belongs to
created_at: string or null
File creation timestamp, when available
formatdate-time
filename: string
Display name of the generated file
md5: string or null
Lowercase hex MD5 of the stored file. Null when no stored hash is available. The sibling `/content` endpoint also sets a `Content-MD5` header (base64 per RFC 1864) computed over the exact served bytes.
mime_type: string or null
MIME type of the stored file, when available
size_bytes: number or null
Size in bytes of the stored file, when available
Get Claude-generated file metadata
cURL
```python
curl https://api.anthropic.com/v1/compliance/apps/chats/generated-files/$CLAUDE_GEN_FILE_ID \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
```
Response 200
```python
{
"id": "id",
"claude_chat_id": "claude_chat_id",
"created_at": "2019-12-27T18:11:19.117Z",
"filename": "filename",
"md5": "md5",
"mime_type": "mime_type",
"size_bytes": 0
}
```
##### Returns Examples
Response 200
```python
{
"id": "id",
"claude_chat_id": "claude_chat_id",
"created_at": "2019-12-27T18:11:19.117Z",
---
## Generated Files - Claude API Reference
Source: https://platform.claude.com/docs/en/api/compliance/apps/chats/generated_files
Path: 04-API-Reference/Admin/compliance-apps-chats-generated-files.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fcompliance%2Fapps%2Fchats%2Fgenerated_files)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Chats
List chats
Delete chat
Messages
Files
Generated Files
Get Claude-generated file metadata
Download a Claude-generated file
Projects
Artifacts
Sessions
Code
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
To enable the Compliance API, see the setup guide.
[Set up the Compliance API](../Other/manage-claude-compliance-api-access.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Compliance API](../Endpoints/http-compliance.md)
3. [Apps](https://platform.claude.com/docs/en/api/http/compliance/apps)
4. [Chats](https://platform.claude.com/docs/en/api/http/compliance/apps/chats)
# Generated Files
Copy page
##### [Get Claude-generated file metadata](https://platform.claude.com/docs/en/api/http/compliance/apps/chats/generated_files/retrieve)
GET/v1/compliance/apps/chats/generated-files/{claude_gen_file_id}
Returns metadata for a file the assistant created via tool use.
##### [Download a Claude-generated file](https://platform.claude.com/docs/en/api/http/compliance/apps/chats/generated_files/download)
GET/v1/compliance/apps/chats/generated-files/{claude_gen_file_id}/content
Downloads the binary content of a file the assistant created via tool use.
##### Models
GeneratedFileRetrieveResponse object{ id, claude_chat_id, created_at, 4 more }
Metadata for GET /v1/compliance/apps/chats/generated-files/{claude_gen_file_id}.
Returns metadata only. Use the sibling `/content` endpoint to download the bytes. The owning chat is included since the id is opaque; to find the specific message that produced the file, fetch `/v1/compliance/apps/chats/{claude_chat_id}/messages` and match on `generated_files[].id`.
id: string
Opaque generated-file id, e.g. 'claude_gen_file_abc123'.
claude_chat_id: string
The chat this generated file belongs to
created_at: string or null
File creation timestamp, when available
formatdate-time
filename: string
Display name of the generated file
md5: string or null
Lowercase hex MD5 of the stored file. Null when no stored hash is available. The sibling `/content` endpoint also sets a `Content-MD5` header (base64 per RFC 1864) computed over the exact served bytes.
mime_type: string or null
MIME type of the stored file, when available
size_bytes: number or null
Size in bytes of the stored file, when available
---
## List chats - Claude API Reference
Source: https://platform.claude.com/docs/en/api/compliance/apps/chats/list
Path: 04-API-Reference/Admin/compliance-apps-chats-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fcompliance%2Fapps%2Fchats%2Flist)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Chats
List chats
Delete chat
Messages
Files
Generated Files
Projects
Artifacts
Sessions
Code
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
To enable the Compliance API, see the setup guide.
[Set up the Compliance API](../Other/manage-claude-compliance-api-access.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Compliance API](../Endpoints/http-compliance.md)
3. [Apps](https://platform.claude.com/docs/en/api/http/compliance/apps)
4. [Chats](https://platform.claude.com/docs/en/api/http/compliance/apps/chats)
# List chats
Copy page
GET/v1/compliance/apps/chats
Lists chat metadata with filtering capabilities for targeted compliance review. Results are sorted chronologically (time ascending) by the `order_by` key, with ties broken by id.
Incremental polling with `order_by=updated_at` returns a chat again after it receives a new message, is moved into or out of a project, or is deleted in claude.ai. A chat is not guaranteed to be returned again after other edits, such as a rename.
**Deprecation notice:** Combining `user_ids[]` with any `updated_at.*` filter is deprecated and will be rejected with HTTP 400 after 2026-09-22. For incremental polling by update time, omit `user_ids[]` and set `order_by=updated_at` with `after_id` cursor pagination — this returns the same chats across the whole organization in a single request stream. For per-user listing, use `created_at.*` filters (or no time filter) with the default `order_by`. `user_ids[]` with `order_by=updated_at` is already rejected.
##### Query parameters
after_id: optional string
Pagination cursor for retrieving the next page of results. To paginate, pass the `last_id` value from the most recent response. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.
before_id: optional string
Pagination cursor for retrieving the previous page of results. To paginate, pass the `first_id` value from the most recent response. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.
created_at: optional object{ gt, gte, lt, lte }
gt: optional string
Filter chats created after this time (RFC 3339 format)
formatdate-time
gte: optional string
Filter chats created at or after this time (RFC 3339 format)
formatdate-time
lt: optional string
Filter chats created before this time (RFC 3339 format)
formatdate-time
lte: optional string
Filter chats created at or before this time (RFC 3339 format)
formatdate-time
limit: optional number
Maximum results (default: 100, max: 1000)
default100
minimum1
maximum1000
order_by: optional "created_at" or "updated_at"
Sort key for results. `created_at` (default) sorts by chat creation time. `updated_at` sorts by last update time and is only supported for org-wide queries (omit user_ids\[\]). For org-wide queries, any time filter must match the sort key: `created_at.*` filters require `order_by=created_at`, and `updated_at.*` filters require `order_by=updated_at`.
defaultcreated_at
One of the following:
"created_at"
"updated_at"
organization_ids: optional array of string
Filter by organization IDs (accepts `org_...` or organization UUID). Enumerate IDs via `GET /v1/compliance/organizations`.
project_ids: optional array of string
Filter by project IDs (accepts `claude_proj_...`). Enumerate IDs via `GET /v1/compliance/apps/projects`. Requires user_ids\[\]; not supported for org-wide queries.
updated_at: optional object{ gt, gte, lt, lte }
gt: optional string
Filter chats updated after this time (RFC 3339 format). Combining updated_at filters with `user_ids[]` is deprecated and will be rejected after 2026-09-22; for updated_at-windowed polling, omit `user_ids[]` and use `order_by=updated_at` with `after_id` pagination.
formatdate-time
gte: optional string
Filter chats updated at or after this time (RFC 3339 format). Combining updated_at filters with `user_ids[]` is deprecated and will be rejected after 2026-09-22; for updated_at-windowed polling, omit `user_ids[]` and use `order_by=updated_at` with `after_id` pagination.
formatdate-time
lt: optional string
Filter chats updated before this time (RFC 3339 format). Combining updated_at filters with `user_ids[]` is deprecated and will be rejected after 2026-09-22; for updated_at-windowed polling, omit `user_ids[]` and use `order_by=updated_at` with `after_id` pagination.
formatdate-time
lte: optional string
Filter chats updated at or before this time (RFC 3339 format). Combining updated_at filters with `user_ids[]` is deprecated and will be rejected after 2026-09-22; for updated_at-windowed polling, omit `user_ids[]` and use `order_by=updated_at` with `after_id` pagination.
formatdate-time
user_ids: optional array of string
Filter to chats created by specific users (max 10 per request). Omit for an org-wide query. Enumerate IDs via `GET /v1/compliance/organizations/{org_uuid}/users`. Deprecated combination: passing `user_ids[]` together with any `updated_at.*` filter is deprecated and will be rejected after 2026-09-22. For `updated_at`-windowed polling, omit `user_ids[]` and use `order_by=updated_at` with `after_id` pagination.
maxItems10
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"x-api-key": optional string
##### Returns
data: array of object{ id, created_at, deleted_at, 8 more }
List of chat metadata sorted chronologically by the request's `order_by` key (default `created_at`), tie break by id
id: string
Chat ID
created_at: string
Creation timestamp
formatdate-time
deleted_at: string or null
Deletion timestamp if deleted
formatdate-time
href: string
URL to view this chat in claude.ai
model: string or null
Model selected for this chat (e.g. 'claude-opus-5'). May be null for legacy chats that never had a model recorded.
name: string
Chat name. Empty when `deleted_at` is set.
organization_uuid: string
Organization UUID this chat belongs to
project_id: string or null
Project ID this chat belongs to
updated_at: string
Last update timestamp. Updated when the chat receives a new message, is moved into or out of a project, or is deleted in claude.ai. Other edits, such as renaming the chat, are not guaranteed to change it.
formatdate-time
user: object{ id, email_address } or null
The user who created the chat. Null when the API key is restricted to one organization and the creator is no longer a member of it.
id: string
User identifier
email_address: string
User's email address
organization_id: stringDeprecated
Organization ID this chat belongs to
first_id: string or null
Opaque pagination cursor for the first chat in the current result set. Pass as `before_id` on the next request to page backwards. Backward pagination is only supported for per-user queries (`user_ids[]` set); org-wide queries do not accept `before_id`. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.
has_more: boolean
Whether more records exist beyond the current result set
last_id: string or null
Opaque pagination cursor for the last chat in the current result set. Pass as `after_id` on the next request to page forwards. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.
List chats
cURL
```python
curl https://api.anthropic.com/v1/compliance/apps/chats \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
```
Response 200
```python
{
"data": [
{
"id": "claude_chat_abc123",
"name": "Product Requirements Discussion",
"created_at": "2025-06-07T08:09:10Z",
"updated_at": "2025-06-07T09:10:11Z",
"organization_id": "org_abc123",
"organization_uuid": "abcdef01-2345-6789-abcd-ef0123456789",
"project_id": "claude_proj_xyz789",
"model": "claude-opus-5",
"user": {
"id": "user_xyz456",
"email_address": "user@example.com"
},
"href": "https://claude.ai/chat/abcdef01-2345-6789-abcd-ef0123456789"
}
],
"has_more": false,
"first_id": "eyJrIjogImNyZWF0ZWRfYXQiLCAidCI6ICIyMDI1LTA2LTA3VDA4OjA5OjEwKzAwOjAwIiwgImlkIjogImFiY2RlZjAxLTIzNDUtNjc4OS1hYmNkLWVmMDEyMzQ1Njc4OSJ9",
"last_id": "eyJrIjogImNyZWF0ZWRfYXQiLCAidCI6ICIyMDI1LTA2LTA3VDA4OjA5OjEwKzAwOjAwIiwgImlkIjogImFiY2RlZjAxLTIzNDUtNjc4OS1hYmNkLWVmMDEyMzQ1Njc4OSJ9"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"id": "claude_chat_abc123",
"name": "Product Requirements Discussion",
"created_at": "2025-06-07T08:09:10Z",
"updated_at": "2025-06-07T09:10:11Z",
"organization_id": "org_abc123",
"organization_uuid": "abcdef01-2345-6789-abcd-ef0123456789",
"project_id": "claude_proj_xyz789",
"model": "claude-opus-5",
"user": {
"id": "user_xyz456",
"email_address": "user@example.com"
},
"href": "https://claude.ai/chat/abcdef01-2345-6789-abcd-ef0123456789"
}
],
"has_more": false,
"first_id": "eyJrIjogImNyZWF0ZWRfYXQiLCAidCI6ICIyMDI1LTA2LTA3VDA4OjA5OjEwKzAwOjAwIiwgImlkIjogImFiY2RlZjAxLTIzNDUtNjc4OS1hYmNkLWVmMDEyMzQ1Njc4OSJ9",
"last_id": "eyJrIjogImNyZWF0ZWRfYXQiLCAidCI6ICIyMDI1LTA2LTA3VDA4OjA5OjEwKzAwOjAwIiwgImlkIjogImFiY2RlZjAxLTIzNDUtNjc4OS1hYmNkLWVmMDEyMzQ1Njc4OSJ9"
---
## Get chat messages - Claude API Reference
Source: https://platform.claude.com/docs/en/api/compliance/apps/chats/messages/list
Path: 04-API-Reference/Admin/compliance-apps-chats-messages-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fcompliance%2Fapps%2Fchats%2Fmessages%2Flist)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Chats
List chats
Delete chat
Messages
Get chat messages
Files
Generated Files
Projects
Artifacts
Sessions
Code
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
To enable the Compliance API, see the setup guide.
[Set up the Compliance API](../Other/manage-claude-compliance-api-access.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Compliance API](../Endpoints/http-compliance.md)
3. [Apps](https://platform.claude.com/docs/en/api/http/compliance/apps)
4. [Chats](https://platform.claude.com/docs/en/api/http/compliance/apps/chats)
5. [Messages](https://platform.claude.com/docs/en/api/http/compliance/apps/chats/messages)
# Get chat messages
Copy page
GET/v1/compliance/apps/chats/{claude_chat_id}/messages
Retrieves message history and file metadata for a specific chat.
##### Path parameters
claude_chat_id: string
The chat ID (tagged ID, e.g., claude_chat_abc123)
##### Query parameters
after_id: optional string
Pagination cursor for retrieving the next page of results. To paginate, pass the `last_id` value from the most recent response. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.
before_id: optional string
Pagination cursor for retrieving the previous page of results. To paginate, pass the `first_id` value from the most recent response. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.
created_at: optional object{ gt, gte, lt, lte }
gt: optional string
Filter messages created after this time (RFC 3339 format)
formatdate-time
gte: optional string
Filter messages created at or after this time (RFC 3339 format)
formatdate-time
lt: optional string
Filter messages created before this time (RFC 3339 format)
formatdate-time
lte: optional string
Filter messages created at or before this time (RFC 3339 format)
formatdate-time
limit: optional number
Maximum results (max: 1000). When omitted, the full result set is returned in one response.
minimum1
maximum1000
order: optional "asc" or "desc"
Sort direction for messages within the response. `asc` (the default) returns oldest-first; `desc` returns newest-first.
defaultasc
One of the following:
"asc"
"desc"
tool_result_max_chars: optional number
Maximum characters returned per tool-result text item. Items longer than this are shortened and the block's `truncated` field is set. Pass -1 to disable the limit.
default10000
minimum-1
tool_use_input_max_chars: optional number
Maximum characters of JSON-encoded tool input returned per tool_use block. Inputs longer than this are shortened and the block's `truncated` field is set. Pass -1 to disable the limit.
default10000
minimum-1
updated_at: optional object{ gt, gte, lt, lte }
gt: optional string
Filter messages updated after this time (RFC 3339 format)
formatdate-time
gte: optional string
Filter messages updated at or after this time (RFC 3339 format)
formatdate-time
lt: optional string
Filter messages updated before this time (RFC 3339 format)
formatdate-time
lte: optional string
Filter messages updated at or before this time (RFC 3339 format)
formatdate-time
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"x-api-key": optional string
##### Returns
id: string
Chat ID
chat_messages: array of object{ id, artifacts, content, 4 more }
Array of chat messages in order of created_at
id: string
Unique identifier for the message e.g. 'claude_chat_msg_abcd1234'
artifacts: array of object{ id, artifact_type, title, version_id } or null
Versioned documents generated or updated by the assistant in this message. Download via `GET /v1/compliance/apps/artifacts/{artifact_version_id}/content`.
id: string
Artifact ID e.g. 'claude_artifact_abc123'
artifact_type: string or null
MIME-like artifact type e.g. 'application/vnd.ant.code'
title: string or null
Artifact title
version_id: string
Artifact version ID e.g. 'claude_artifact_version_abc123'
content: array of Text or ToolUse or ToolResult
Content blocks within the message
One of the following:
Text object{ type: "text", text, thinking_redacted, truncated }
Text content block.
type: "text"
defaulttext
text: string
Text content from human or assistant
thinking_redacted: boolean
True when content enclosed in the assistant's internal-reasoning tags (or the tag markup itself) was removed from `text` during export. Removal never occurs with this field false. Always false on human messages, whose text is exported verbatim.
defaultfalse
truncated: boolean
True when `text` was shortened by the server's fixed per-string bound (1 MiB). Always false on chat text blocks.
defaultfalse
ToolUse object{ type: "tool_use", id, input, 4 more }
Tool invocation requested by the assistant.
type: "tool_use"
defaulttool_use
id: string or null
Tool-use ID, e.g. 'toolu_01AbC...'
input: string
Arguments passed to the tool, as a JSON-encoded string. May be shortened — see the `truncated` field
integration_name: string or null
Name of the integration that provides this tool, when applicable
mcp_server_url: string or null
Base URL (scheme, host, and path only) of the MCP server that provides this tool, when applicable
name: string
Name of the tool invoked
truncated: boolean
True when `input` was shortened. Pass the endpoint's tool-use input max parameter as -1 to request full content, subject to any server-side maximum the endpoint enforces.
defaultfalse
ToolResult object{ type: "tool_result", content, integration_name, 5 more }
Result returned by a tool invocation.
type: "tool_result"
defaulttool_result
content: array of object{ type: "text", text }
Text content returned by the tool. Generated files are surfaced via the message's `generated_files` list; other non-text item types (including images and links) are omitted.
type: "text"
defaulttext
text: string
Text returned by the tool
integration_name: string or null
Name of the integration that provides this tool, when applicable
is_error: boolean
True when the tool reported an error
mcp_server_url: string or null
Base URL (scheme, host, and path only) of the MCP server that provides this tool, when applicable
name: string
Name of the tool that produced this result
tool_use_id: string or null
ID of the tool_use block this result responds to
truncated: boolean
True when one or more text items in `content` were shortened. Pass the endpoint's tool-result max parameter as -1 to request full content, subject to any server-side maximum the endpoint enforces.
defaultfalse
created_at: string
Message creation timestamp - For human: when they sent the message, For assistant: when it completed the last content block
formatdate-time
files: array of object{ id, created_at, filename, 3 more } or null
Binary file attachments uploaded by the user. Download via `GET /v1/compliance/apps/chats/files/{claude_file_id}/content`.
id: string
File ID
created_at: string
File creation timestamp
formatdate-time
filename: string
Display name of the file
md5: string or null
Lowercase hex MD5 of the file's preferred downloadable variant, as recorded at upload time. Null when no stored hash is available.
mime_type: string or null
MIME type of the file's preferred downloadable variant (e.g. 'application/pdf')
size_bytes: number or null
Size in bytes of the file's preferred downloadable variant, if known. Null for older files uploaded before size was recorded.
generated_files: array of object{ id, filename, md5, 2 more } or null
Downloadable files the assistant created via tool use (e.g. PDF, spreadsheet, slide deck). Distinct from `files`, which are uploads attached to the message. Download an entry whose id starts with `claude_gen_file_` via `GET /v1/compliance/apps/chats/generated-files/{claude_gen_file_id}/content`, and one whose id starts with `claude_file_` via `GET /v1/compliance/apps/chats/files/{claude_file_id}/content`.
id: string
Id of the file: either a generated-file id, e.g. 'claude_gen_file_abc123', or a file id, e.g. 'claude_file_abc123'; the prefix tells them apart. Download the first from the generated-files content endpoint and the second from the files content endpoint. Treat everything after the prefix as an opaque string; the encoding may change without notice.
filename: string
Display name of the generated file
md5: string or null
Lowercase hex MD5 of the generated file, when available. Null when no stored hash is available.
mime_type: string or null
MIME type of the file, when known
size_bytes: number or null
Size in bytes of the generated file, when available. Null when the file has expired or size is not recorded.
role: "assistant" or "user"
Message sender (user or assistant)
One of the following:
"assistant"
"user"
created_at: string
Creation timestamp
formatdate-time
deleted_at: string or null
Deletion timestamp if deleted
formatdate-time
first_id: string or null
Opaque pagination cursor for the first message in the current result set. Pass as `before_id` on the next request to page backwards. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.
has_more: boolean
Whether more chat messages exist beyond the current result set. Use `last_id` as `after_id` in a follow-up request to page forward.
defaultfalse
href: string
URL to view this chat in claude.ai
last_id: string or null
Opaque pagination cursor for the last message in the current result set. Pass as `after_id` on the next request to page forwards. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.
model: string or null
Model selected for this chat (e.g. 'claude-opus-5'). May be null for legacy chats that never had a model recorded.
name: string
Chat name. Empty when `deleted_at` is set.
organization_uuid: string
Organization UUID this chat belongs to
project_id: string or null
Project ID this chat belongs to
updated_at: string
Last update timestamp. Updated when the chat receives a new message, is moved into or out of a project, or is deleted in claude.ai. Other edits, such as renaming the chat, are not guaranteed to change it.
formatdate-time
user: object{ id, email_address } or null
The user who created the chat. Null when the API key is restricted to one organization and the creator is no longer a member of it.
id: string
User identifier
email_address: string
User's email address
organization_id: stringDeprecated
Organization ID this chat belongs to
Get chat messages
cURL
```python
curl https://api.anthropic.com/v1/compliance/apps/chats/$CLAUDE_CHAT_ID/messages \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
```
Response 200
```python
{
"id": "claude_chat_abc123",
"name": "Product Requirements Discussion",
"created_at": "2025-06-07T08:09:10Z",
"updated_at": "2025-06-07T08:10:05Z",
"organization_id": "org_abc123",
"organization_uuid": "abcdef01-2345-6789-abcd-ef0123456789",
"project_id": "claude_proj_xyz789",
"model": "claude-opus-5",
"user": {
"id": "user_xyz456",
"email_address": "user@example.com"
},
"href": "https://claude.ai/chat/abcdef01-2345-6789-abcd-ef0123456789",
"chat_messages": [
{
"id": "claude_chat_msg_abc123",
"role": "user",
"created_at": "2025-06-07T08:09:10Z",
"content": [
{
"type": "text",
"text": "Can you help me draft requirements for our new dashboard feature?",
"truncated": false,
"thinking_redacted": false
}
],
"files": [
{
"id": "claude_file_xyz789",
"filename": "dashboard_mockup_v1.pdf",
"mime_type": "application/pdf",
"size_bytes": 12345,
"md5": "5d41402abc4b2a76b9719d911017c592",
"created_at": "2025-06-07T08:09:10Z"
}
]
},
{
"id": "claude_chat_msg_def456",
"role": "assistant",
"created_at": "2025-06-07T08:09:11Z",
"content": [
{
"type": "text",
"text": "I'd be happy to help you draft requirements for your dashboard feature...",
"truncated": false,
"thinking_redacted": false
}
],
"artifacts": [
{
"id": "claude_artifact_abc123",
"version_id": "claude_artifact_version_xyz789",
"title": "Dashboard Requirements Draft",
"artifact_type": "text/markdown"
}
]
},
{
"id": "claude_chat_msg_ghi789",
"role": "user",
"created_at": "2025-06-07T08:10:00Z",
"content": [
{
"type": "text",
"text": "Are there any open support tickets about the dashboard?",
"truncated": false,
"thinking_redacted": false
}
]
},
{
"id": "claude_chat_msg_jkl012",
"role": "assistant",
"created_at": "2025-06-07T08:10:05Z",
"content": [
{
"type": "tool_use",
"id": "toolu_01Abc",
"name": "search_tickets",
"input": "{\"query\":\"dashboard\",\"status\":\"open\"}",
"truncated": false,
"integration_name": "Example Integration",
"mcp_server_url": "https://mcp.example.com"
},
{
"type": "tool_result",
"tool_use_id": "toolu_01Abc",
"name": "search_tickets",
"is_error": false,
"integration_name": "Example Integration",
"mcp_server_url": "https://mcp.example.com",
"content": [
{
"type": "text",
"text": "2 open tickets: #1042 Dashboard loads slowly; #1057 Export button missing"
}
],
"truncated": false
},
{
"type": "text",
"text": "There are two open tickets: one about slow loading and one about a missing export button.",
"truncated": false,
"thinking_redacted": false
}
]
}
],
"has_more": false,
"first_id": "eyJtc2dfdXVpZCI6ICIwZjcwYjA2Ni0uLi4ifQ==",
"last_id": "eyJtc2dfdXVpZCI6ICI3YzFlOWQ0Yi0uLi4ifQ=="
}
```
##### Returns Examples
Response 200
```python
{
"id": "claude_chat_abc123",
"name": "Product Requirements Discussion",
"created_at": "2025-06-07T08:09:10Z",
"updated_at": "2025-06-07T08:10:05Z",
"organization_id": "org_abc123",
"organization_uuid": "abcdef01-2345-6789-abcd-ef0123456789",
"project_id": "claude_proj_xyz789",
"model": "claude-opus-5",
"user": {
"id": "user_xyz456",
"email_address": "user@example.com"
},
"href": "https://claude.ai/chat/abcdef01-2345-6789-abcd-ef0123456789",
"chat_messages": [
{
"id": "claude_chat_msg_abc123",
"role": "user",
"created_at": "2025-06-07T08:09:10Z",
"content": [
{
"type": "text",
"text": "Can you help me draft requirements for our new dashboard feature?",
"truncated": false,
"thinking_redacted": false
}
],
"files": [
{
"id": "claude_file_xyz789",
"filename": "dashboard_mockup_v1.pdf",
"mime_type": "application/pdf",
"size_bytes": 12345,
"md5": "5d41402abc4b2a76b9719d911017c592",
"created_at": "2025-06-07T08:09:10Z"
}
]
},
{
"id": "claude_chat_msg_def456",
"role": "assistant",
"created_at": "2025-06-07T08:09:11Z",
"content": [
{
"type": "text",
"text": "I'd be happy to help you draft requirements for your dashboard feature...",
"truncated": false,
"thinking_redacted": false
}
],
"artifacts": [
{
"id": "claude_artifact_abc123",
"version_id": "claude_artifact_version_xyz789",
"title": "Dashboard Requirements Draft",
"artifact_type": "text/markdown"
}
]
},
{
"id": "claude_chat_msg_ghi789",
"role": "user",
"created_at": "2025-06-07T08:10:00Z",
"content": [
{
"type": "text",
"text": "Are there any open support tickets about the dashboard?",
"truncated": false,
"thinking_redacted": false
}
]
},
{
"id": "claude_chat_msg_jkl012",
"role": "assistant",
"created_at": "2025-06-07T08:10:05Z",
"content": [
{
"type": "tool_use",
"id": "toolu_01Abc",
"name": "search_tickets",
"input": "{\"query\":\"dashboard\",\"status\":\"open\"}",
"truncated": false,
"integration_name": "Example Integration",
"mcp_server_url": "https://mcp.example.com"
},
{
"type": "tool_result",
"tool_use_id": "toolu_01Abc",
"name": "search_tickets",
"is_error": false,
"integration_name": "Example Integration",
"mcp_server_url": "https://mcp.example.com",
"content": [
{
"type": "text",
"text": "2 open tickets: #1042 Dashboard loads slowly; #1057 Export button missing"
}
],
"truncated": false
},
{
"type": "text",
"text": "There are two open tickets: one about slow loading and one about a missing export button.",
"truncated": false,
"thinking_redacted": false
}
]
}
],
"has_more": false,
"first_id": "eyJtc2dfdXVpZCI6ICIwZjcwYjA2Ni0uLi4ifQ==",
"last_id": "eyJtc2dfdXVpZCI6ICI3YzFlOWQ0Yi0uLi4ifQ=="
---
## Messages - Claude API Reference
Source: https://platform.claude.com/docs/en/api/compliance/apps/chats/messages
Path: 04-API-Reference/Admin/compliance-apps-chats-messages.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fcompliance%2Fapps%2Fchats%2Fmessages)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Chats
List chats
Delete chat
Messages
Get chat messages
Files
Generated Files
Projects
Artifacts
Sessions
Code
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
To enable the Compliance API, see the setup guide.
[Set up the Compliance API](../Other/manage-claude-compliance-api-access.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Compliance API](../Endpoints/http-compliance.md)
3. [Apps](https://platform.claude.com/docs/en/api/http/compliance/apps)
4. [Chats](https://platform.claude.com/docs/en/api/http/compliance/apps/chats)
# Messages
Copy page
##### [Get chat messages](https://platform.claude.com/docs/en/api/http/compliance/apps/chats/messages/list)
GET/v1/compliance/apps/chats/{claude_chat_id}/messages
Retrieves message history and file metadata for a specific chat.
##### Models
MessageListResponse object{ id, artifacts, content, 4 more }
A single message in a chat conversation.
When the chat's `deleted_at` is set, `content` is an empty list and `files`, `generated_files` and `artifacts` are null.
---
## Chats - Claude API Reference
Source: https://platform.claude.com/docs/en/api/compliance/apps/chats
Path: 04-API-Reference/Admin/compliance-apps-chats.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fcompliance%2Fapps%2Fchats)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Chats
List chats
Delete chat
Messages
Files
Generated Files
Projects
Artifacts
Sessions
Code
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
To enable the Compliance API, see the setup guide.
[Set up the Compliance API](../Other/manage-claude-compliance-api-access.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Compliance API](../Endpoints/http-compliance.md)
3. [Apps](https://platform.claude.com/docs/en/api/http/compliance/apps)
# Chats
Copy page
##### [List chats](https://platform.claude.com/docs/en/api/http/compliance/apps/chats/list)
GET/v1/compliance/apps/chats
Lists chat metadata with filtering capabilities for targeted compliance review. Results are sorted chronologically (time ascending) by the `order_by` key, with ties broken by id.
##### [Delete chat](https://platform.claude.com/docs/en/api/http/compliance/apps/chats/delete)
DELETE/v1/compliance/apps/chats/{claude_chat_id}
Permanently deletes a chat and all associated messages and files. This is a destructive operation that cannot be undone.
##### Models
ChatListResponse object{ id, created_at, deleted_at, 8 more }
Chat metadata for listing chats (without messages).
ChatDeleteResponse object{ type: "claude_chat_deleted", id }
Response for deleting a Claude chat.
type: optional "claude_chat_deleted"
Constant string confirming deletion
defaultclaude_chat_deleted
id: string
The ID of the Claude chat that was deleted
#### Chats[Messages](https://platform.claude.com/docs/en/api/http/compliance/apps/chats/messages)
##### [Get chat messages](https://platform.claude.com/docs/en/api/http/compliance/apps/chats/messages/list)
GET/v1/compliance/apps/chats/{claude_chat_id}/messages
Retrieves message history and file metadata for a specific chat.
#### Chats[Files](https://platform.claude.com/docs/en/api/http/compliance/apps/chats/files)
##### [Get file metadata](https://platform.claude.com/docs/en/api/http/compliance/apps/chats/files/retrieve)
GET/v1/compliance/apps/chats/files/{claude_file_id}
Retrieves metadata for a file referenced in chat messages, without downloading the file content. Use the sibling `/content` endpoint to download the bytes.
##### [Delete file](https://platform.claude.com/docs/en/api/http/compliance/apps/chats/files/delete)
DELETE/v1/compliance/apps/chats/files/{claude_file_id}
Permanently deletes a specific file. This is a destructive operation that cannot be undone.
##### [Download file content](https://platform.claude.com/docs/en/api/http/compliance/apps/chats/files/download)
GET/v1/compliance/apps/chats/files/{claude_file_id}/content
Downloads the binary content of a file referenced in chat messages.
#### Chats[Generated Files](https://platform.claude.com/docs/en/api/http/compliance/apps/chats/generated_files)
##### [Get Claude-generated file metadata](https://platform.claude.com/docs/en/api/http/compliance/apps/chats/generated_files/retrieve)
GET/v1/compliance/apps/chats/generated-files/{claude_gen_file_id}
Returns metadata for a file the assistant created via tool use.
##### [Download a Claude-generated file](https://platform.claude.com/docs/en/api/http/compliance/apps/chats/generated_files/download)
GET/v1/compliance/apps/chats/generated-files/{claude_gen_file_id}/content
Downloads the binary content of a file the assistant created via tool use.
---
## Delete Code Artifact - Claude API Reference
Source: https://platform.claude.com/docs/en/api/compliance/apps/code/artifacts/delete
Path: 04-API-Reference/Admin/compliance-apps-code-artifacts-delete.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fcompliance%2Fapps%2Fcode%2Fartifacts%2Fdelete)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Chats
Projects
Artifacts
Sessions
Code
Artifacts
List Code Artifacts
Download Code Artifact Version Content
Download Code Artifact Content
Delete Code Artifact
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[AWS IAM actions](../Endpoints/claude-platform-on-aws-iam-actions.md)[Google Cloud IAM permissions](../Endpoints/claude-models-on-google-cloud-anthropic-managed-iam-permissions.md)[Versions](../Endpoints/versioning.md)[Migrating to API version 2026-10-21](../Endpoints/migration-2026-10-21.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
To enable the Compliance API, see the setup guide.
[Set up the Compliance API](../Other/manage-claude-compliance-api-access.md)
Copy page
API version 2026-10-21
1. [API reference](../Endpoints/http.md)
2. [Compliance API](../Endpoints/http-compliance.md)
3. [Apps](https://platform.claude.com/docs/en/api/http/compliance/apps)
4. [Code](https://platform.claude.com/docs/en/api/http/compliance/apps/code)
5. [Artifacts](https://platform.claude.com/docs/en/api/http/compliance/apps/code/artifacts)
# Delete Code Artifact
Copy page
API version 2026-10-21
DELETE/v1/compliance/apps/code/artifacts/{artifact_id}
Permanently deletes a Code Artifact and all its versions. This is a destructive operation that cannot be undone. A 200 response means the deletion is initiated and the Artifact is claimed; content removal completes asynchronously.
Returns 404 for Artifacts that don't exist or belong to another parent organization. Returns 404 on a repeated delete of an already-deleted Artifact.
##### Path parameters
artifact_id: string
The Artifact ID (tagged ID, e.g., cart_abc123)
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"x-api-key": optional string
##### Returns
type: "code_artifact_deleted"
Constant string confirming deletion
defaultcode_artifact_deleted
id: string
The ID of the Artifact that was deleted
Delete Code Artifact
cURL
```python
curl https://api.anthropic.com/v1/compliance/apps/code/artifacts/$ARTIFACT_ID \
-X DELETE \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
```
Response 200
```python
{
"id": "cart_xyz789",
"type": "code_artifact_deleted"
}
```
##### Returns Examples
Response 200
```python
{
"id": "cart_xyz789",
"type": "code_artifact_deleted"
---
## Download Code Artifact Content - Claude API Reference
Source: https://platform.claude.com/docs/en/api/compliance/apps/code/artifacts/download
Path: 04-API-Reference/Admin/compliance-apps-code-artifacts-download.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fcompliance%2Fapps%2Fcode%2Fartifacts%2Fdownload)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Chats
Projects
Artifacts
Sessions
Code
Artifacts
List Code Artifacts
Download Code Artifact Version Content
Download Code Artifact Content
Delete Code Artifact
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[AWS IAM actions](../Endpoints/claude-platform-on-aws-iam-actions.md)[Google Cloud IAM permissions](../Endpoints/claude-models-on-google-cloud-anthropic-managed-iam-permissions.md)[Versions](../Endpoints/versioning.md)[Migrating to API version 2026-10-21](../Endpoints/migration-2026-10-21.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
To enable the Compliance API, see the setup guide.
[Set up the Compliance API](../Other/manage-claude-compliance-api-access.md)
Copy page
API version 2026-10-21
1. [API reference](../Endpoints/http.md)
2. [Compliance API](../Endpoints/http-compliance.md)
3. [Apps](https://platform.claude.com/docs/en/api/http/compliance/apps)
4. [Code](https://platform.claude.com/docs/en/api/http/compliance/apps/code)
5. [Artifacts](https://platform.claude.com/docs/en/api/http/compliance/apps/code/artifacts)
# Download Code Artifact Content
Copy page
API version 2026-10-21
GET/v1/compliance/apps/code/artifacts/{artifact_id}/content
Streams an Artifact's current content as the response body, in chunks with no `Content-Length`.
For a Claude Doc (an Artifact whose `artifact_type` is `claude_docs`), the request must set `multi_file_format=zip`, and the content is the Doc's text as a ZIP archive of Word files. That ZIP has no `files.json`. It holds one Word file per text tab, in tab order, named `NN-<tab id>.docx`, where `NN` counts from `01`. A Doc with one text tab gets one file, `01-document.docx`.
For any other Artifact, the content is the latest version. With `multi_file_format=zip`, when the latest version has more than one file, it comes back as a ZIP archive of its files.
Headers: `Content-Type` (`application/zip` for a ZIP archive, otherwise the stored MIME type), `Content-Disposition: attachment; filename*=utf-8''<name>` (RFC 5987), `Cache-Control: no-store, private` and, when available, `Content-MD5` (base64). `<name>` is `{artifact_id}.zip` for a ZIP archive, otherwise `{artifact_id}.txt`, whatever the content is. `Content-MD5` is always on a Claude Doc's ZIP, only on a single file stored uncompressed, and never on a ZIP archive of a version's files. Check the body against it when present.
Errors specific to this download:
- `404`: the Artifact doesn't exist, or the API key cannot read it.
- `400` with `error.details.error_code` `cmek_key_disabled`: the organization's customer-managed encryption key can't be used, for example because it is disabled or revoked. Retry once the key can be used again.
- `503`: the content can't be produced right now. Wait the number of seconds in the `Retry-After` header, or retry with backoff when it is absent.
- `422` with `multi_file_unavailable`: the request does not set `multi_file_format=zip`, and the Artifact is a Claude Doc or its latest version has more than one file. Add the parameter.
- `422` with `file_set_unavailable`: the request sets `multi_file_format=zip`, the Artifact is not a Claude Doc, and one of the latest version's files has a path the API cannot export. Do not retry.
- `422` with `document_unavailable`: Claude Docs has no document it can export for the Doc, for example because it has no text tab or is in the trash. Retrying will not help unless that changes.
- `422` with `document_too_large`: the Doc's export is over 16 MiB. Do not retry.
- `422` with `cmek_org_unsupported`: the organization uses customer-managed encryption keys and the export can't be served for it right now. Try again later, and contact Anthropic support if this continues.
An error after the download has started stops the body early, with the `200` status already sent. For example, this happens to content stored compressed when it is over 16 MiB once decompressed. For a single file with no `Content-MD5`, the only sign is a transfer that aborts before its last chunk, so treat a download that aborts this way as failed.
A ZIP archive of a version's files holds one top-level folder, named for the Artifact. That folder holds a `files/` folder and an index, `files.json`. The index is written last, so treat an archive as incomplete if it cannot be opened or has no `files.json` in its top-level folder.
`files.json` has these fields:
- `artifact_id`: the Artifact ID, as in the request.
- `version_id`: null.
- `title`: the title of the version in the archive, or that version's ID when no title is kept.
- `created_at`: when the version was published (RFC 3339, UTC), or null when that is not known.
- `files`: one entry for each file under `files/`, with `original_path` (the file's path in the version), `exported_as` (its path in the archive), `sha256` (lowercase hex), `size_bytes` (before compression) and `mime_type`. `exported_as` is the top-level folder, then `files/`, then `original_path`. A name that could not be saved or opened safely on every operating system is changed. Use `exported_as`, not `original_path`, to find a file in the archive.
- `omitted_files`: the files left out of the archive, each with `original_path`, `sha256`, `size_bytes` and `mime_type`. They include files the version uses from another Artifact. They also include files copied from the Artifact type the Artifact was made from, such as the app that displays it, when another organization owns that type.
`files` and `omitted_files` together list at most 4,096 files, their `size_bytes` add up to at most 1 GiB, and no file is over 20 MiB.
##### Path parameters
artifact_id: string
The Artifact ID (tagged ID, e.g., cart_abc123)
##### Query parameters
multi_file_format: optional string
Set to `zip`, its only value. A Claude Doc downloads only this way, as a ZIP archive of Word files, one per text tab. For any other Artifact, when the latest version has more than one file, it comes back as a ZIP archive of its files with an index, `files.json`.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"x-api-key": optional string
Download Code Artifact Content
cURL
```python
curl https://api.anthropic.com/v1/compliance/apps/code/artifacts/$ARTIFACT_ID/content \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
---
## List Code Artifacts - Claude API Reference
Source: https://platform.claude.com/docs/en/api/compliance/apps/code/artifacts/list
Path: 04-API-Reference/Admin/compliance-apps-code-artifacts-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fcompliance%2Fapps%2Fcode%2Fartifacts%2Flist)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Chats
Projects
Artifacts
Sessions
Code
Artifacts
List Code Artifacts
Download Code Artifact Version Content
Download Code Artifact Content
Delete Code Artifact
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[AWS IAM actions](../Endpoints/claude-platform-on-aws-iam-actions.md)[Google Cloud IAM permissions](../Endpoints/claude-models-on-google-cloud-anthropic-managed-iam-permissions.md)[Versions](../Endpoints/versioning.md)[Migrating to API version 2026-10-21](../Endpoints/migration-2026-10-21.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
To enable the Compliance API, see the setup guide.
[Set up the Compliance API](../Other/manage-claude-compliance-api-access.md)
Copy page
API version 2026-10-21
1. [API reference](../Endpoints/http.md)
2. [Compliance API](../Endpoints/http-compliance.md)
3. [Apps](https://platform.claude.com/docs/en/api/http/compliance/apps)
4. [Code](https://platform.claude.com/docs/en/api/http/compliance/apps/code)
5. [Artifacts](https://platform.claude.com/docs/en/api/http/compliance/apps/code/artifacts)
# List Code Artifacts
Copy page
API version 2026-10-21
GET/v1/compliance/apps/code/artifacts
List Claude Code Artifacts owned by organizations under the parent organization.
Results are sorted by Artifact identifier. Pages may be short or empty while `next_page` is still set — continue until `next_page` is absent. Artifacts are sorted by identifier (not creation time): an Artifact published during an export may land before the cursor and be omitted, so for a point-in-time-complete export re-enumerate after publishing quiesces.
Artifacts owned by a since-deleted child organization are not returned.
##### Query parameters
limit: optional number
Maximum results (default: 20, max: 100)
default20
minimum1
maximum100
organization_ids: optional array of string
Filter by organization IDs (accepts `org_...` or organization UUID, up to 500). Enumerate IDs via `GET /v1/compliance/organizations`.
maxItems500
page: optional string
Opaque pagination token from a previous response's `next_page` field. Pass this to retrieve the next page of results. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.
updated_at: optional object{ gt, gte, lt, lte }
gt: optional string
Return only Artifacts updated after this time (RFC 3339 format). See `updated_at.gte` for the completeness caveat.
formatdate-time
gte: optional string
Return only Artifacts updated at or after this time (RFC 3339 format). Time filters match an eventually-consistent index and Artifacts published before this field was recorded never match — omit the time filter for compliance-complete enumeration. For incremental export, apply a generous overlap margin between windows and dedupe by `id`: adjacent tiling silently misses items whose index update lagged their publish.
formatdate-time
lt: optional string
Return only Artifacts updated before this time (RFC 3339 format). Multiple time operators are AND-ed to the tightest bound. See `updated_at.gte` for the completeness caveat.
formatdate-time
lte: optional string
Return only Artifacts updated at or before this time (RFC 3339 format). See `updated_at.gte` for the completeness caveat.
formatdate-time
user_ids: optional array of string
Filter by owner user IDs (up to 200). Enumerate IDs via `GET /v1/compliance/organizations/{org_uuid}/users`.
maxItems200
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"x-api-key": optional string
##### Returns
data: array of object{ id, artifact_type, organization_uuid, 6 more }
Page of Artifacts
id: string
Artifact identifier (tagged ID)
artifact_type: "claude_dashboards" or "claude_design" or "claude_design_systems" or 5 more
Which kind of Artifact this is: `code` for a site published from Claude Code, or the built-in Artifact type it was made from — `claude_docs` (Claude Docs), `claude_slides` (Slides), `claude_design` (Design), `claude_design_systems` (a design system), `claude_motion` (Motion) or `claude_dashboards` (Dashboards). `other` is an Artifact made from a built-in type this list does not name yet.
One of the following:
"claude_dashboards"
"claude_design"
"claude_design_systems"
"claude_docs"
"claude_motion"
"claude_slides"
"code"
"other"
organization_uuid: string
Organization UUID this Artifact belongs to
owner_user_id: string or null
Artifact owner's user identifier (tagged ID), or null for Artifacts published by an agent session rather than a user account. When set, it survives after the owner's account is deleted or the owner leaves every organization under the parent.
published_version_id: string or null
Identifier of the version a non-owner viewer would render when `read_mode` permits them — the version the owner has pinned for non-owner readers if one is pinned, otherwise the owner's latest. When `read_mode` is `owner` no non-owner renders any version; the field still reports which version would be served were read_mode widened. Null for a Claude Doc; see `versions`.
read_mode: "org" or "owner" or "public" or "users"
Who can view this Artifact: only its owner, a named set of users, every member of its organization, or anyone on the internet (`public`)
One of the following:
"org"
"owner"
"public"
"users"
updated_at: string or null
Artifact last update timestamp, or null for Artifacts published before this field was recorded
formatdate-time
user: object{ id, email_address } or null
Artifact owner with email, or null if the Artifact was published by an agent session, the owner's account has been deleted, or the owner is no longer a member of an organization the key may read
id: string
User identifier (tagged ID)
email_address: string
User's email address
versions: array of object{ id, created_at, name }
Up to roughly 20 most-recently-published versions of this Artifact (older versions are not retained). Metadata only — use `GET /v1/compliance/apps/code/artifacts/{artifact_id}/versions/{version_id}` to download a version's content. Empty for a Claude Doc, because a Doc's versions hold only the web page that displays it, not its text. Download a Doc's text with `GET /v1/compliance/apps/code/artifacts/{artifact_id}/content?multi_file_format=zip`.
id: string
Opaque version identifier
created_at: string or null
When this version was published
formatdate-time
name: string
Artifact title at this version. Falls back to the version identifier when the title for an older version is no longer retained.
has_more: boolean
Whether `next_page` is set. May be true for a page whose next page is empty — continue until `next_page` is absent.
next_page: string or null
Token to retrieve the next page. Use this as the 'page' parameter in your next request
List Code Artifacts
cURL
```python
curl https://api.anthropic.com/v1/compliance/apps/code/artifacts \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
```
Response 200
```python
{
"data": [
{
"id": "cart_01Tu9VwXyZaBcDeFgHiJkLmN",
"artifact_type": "code",
"organization_uuid": "a1b2c3d4-e5f6-4789-a012-3456789abcde",
"owner_user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"published_version_id": "1741803761-9f3a",
"read_mode": "org",
"updated_at": "2025-03-14T09:05:17.456789Z",
"user": {
"id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"email_address": "jane.doe@example.com"
},
"versions": [
{
"id": "1741803761-9f3a",
"created_at": "2025-03-12T18:22:41.123456Z",
"name": "Team dashboard"
}
]
}
],
"has_more": true,
"next_page": "cGFnZV90b2tlbl9leGFtcGxlXzE3MzQ1Njc4OTA="
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"id": "cart_01Tu9VwXyZaBcDeFgHiJkLmN",
"artifact_type": "code",
"organization_uuid": "a1b2c3d4-e5f6-4789-a012-3456789abcde",
"owner_user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"published_version_id": "1741803761-9f3a",
"read_mode": "org",
"updated_at": "2025-03-14T09:05:17.456789Z",
"user": {
"id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"email_address": "jane.doe@example.com"
},
"versions": [
{
"id": "1741803761-9f3a",
"created_at": "2025-03-12T18:22:41.123456Z",
"name": "Team dashboard"
}
]
}
],
"has_more": true,
"next_page": "cGFnZV90b2tlbl9leGFtcGxlXzE3MzQ1Njc4OTA="
---
## Download Code Artifact Version Content - Claude API Reference
Source: https://platform.claude.com/docs/en/api/compliance/apps/code/artifacts/retrieve_version
Path: 04-API-Reference/Admin/compliance-apps-code-artifacts-retrieve-version.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fcompliance%2Fapps%2Fcode%2Fartifacts%2Fretrieve_version)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Chats
Projects
Artifacts
Sessions
Code
Artifacts
List Code Artifacts
Download Code Artifact Version Content
Download Code Artifact Content
Delete Code Artifact
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[AWS IAM actions](../Endpoints/claude-platform-on-aws-iam-actions.md)[Google Cloud IAM permissions](../Endpoints/claude-models-on-google-cloud-anthropic-managed-iam-permissions.md)[Versions](../Endpoints/versioning.md)[Migrating to API version 2026-10-21](../Endpoints/migration-2026-10-21.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
To enable the Compliance API, see the setup guide.
[Set up the Compliance API](../Other/manage-claude-compliance-api-access.md)
Copy page
API version 2026-10-21
1. [API reference](../Endpoints/http.md)
2. [Compliance API](../Endpoints/http-compliance.md)
3. [Apps](https://platform.claude.com/docs/en/api/http/compliance/apps)
4. [Code](https://platform.claude.com/docs/en/api/http/compliance/apps/code)
5. [Artifacts](https://platform.claude.com/docs/en/api/http/compliance/apps/code/artifacts)
# Download Code Artifact Version Content
Copy page
API version 2026-10-21
GET/v1/compliance/apps/code/artifacts/{artifact_id}/versions/{version_id}
Streams the content of one version of an Artifact as the response body, in chunks with no `Content-Length`. With `multi_file_format=zip`, a version with more than one file, other than a Claude Doc's (an Artifact whose `artifact_type` is `claude_docs`), comes back as a ZIP archive of its files.
Headers: `Content-Type` (`application/zip` for a ZIP archive, otherwise the stored MIME type), `Content-Disposition: attachment; filename*=utf-8''<name>` (RFC 5987), `Cache-Control: no-store, private` and, when available, `Content-MD5` (base64). `<name>` is `{artifact_id}-{version_id}.zip` for a ZIP archive, otherwise `{artifact_id}-{version_id}.txt`, whatever the content is. `Content-MD5` is only on a single file stored uncompressed, so it is never on a ZIP archive. Check the body against it when present.
Errors specific to this download:
- `404`: the Artifact doesn't exist or the API key cannot read it, or the version is no longer kept. Older versions are dropped as new ones are published, so list the Artifact's versions again. You also get this when the organization's customer-managed encryption key can't be used. Retry once the key can be used again.
- `503`: the content can't be served right now, for example because its upload is still in progress or was abandoned. Retry with backoff.
- `422` with `error.details.error_code` `multi_file_unavailable`: the version has more than one file. Add `multi_file_format=zip`. A Claude Doc's version with more than one file gets this error either way, because it holds only the web page that displays the Doc. Download the Doc's text with `GET /v1/compliance/apps/code/artifacts/{artifact_id}/content?multi_file_format=zip`.
- `422` with `file_set_unavailable`: the request sets `multi_file_format=zip`, the version has more than one file, and one of them has a path the API cannot export. Do not retry.
An error after the download has started stops the body early, with the `200` status already sent. For example, this happens to content stored compressed when it is over 16 MiB once decompressed. For a single file with no `Content-MD5`, the only sign is a transfer that aborts before its last chunk, so treat a download that aborts this way as failed.
A ZIP archive of a version's files holds one top-level folder, named for the Artifact and version. That folder holds a `files/` folder and an index, `files.json`. The index is written last, so treat an archive as incomplete if it cannot be opened or has no `files.json` in its top-level folder.
`files.json` has these fields:
- `artifact_id`: the Artifact ID, as in the request.
- `version_id`: the version ID, as in the request.
- `title`: the title of the version in the archive, or that version's ID when no title is kept.
- `created_at`: when the version was published (RFC 3339, UTC), or null when that is not known.
- `files`: one entry for each file under `files/`, with `original_path` (the file's path in the version), `exported_as` (its path in the archive), `sha256` (lowercase hex), `size_bytes` (before compression) and `mime_type`. `exported_as` is the top-level folder, then `files/`, then `original_path`. A name that could not be saved or opened safely on every operating system is changed. Use `exported_as`, not `original_path`, to find a file in the archive.
- `omitted_files`: the files left out of the archive, each with `original_path`, `sha256`, `size_bytes` and `mime_type`. They include files the version uses from another Artifact. They also include files copied from the Artifact type the Artifact was made from, such as the app that displays it, when another organization owns that type.
`files` and `omitted_files` together list at most 4,096 files, their `size_bytes` add up to at most 1 GiB, and no file is over 20 MiB.
##### Path parameters
artifact_id: string
The Artifact ID (tagged ID, e.g., cart_abc123)
version_id: string
Opaque version identifier from the Artifact's `versions` list
##### Query parameters
multi_file_format: optional string
Set to `zip`, its only value, to receive a version that has more than one file as a ZIP archive of its files with an index, `files.json`. A version with one file is returned as that file. A Claude Doc's version never comes back as a ZIP.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"x-api-key": optional string
Download Code Artifact Version Content
cURL
```python
curl https://api.anthropic.com/v1/compliance/apps/code/artifacts/$ARTIFACT_ID/versions/$VERSION_ID \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
---
## Artifacts - Claude API Reference
Source: https://platform.claude.com/docs/en/api/compliance/apps/code/artifacts
Path: 04-API-Reference/Admin/compliance-apps-code-artifacts.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fcompliance%2Fapps%2Fcode%2Fartifacts)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Chats
Projects
Artifacts
Sessions
Code
Artifacts
List Code Artifacts
Download Code Artifact Version Content
Download Code Artifact Content
Delete Code Artifact
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[AWS IAM actions](../Endpoints/claude-platform-on-aws-iam-actions.md)[Google Cloud IAM permissions](../Endpoints/claude-models-on-google-cloud-anthropic-managed-iam-permissions.md)[Versions](../Endpoints/versioning.md)[Migrating to API version 2026-10-21](../Endpoints/migration-2026-10-21.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
To enable the Compliance API, see the setup guide.
[Set up the Compliance API](../Other/manage-claude-compliance-api-access.md)
Copy page
API version 2026-10-21
1. [API reference](../Endpoints/http.md)
2. [Compliance API](../Endpoints/http-compliance.md)
3. [Apps](https://platform.claude.com/docs/en/api/http/compliance/apps)
4. [Code](https://platform.claude.com/docs/en/api/http/compliance/apps/code)
# Artifacts
Copy page
API version 2026-10-21
##### [List Code Artifacts](https://platform.claude.com/docs/en/api/http/compliance/apps/code/artifacts/list)
GET/v1/compliance/apps/code/artifacts
List Claude Code Artifacts owned by organizations under the parent organization.
##### [Download Code Artifact Version Content](https://platform.claude.com/docs/en/api/http/compliance/apps/code/artifacts/retrieve_version)
GET/v1/compliance/apps/code/artifacts/{artifact_id}/versions/{version_id}
Streams the content of one version of an Artifact as the response body, in chunks with no `Content-Length`. With `multi_file_format=zip`, a version with more than one file, other than a Claude Doc's (an Artifact whose `artifact_type` is `claude_docs`), comes back as a ZIP archive of its files.
##### [Download Code Artifact Content](https://platform.claude.com/docs/en/api/http/compliance/apps/code/artifacts/download)
GET/v1/compliance/apps/code/artifacts/{artifact_id}/content
Streams an Artifact's current content as the response body, in chunks with no `Content-Length`.
##### [Delete Code Artifact](https://platform.claude.com/docs/en/api/http/compliance/apps/code/artifacts/delete)
DELETE/v1/compliance/apps/code/artifacts/{artifact_id}
Permanently deletes a Code Artifact and all its versions. This is a destructive operation that cannot be undone. A 200 response means the deletion is initiated and the Artifact is claimed; content removal completes asynchronously.
##### Models
ArtifactListResponse object{ id, artifact_type, organization_uuid, 6 more }
An Artifact: a site published from Claude Code, or a document made from one of Anthropic's built-in Artifact types (Claude Docs, Slides, Design, …). `artifact_type` says which.
ArtifactDeleteResponse object{ type: "code_artifact_deleted", id }
Response for deleting a Code Artifact.
type: "code_artifact_deleted"
Constant string confirming deletion
defaultcode_artifact_deleted
id: string
The ID of the Artifact that was deleted
---
## Code - Claude API Reference
Source: https://platform.claude.com/docs/en/api/compliance/apps/code
Path: 04-API-Reference/Admin/compliance-apps-code.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fcompliance%2Fapps%2Fcode)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Chats
Projects
Artifacts
Sessions
Code
Artifacts
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[AWS IAM actions](../Endpoints/claude-platform-on-aws-iam-actions.md)[Google Cloud IAM permissions](../Endpoints/claude-models-on-google-cloud-anthropic-managed-iam-permissions.md)[Versions](../Endpoints/versioning.md)[Migrating to API version 2026-10-21](../Endpoints/migration-2026-10-21.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
To enable the Compliance API, see the setup guide.
[Set up the Compliance API](../Other/manage-claude-compliance-api-access.md)
Copy page
API version 2026-10-21
1. [API reference](../Endpoints/http.md)
2. [Compliance API](../Endpoints/http-compliance.md)
3. [Apps](https://platform.claude.com/docs/en/api/http/compliance/apps)
# Code
Copy page
API version 2026-10-21
#### Code[Artifacts](https://platform.claude.com/docs/en/api/http/compliance/apps/code/artifacts)
##### [List Code Artifacts](https://platform.claude.com/docs/en/api/http/compliance/apps/code/artifacts/list)
GET/v1/compliance/apps/code/artifacts
List Claude Code Artifacts owned by organizations under the parent organization.
##### [Download Code Artifact Version Content](https://platform.claude.com/docs/en/api/http/compliance/apps/code/artifacts/retrieve_version)
GET/v1/compliance/apps/code/artifacts/{artifact_id}/versions/{version_id}
Streams the content of one version of an Artifact as the response body, in chunks with no `Content-Length`. With `multi_file_format=zip`, a version with more than one file, other than a Claude Doc's (an Artifact whose `artifact_type` is `claude_docs`), comes back as a ZIP archive of its files.
##### [Download Code Artifact Content](https://platform.claude.com/docs/en/api/http/compliance/apps/code/artifacts/download)
GET/v1/compliance/apps/code/artifacts/{artifact_id}/content
Streams an Artifact's current content as the response body, in chunks with no `Content-Length`.
##### [Delete Code Artifact](https://platform.claude.com/docs/en/api/http/compliance/apps/code/artifacts/delete)
DELETE/v1/compliance/apps/code/artifacts/{artifact_id}
Permanently deletes a Code Artifact and all its versions. This is a destructive operation that cannot be undone. A 200 response means the deletion is initiated and the Artifact is claimed; content removal completes asynchronously.
---
## List project attachments - Claude API Reference
Source: https://platform.claude.com/docs/en/api/compliance/apps/projects/attachments/list
Path: 04-API-Reference/Admin/compliance-apps-projects-attachments-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fcompliance%2Fapps%2Fprojects%2Fattachments%2Flist)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Chats
Projects
List projects
Get project details
Delete project
Attachments
List project attachments
Collaborators
Documents
Artifacts
Sessions
Code
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
To enable the Compliance API, see the setup guide.
[Set up the Compliance API](../Other/manage-claude-compliance-api-access.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Compliance API](../Endpoints/http-compliance.md)
3. [Apps](https://platform.claude.com/docs/en/api/http/compliance/apps)
4. [Projects](https://platform.claude.com/docs/en/api/http/compliance/apps/projects)
5. [Attachments](https://platform.claude.com/docs/en/api/http/compliance/apps/projects/attachments)
# List project attachments
Copy page
GET/v1/compliance/apps/projects/{project_id}/attachments
List files and documents attached to a project.
List files and project documents attached to the project referenced by project_id. This includes the IDs of attached files, and attached project documents.
The raw binary content of attached files can be downloaded using the GET /v1/compliance/apps/chats/files/{claude_file_id}/content endpoint.
The text content of attached project documents can be fetched using the GET /v1/compliance/apps/projects/documents/{claude_proj_doc_id} endpoint.
##### Path parameters
project_id: string
The project ID (tagged ID, e.g., claude_proj_abc123)
##### Query parameters
limit: optional number
Maximum results (default: 20, max: 100)
default20
minimum1
maximum100
page: optional string
Opaque pagination token from a previous response's `next_page` field. Pass this to retrieve the next page of results. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"x-api-key": optional string
##### Returns
data: array of ComplianceProjectFileReference or ComplianceProjectDocReference
List of attachments sorted chronologically by created_at, tie break by id
One of the following:
ComplianceProjectFileReference object{ type: "project_file", id, created_at, 4 more }
File attachment reference for compliance responses.
type: "project_file"
Discriminator marking this as a binary file
defaultproject_file
id: string
File identifier (e.g., 'claude_file_abcd')
created_at: string
Creation timestamp (RFC 3339 format)
formatdate-time
filename: string
Display name of the file (e.g., 'document.pdf')
md5: string or null
Lowercase hex MD5 of the file's preferred downloadable variant, when recorded. Null otherwise. Use the per-file `/metadata` endpoint for the authoritative value.
mime_type: string
MIME type of the file's preferred downloadable variant when one is recorded, else 'application/octet-stream'. Use the per-file `/metadata` endpoint for the authoritative value.
size_bytes: number or null
Size in bytes of the file's preferred downloadable variant, when recorded. Null otherwise. Use the per-file `/metadata` endpoint for the authoritative value.
ComplianceProjectDocReference object{ type: "project_doc", id, created_at, 3 more }
Project document attachment reference for compliance responses.
type: "project_doc"
Discriminator marking this as a plain text document
defaultproject_doc
id: string
Project document identifier (e.g., 'claude_proj_doc_abcd')
created_at: string
Creation timestamp (RFC 3339 format)
formatdate-time
filename: string
Display name of the document (e.g., 'document.txt')
mime_type: "text/plain"
MIME type of the project document, always set to plain text
defaulttext/plain
updated_at: string or null
Last-modified timestamp of the document. Reserved for future use — currently always null.
formatdate-time
has_more: boolean
Whether more records exist beyond the current result set
next_page: string or null
To get the next page, use the 'next_page' from the current response as the 'page' in your next request
List project attachments
cURL
```python
curl https://api.anthropic.com/v1/compliance/apps/projects/$PROJECT_ID/attachments \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
```
Response 200
```python
{
"data": [
{
"id": "id",
"created_at": "2019-12-27T18:11:19.117Z",
"filename": "filename",
"md5": "md5",
"mime_type": "mime_type",
"size_bytes": 0,
"type": "project_file"
}
],
"has_more": true,
"next_page": "next_page"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"id": "id",
"created_at": "2019-12-27T18:11:19.117Z",
---
## Attachments - Claude API Reference
Source: https://platform.claude.com/docs/en/api/compliance/apps/projects/attachments
Path: 04-API-Reference/Admin/compliance-apps-projects-attachments.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fcompliance%2Fapps%2Fprojects%2Fattachments)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Chats
Projects
List projects
Get project details
Delete project
Attachments
List project attachments
Collaborators
Documents
Artifacts
Sessions
Code
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
To enable the Compliance API, see the setup guide.
[Set up the Compliance API](../Other/manage-claude-compliance-api-access.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Compliance API](../Endpoints/http-compliance.md)
3. [Apps](https://platform.claude.com/docs/en/api/http/compliance/apps)
4. [Projects](https://platform.claude.com/docs/en/api/http/compliance/apps/projects)
# Attachments
Copy page
##### [List project attachments](https://platform.claude.com/docs/en/api/http/compliance/apps/projects/attachments/list)
GET/v1/compliance/apps/projects/{project_id}/attachments
List files and documents attached to a project.
##### Models
AttachmentListResponse = ComplianceProjectFileReference or ComplianceProjectDocReference
---
## List project collaborators - Claude API Reference
Source: https://platform.claude.com/docs/en/api/compliance/apps/projects/collaborators/list
Path: 04-API-Reference/Admin/compliance-apps-projects-collaborators-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fcompliance%2Fapps%2Fprojects%2Fcollaborators%2Flist)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Chats
Projects
List projects
Get project details
Delete project
Attachments
Collaborators
List project collaborators
Documents
Artifacts
Sessions
Code
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
To enable the Compliance API, see the setup guide.
[Set up the Compliance API](../Other/manage-claude-compliance-api-access.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Compliance API](../Endpoints/http-compliance.md)
3. [Apps](https://platform.claude.com/docs/en/api/http/compliance/apps)
4. [Projects](https://platform.claude.com/docs/en/api/http/compliance/apps/projects)
5. [Collaborators](https://platform.claude.com/docs/en/api/http/compliance/apps/projects/collaborators)
# List project collaborators
Copy page
GET/v1/compliance/apps/projects/{project_id}/collaborators
List the users, groups, and organization-wide grants on a project.
Each entry represents one active role assignment on the project. Principals are returned as a discriminated union on `type` — an individual user, an RBAC group, the whole organization, or all holders of an organization-level role.
##### Path parameters
project_id: string
The project ID (tagged ID, e.g., claude_proj_abc123)
##### Query parameters
limit: optional number
Maximum results (default: 20, max: 100)
default20
minimum1
maximum100
page: optional string
Opaque pagination token from a previous response's `next_page` field. Pass this to retrieve the next page of results. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"x-api-key": optional string
##### Returns
data: array of ComplianceProjectUserCollaborator or ComplianceProjectGroupCollaborator or ComplianceProjectOrganizationCollaborator or ComplianceProjectOrganizationRoleCollaborator
List of collaborators sorted chronologically by granted_at, tie break by the underlying role-assignment UUID
One of the following:
ComplianceProjectUserCollaborator object{ type: "user", granted_at, role, user_id }
An individual user granted a role on a project.
type: "user"
Discriminator marking this as an individual user collaborator
defaultuser
granted_at: string
When this collaborator was granted access (RFC 3339 format)
formatdate-time
role: "admin" or "editor" or "owner" or "viewer"
Role granted on the project
One of the following:
"admin"
"editor"
"owner"
"viewer"
user_id: string or null
Identifier of the user granted access (tagged ID), or null if their account has since been deleted
ComplianceProjectGroupCollaborator object{ type: "group", granted_at, group_id, role }
An RBAC group granted a role on a project.
type: "group"
Discriminator marking this as a group collaborator
defaultgroup
granted_at: string
When this collaborator was granted access (RFC 3339 format)
formatdate-time
group_id: string
Identifier of the group granted access (tagged ID)
role: "admin" or "editor" or "owner" or "viewer"
Role granted on the project
One of the following:
"admin"
"editor"
"owner"
"viewer"
ComplianceProjectOrganizationCollaborator object{ type: "organization", granted_at, organization_uuid, role }
An entire organization granted a role on a project.
type: "organization"
Discriminator marking this as an organization-wide grant
defaultorganization
granted_at: string
When this collaborator was granted access (RFC 3339 format)
formatdate-time
organization_uuid: string
UUID of the organization granted access
role: "admin" or "editor" or "owner" or "viewer"
Role granted on the project
One of the following:
"admin"
"editor"
"owner"
"viewer"
ComplianceProjectOrganizationRoleCollaborator object{ type: "organization_role", granted_at, organization_role, role }
All holders of an organization-level role granted a role on a project.
type: "organization_role"
Discriminator marking this as a grant to all organization members holding a specific org-level role
defaultorganization_role
granted_at: string
When this collaborator was granted access (RFC 3339 format)
formatdate-time
organization_role: string
The organization-level role whose holders are granted access
role: "admin" or "editor" or "owner" or "viewer"
Role granted on the project
One of the following:
"admin"
"editor"
"owner"
"viewer"
has_more: boolean
Whether more records exist beyond the current result set
next_page: string or null
To get the next page, use the 'next_page' from the current response as the 'page' in your next request
List project collaborators
cURL
```python
curl https://api.anthropic.com/v1/compliance/apps/projects/$PROJECT_ID/collaborators \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
```
Response 200
```python
{
"data": [
{
"granted_at": "2019-12-27T18:11:19.117Z",
"role": "admin",
"type": "user",
"user_id": "user_id"
}
],
"has_more": true,
"next_page": "next_page"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"granted_at": "2019-12-27T18:11:19.117Z",
---
## Collaborators - Claude API Reference
Source: https://platform.claude.com/docs/en/api/compliance/apps/projects/collaborators
Path: 04-API-Reference/Admin/compliance-apps-projects-collaborators.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fcompliance%2Fapps%2Fprojects%2Fcollaborators)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Chats
Projects
List projects
Get project details
Delete project
Attachments
Collaborators
List project collaborators
Documents
Artifacts
Sessions
Code
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
To enable the Compliance API, see the setup guide.
[Set up the Compliance API](../Other/manage-claude-compliance-api-access.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Compliance API](../Endpoints/http-compliance.md)
3. [Apps](https://platform.claude.com/docs/en/api/http/compliance/apps)
4. [Projects](https://platform.claude.com/docs/en/api/http/compliance/apps/projects)
# Collaborators
Copy page
##### [List project collaborators](https://platform.claude.com/docs/en/api/http/compliance/apps/projects/collaborators/list)
GET/v1/compliance/apps/projects/{project_id}/collaborators
List the users, groups, and organization-wide grants on a project.
##### Models
CollaboratorListResponse = ComplianceProjectUserCollaborator or ComplianceProjectGroupCollaborator or ComplianceProjectOrganizationCollaborator or ComplianceProjectOrganizationRoleCollaborator
---
## Delete project - Claude API Reference
Source: https://platform.claude.com/docs/en/api/compliance/apps/projects/delete
Path: 04-API-Reference/Admin/compliance-apps-projects-delete.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fcompliance%2Fapps%2Fprojects%2Fdelete)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Chats
Projects
List projects
Get project details
Delete project
Attachments
Collaborators
Documents
Artifacts
Sessions
Code
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
To enable the Compliance API, see the setup guide.
[Set up the Compliance API](../Other/manage-claude-compliance-api-access.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Compliance API](../Endpoints/http-compliance.md)
3. [Apps](https://platform.claude.com/docs/en/api/http/compliance/apps)
4. [Projects](https://platform.claude.com/docs/en/api/http/compliance/apps/projects)
# Delete project
Copy page
DELETE/v1/compliance/apps/projects/{project_id}
Delete a project for compliance purposes.
Hard-deletes the project and all its associated data including:
- All project documents and files
- All role assignments
- Knowledge base (if RAG is enabled)
- Sync sources
Project must have no attached chats - returns 409 if chats exist.
##### Path parameters
project_id: string
The project ID (tagged ID, e.g., claude_proj_abc123)
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"x-api-key": optional string
##### Returns
type: optional "claude_project_deleted"
Constant string confirming deletion.
defaultclaude_project_deleted
id: string
The ID of the Claude project that was deleted
Delete project
cURL
```python
curl https://api.anthropic.com/v1/compliance/apps/projects/$PROJECT_ID \
-X DELETE \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
```
Response 200
```python
{
"id": "id",
"type": "claude_project_deleted"
}
```
##### Returns Examples
Response 200
```python
{
"id": "id",
"type": "claude_project_deleted"
---
## Delete project document - Claude API Reference
Source: https://platform.claude.com/docs/en/api/compliance/apps/projects/documents/delete
Path: 04-API-Reference/Admin/compliance-apps-projects-documents-delete.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fcompliance%2Fapps%2Fprojects%2Fdocuments%2Fdelete)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Chats
Projects
List projects
Get project details
Delete project
Attachments
Collaborators
Documents
Get project document content
Get project document metadata
Delete project document
Artifacts
Sessions
Code
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
To enable the Compliance API, see the setup guide.
[Set up the Compliance API](../Other/manage-claude-compliance-api-access.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Compliance API](../Endpoints/http-compliance.md)
3. [Apps](https://platform.claude.com/docs/en/api/http/compliance/apps)
4. [Projects](https://platform.claude.com/docs/en/api/http/compliance/apps/projects)
5. [Documents](https://platform.claude.com/docs/en/api/http/compliance/apps/projects/documents)
# Delete project document
Copy page
DELETE/v1/compliance/apps/projects/documents/{document_id}
Delete a project document for compliance purposes.
Hard-deletes the project document permanently.
##### Path parameters
document_id: string
The document ID (tagged ID, e.g., claude_proj_doc_abc123)
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"x-api-key": optional string
##### Returns
type: "claude_project_document_deleted"
Constant string confirming deletion.
defaultclaude_project_document_deleted
id: string
The ID of the project document that was deleted
Delete project document
cURL
```python
curl https://api.anthropic.com/v1/compliance/apps/projects/documents/$DOCUMENT_ID \
-X DELETE \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
```
Response 200
```python
{
"id": "id",
"type": "claude_project_document_deleted"
}
```
##### Returns Examples
Response 200
```python
{
"id": "id",
"type": "claude_project_document_deleted"
---
## Get project document metadata - Claude API Reference
Source: https://platform.claude.com/docs/en/api/compliance/apps/projects/documents/metadata
Path: 04-API-Reference/Admin/compliance-apps-projects-documents-metadata.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fcompliance%2Fapps%2Fprojects%2Fdocuments%2Fmetadata)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Chats
Projects
List projects
Get project details
Delete project
Attachments
Collaborators
Documents
Get project document content
Get project document metadata
Delete project document
Artifacts
Sessions
Code
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
To enable the Compliance API, see the setup guide.
[Set up the Compliance API](../Other/manage-claude-compliance-api-access.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Compliance API](../Endpoints/http-compliance.md)
3. [Apps](https://platform.claude.com/docs/en/api/http/compliance/apps)
4. [Projects](https://platform.claude.com/docs/en/api/http/compliance/apps/projects)
5. [Documents](https://platform.claude.com/docs/en/api/http/compliance/apps/projects/documents)
# Get project document metadata
Copy page
GET/v1/compliance/apps/projects/documents/{document_id}/metadata
Returns metadata for a project document, without the content body.
Use the sibling `GET /v1/compliance/apps/projects/documents/{document_id}` endpoint to fetch the document text. The `md5` and `size_bytes` fields here are computed over the UTF-8 encoding of that text, so a DLP consumer can dedupe or match hashes without downloading every document.
##### Path parameters
document_id: string
The document ID (tagged ID, e.g., claude_proj_doc_abc123)
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"x-api-key": optional string
##### Returns
id: string
Project document identifier (tagged ID)
claude_project_id: string
The project this document belongs to
created_at: string
Document creation timestamp
formatdate-time
filename: string
Document filename
md5: string
Lowercase hex MD5 of the document content (UTF-8 encoded). Matches the `content` field returned by the sibling content endpoint.
mime_type: "text/plain"
MIME type of the document content, always plain text
defaulttext/plain
size_bytes: number
Size in bytes of the document content (UTF-8 encoded)
user: object{ id, email_address } or null
Document creator information, or null if the creator's account has been deleted or the creator is no longer a member of an organization the key may read
id: string
User identifier (tagged ID)
email_address: string
User's email address
Get project document metadata
cURL
```python
curl https://api.anthropic.com/v1/compliance/apps/projects/documents/$DOCUMENT_ID/metadata \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
```
Response 200
```python
{
"id": "id",
"claude_project_id": "claude_project_id",
"created_at": "2019-12-27T18:11:19.117Z",
"filename": "filename",
"md5": "md5",
"mime_type": "text/plain",
"size_bytes": 0,
"user": {
"id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"email_address": "jane.doe@example.com"
}
}
```
##### Returns Examples
Response 200
```python
{
"id": "id",
"claude_project_id": "claude_project_id",
"created_at": "2019-12-27T18:11:19.117Z",
"filename": "filename",
"md5": "md5",
"mime_type": "text/plain",
"size_bytes": 0,
"user": {
"id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"email_address": "jane.doe@example.com"
---
## Get project document content - Claude API Reference
Source: https://platform.claude.com/docs/en/api/compliance/apps/projects/documents/retrieve
Path: 04-API-Reference/Admin/compliance-apps-projects-documents-retrieve.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fcompliance%2Fapps%2Fprojects%2Fdocuments%2Fretrieve)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Chats
Projects
List projects
Get project details
Delete project
Attachments
Collaborators
Documents
Get project document content
Get project document metadata
Delete project document
Artifacts
Sessions
Code
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
To enable the Compliance API, see the setup guide.
[Set up the Compliance API](../Other/manage-claude-compliance-api-access.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Compliance API](../Endpoints/http-compliance.md)
3. [Apps](https://platform.claude.com/docs/en/api/http/compliance/apps)
4. [Projects](https://platform.claude.com/docs/en/api/http/compliance/apps/projects)
5. [Documents](https://platform.claude.com/docs/en/api/http/compliance/apps/projects/documents)
# Get project document content
Copy page
GET/v1/compliance/apps/projects/documents/{document_id}
Get detailed information for a specific project document.
##### Path parameters
document_id: string
The document ID (tagged ID, e.g., claude_proj_doc_abc123)
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"x-api-key": optional string
##### Returns
id: string
Project document identifier (tagged ID)
content: string
Document text content
created_at: string
Document creation timestamp
formatdate-time
filename: string
Document filename
user: object{ id, email_address } or null
Document creator information, or null if the creator's account has been deleted or the creator is no longer a member of an organization the key may read
id: string
User identifier (tagged ID)
email_address: string
User's email address
Get project document content
cURL
```python
curl https://api.anthropic.com/v1/compliance/apps/projects/documents/$DOCUMENT_ID \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
```
Response 200
```python
{
"id": "claude_proj_doc_01Qr8StUvWxYzAbCdEfGhJjK",
"content": "# Design notes\n\n- Item one\n- Item two\n",
"created_at": "2025-03-12T18:22:41.123456Z",
"filename": "design-notes.txt",
"user": {
"id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"email_address": "jane.doe@example.com"
}
}
```
##### Returns Examples
Response 200
```python
{
"id": "claude_proj_doc_01Qr8StUvWxYzAbCdEfGhJjK",
"content": "# Design notes\n\n- Item one\n- Item two\n",
"created_at": "2025-03-12T18:22:41.123456Z",
"filename": "design-notes.txt",
"user": {
"id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"email_address": "jane.doe@example.com"
---
## Documents - Claude API Reference
Source: https://platform.claude.com/docs/en/api/compliance/apps/projects/documents
Path: 04-API-Reference/Admin/compliance-apps-projects-documents.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fcompliance%2Fapps%2Fprojects%2Fdocuments)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Chats
Projects
List projects
Get project details
Delete project
Attachments
Collaborators
Documents
Get project document content
Get project document metadata
Delete project document
Artifacts
Sessions
Code
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
To enable the Compliance API, see the setup guide.
[Set up the Compliance API](../Other/manage-claude-compliance-api-access.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Compliance API](../Endpoints/http-compliance.md)
3. [Apps](https://platform.claude.com/docs/en/api/http/compliance/apps)
4. [Projects](https://platform.claude.com/docs/en/api/http/compliance/apps/projects)
# Documents
Copy page
##### [Get project document content](https://platform.claude.com/docs/en/api/http/compliance/apps/projects/documents/retrieve)
GET/v1/compliance/apps/projects/documents/{document_id}
Get detailed information for a specific project document.
##### [Get project document metadata](https://platform.claude.com/docs/en/api/http/compliance/apps/projects/documents/metadata)
GET/v1/compliance/apps/projects/documents/{document_id}/metadata
Returns metadata for a project document, without the content body.
##### [Delete project document](https://platform.claude.com/docs/en/api/http/compliance/apps/projects/documents/delete)
DELETE/v1/compliance/apps/projects/documents/{document_id}
Delete a project document for compliance purposes.
##### Models
DocumentRetrieveResponse object{ id, content, created_at, 2 more }
Project document information for compliance responses.
id: string
Project document identifier (tagged ID)
content: string
Document text content
created_at: string
Document creation timestamp
formatdate-time
filename: string
Document filename
user: object{ id, email_address } or null
Document creator information, or null if the creator's account has been deleted or the creator is no longer a member of an organization the key may read
id: string
User identifier (tagged ID)
email_address: string
User's email address
DocumentDeleteResponse object{ type: "claude_project_document_deleted", id }
Response for deleting a project document.
type: "claude_project_document_deleted"
Constant string confirming deletion.
defaultclaude_project_document_deleted
id: string
The ID of the project document that was deleted
DocumentMetadataResponse object{ id, claude_project_id, created_at, 5 more }
Project document metadata for GET /v1/compliance/apps/projects/documents/{document_id}/metadata.
Returns metadata only. Use the sibling endpoint (without `/metadata`) to fetch the document text content.
---
## List projects - Claude API Reference
Source: https://platform.claude.com/docs/en/api/compliance/apps/projects/list
Path: 04-API-Reference/Admin/compliance-apps-projects-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fcompliance%2Fapps%2Fprojects%2Flist)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Chats
Projects
List projects
Get project details
Delete project
Attachments
Collaborators
Documents
Artifacts
Sessions
Code
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
To enable the Compliance API, see the setup guide.
[Set up the Compliance API](../Other/manage-claude-compliance-api-access.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Compliance API](../Endpoints/http-compliance.md)
3. [Apps](https://platform.claude.com/docs/en/api/http/compliance/apps)
4. [Projects](https://platform.claude.com/docs/en/api/http/compliance/apps/projects)
# List projects
Copy page
GET/v1/compliance/apps/projects
Lists project metadata with filtering capabilities. Results are sorted chronologically (time ascending) by created_at.
##### Query parameters
created_at: optional object{ gt, gte, lt, lte }
gt: optional string
Filter projects created after this time (RFC 3339 format)
formatdate-time
gte: optional string
Filter projects created at or after this time (RFC 3339 format)
formatdate-time
lt: optional string
Filter projects created before this time (RFC 3339 format)
formatdate-time
lte: optional string
Filter projects created at or before this time (RFC 3339 format)
formatdate-time
limit: optional number
Maximum results (default: 20, max: 100)
default20
minimum1
maximum100
organization_ids: optional array of string
Filter by organization IDs (accepts `org_...` or organization UUID). Enumerate IDs via `GET /v1/compliance/organizations`.
page: optional string
Opaque pagination token from a previous response's `next_page` field. Pass this to retrieve the next page of results. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.
updated_at: optional object{ gt, gte, lt, lte }
gt: optional string
Filter projects updated after this time (RFC 3339 format)
formatdate-time
gte: optional string
Filter projects updated at or after this time (RFC 3339 format)
formatdate-time
lt: optional string
Filter projects updated before this time (RFC 3339 format)
formatdate-time
lte: optional string
Filter projects updated at or before this time (RFC 3339 format)
formatdate-time
user_ids: optional array of string
Filter by user IDs. Enumerate IDs via `GET /v1/compliance/organizations/{org_uuid}/users`.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"x-api-key": optional string
##### Returns
data: array of object{ id, created_at, deleted_at, 6 more }
List of projects sorted by creation date ascending
id: string
Project identifier (tagged ID)
created_at: string
Project creation timestamp
formatdate-time
deleted_at: string or null
Timestamp when the project was deleted by an end user, or null otherwise
formatdate-time
is_private: boolean
If false, the project is visible to all organization members; if true the project is accessible only to the creator and specified collaborators
name: string
Project name
organization_uuid: string
Organization UUID this project belongs to
updated_at: string
Project last update timestamp
formatdate-time
user: object{ id, email_address } or null
Project creator information, or null if the creator's account has been deleted or the creator is no longer a member of an organization the key may read
id: string
User identifier (tagged ID)
email_address: string
User's email address
organization_id: stringDeprecated
Organization identifier (tagged ID)
has_more: boolean
Whether more records exist beyond the current result set
next_page: string or null
Token to retrieve the next page. Use this as the 'page' parameter in your next request
List projects
cURL
```python
curl https://api.anthropic.com/v1/compliance/apps/projects \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
```
Response 200
```python
{
"data": [
{
"id": "claude_proj_abc123",
"name": "Q4 Product Planning",
"created_at": "2025-06-01T10:00:00Z",
"updated_at": "2025-06-15T14:30:00Z",
"is_private": true,
"organization_id": "org_abc123",
"organization_uuid": "abc12345-6789-0abc-def0-123456789abc",
"user": {
"id": "user_xyz456",
"email_address": "user@example.com"
}
}
],
"has_more": true,
"next_page": "page_eyJjcmVhdGVkX2F0IjoiMjAyNS0wNi0wMVQxMDowMDowMFoiLCJ1dWlkIjoiYWJjMTIzIn0="
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"id": "claude_proj_abc123",
"name": "Q4 Product Planning",
"created_at": "2025-06-01T10:00:00Z",
"updated_at": "2025-06-15T14:30:00Z",
"is_private": true,
"organization_id": "org_abc123",
"organization_uuid": "abc12345-6789-0abc-def0-123456789abc",
"user": {
"id": "user_xyz456",
"email_address": "user@example.com"
}
}
],
"has_more": true,
"next_page": "page_eyJjcmVhdGVkX2F0IjoiMjAyNS0wNi0wMVQxMDowMDowMFoiLCJ1dWlkIjoiYWJjMTIzIn0="
---
## Get project details - Claude API Reference
Source: https://platform.claude.com/docs/en/api/compliance/apps/projects/retrieve
Path: 04-API-Reference/Admin/compliance-apps-projects-retrieve.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fcompliance%2Fapps%2Fprojects%2Fretrieve)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Chats
Projects
List projects
Get project details
Delete project
Attachments
Collaborators
Documents
Artifacts
Sessions
Code
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
To enable the Compliance API, see the setup guide.
[Set up the Compliance API](../Other/manage-claude-compliance-api-access.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Compliance API](../Endpoints/http-compliance.md)
3. [Apps](https://platform.claude.com/docs/en/api/http/compliance/apps)
4. [Projects](https://platform.claude.com/docs/en/api/http/compliance/apps/projects)
# Get project details
Copy page
GET/v1/compliance/apps/projects/{project_id}
Get detailed information for a specific project.
##### Path parameters
project_id: string
The project ID (tagged ID, e.g., claude_proj_abc123)
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"x-api-key": optional string
##### Returns
id: string
Project identifier (tagged ID)
attachments_count: number
Number of attachments contained within this project
chats_count: number
Number of chats contained within this project
created_at: string
Project creation timestamp
formatdate-time
deleted_at: string or null
Timestamp when the project was deleted by an end user, or null otherwise
formatdate-time
description: string
Project description
instructions: string
Project's custom instructions / prompt
is_private: boolean
If false, the project is visible to all organization members; if true the project is accessible only to the creator and specified collaborators
name: string
Project name
organization_uuid: string
Organization UUID this project belongs to
updated_at: string
Project last update timestamp
formatdate-time
user: object{ id, email_address } or null
Project creator information, or null if the creator's account has been deleted or the creator is no longer a member of an organization the key may read
id: string
User identifier (tagged ID)
email_address: string
User's email address
organization_id: stringDeprecated
Organization identifier (tagged ID)
Get project details
cURL
```python
curl https://api.anthropic.com/v1/compliance/apps/projects/$PROJECT_ID \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
```
Response 200
```python
{
"id": "claude_proj_01Nm7PqRsTuVwXyZaBcDeFgH",
"attachments_count": 3,
"chats_count": 14,
"created_at": "2025-03-12T18:22:41.123456Z",
"deleted_at": "2019-12-27T18:11:19.117Z",
"description": "Planning and research for the Q3 launch",
"instructions": "Focus on concise, actionable answers.",
"is_private": true,
"name": "Q3 Product Launch",
"organization_id": "org_015eofRkKpogX7uDKUyvBTph",
"organization_uuid": "a1b2c3d4-e5f6-4789-a012-3456789abcde",
"updated_at": "2025-03-14T09:05:17.456789Z",
"user": {
"id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"email_address": "jane.doe@example.com"
}
}
```
##### Returns Examples
Response 200
```python
{
"id": "claude_proj_01Nm7PqRsTuVwXyZaBcDeFgH",
"attachments_count": 3,
"chats_count": 14,
"created_at": "2025-03-12T18:22:41.123456Z",
"deleted_at": "2019-12-27T18:11:19.117Z",
"description": "Planning and research for the Q3 launch",
"instructions": "Focus on concise, actionable answers.",
"is_private": true,
"name": "Q3 Product Launch",
"organization_id": "org_015eofRkKpogX7uDKUyvBTph",
"organization_uuid": "a1b2c3d4-e5f6-4789-a012-3456789abcde",
"updated_at": "2025-03-14T09:05:17.456789Z",
"user": {
"id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"email_address": "jane.doe@example.com"
---
## Projects - Claude API Reference
Source: https://platform.claude.com/docs/en/api/compliance/apps/projects
Path: 04-API-Reference/Admin/compliance-apps-projects.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fcompliance%2Fapps%2Fprojects)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Chats
Projects
List projects
Get project details
Delete project
Attachments
Collaborators
Documents
Artifacts
Sessions
Code
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
To enable the Compliance API, see the setup guide.
[Set up the Compliance API](../Other/manage-claude-compliance-api-access.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Compliance API](../Endpoints/http-compliance.md)
3. [Apps](https://platform.claude.com/docs/en/api/http/compliance/apps)
# Projects
Copy page
##### [List projects](https://platform.claude.com/docs/en/api/http/compliance/apps/projects/list)
GET/v1/compliance/apps/projects
Lists project metadata with filtering capabilities. Results are sorted chronologically (time ascending) by created_at.
##### [Get project details](https://platform.claude.com/docs/en/api/http/compliance/apps/projects/retrieve)
GET/v1/compliance/apps/projects/{project_id}
Get detailed information for a specific project.
##### [Delete project](https://platform.claude.com/docs/en/api/http/compliance/apps/projects/delete)
DELETE/v1/compliance/apps/projects/{project_id}
Delete a project for compliance purposes.
##### Models
ProjectRetrieveResponse object{ id, attachments_count, chats_count, 10 more }
Detailed project information for compliance responses.
ProjectListResponse object{ id, created_at, deleted_at, 6 more }
Project information for compliance responses.
ProjectDeleteResponse object{ type: "claude_project_deleted", id }
Response for deleting a Claude project.
type: optional "claude_project_deleted"
Constant string confirming deletion.
defaultclaude_project_deleted
id: string
The ID of the Claude project that was deleted
#### Projects[Attachments](https://platform.claude.com/docs/en/api/http/compliance/apps/projects/attachments)
##### [List project attachments](https://platform.claude.com/docs/en/api/http/compliance/apps/projects/attachments/list)
GET/v1/compliance/apps/projects/{project_id}/attachments
List files and documents attached to a project.
#### Projects[Collaborators](https://platform.claude.com/docs/en/api/http/compliance/apps/projects/collaborators)
##### [List project collaborators](https://platform.claude.com/docs/en/api/http/compliance/apps/projects/collaborators/list)
GET/v1/compliance/apps/projects/{project_id}/collaborators
List the users, groups, and organization-wide grants on a project.
#### Projects[Documents](https://platform.claude.com/docs/en/api/http/compliance/apps/projects/documents)
##### [Get project document content](https://platform.claude.com/docs/en/api/http/compliance/apps/projects/documents/retrieve)
GET/v1/compliance/apps/projects/documents/{document_id}
Get detailed information for a specific project document.
##### [Get project document metadata](https://platform.claude.com/docs/en/api/http/compliance/apps/projects/documents/metadata)
GET/v1/compliance/apps/projects/documents/{document_id}/metadata
Returns metadata for a project document, without the content body.
##### [Delete project document](https://platform.claude.com/docs/en/api/http/compliance/apps/projects/documents/delete)
DELETE/v1/compliance/apps/projects/documents/{document_id}
Delete a project document for compliance purposes.
---
## List local sessions - Claude API Reference
Source: https://platform.claude.com/docs/en/api/compliance/apps/sessions/local/list
Path: 04-API-Reference/Admin/compliance-apps-sessions-local-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fcompliance%2Fapps%2Fsessions%2Flocal%2Flist)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Chats
Projects
Artifacts
Sessions
Local
List local sessions
Retrieve a local session
Messages
Remote
Code
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[AWS IAM actions](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[Migrating to API version 2026-10-21](../Endpoints/migration-2026-10-21.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
To enable the Compliance API, see the setup guide.
[Set up the Compliance API](../Other/manage-claude-compliance-api-access.md)
Copy page
API version 2023-06-01
This page documents API version 2023-06-01. [See this page for the newer version, 2026-10-21](compliance-apps-sessions-local-list.md), or read [what changed in 2026-10-21](../Endpoints/migration-2026-10-21.md).
1. [API reference](../Endpoints/http.md)
2. [Compliance API](../Endpoints/http-compliance.md)
3. [Apps](https://platform.claude.com/docs/en/api/http/compliance/apps)
4. [Sessions](https://platform.claude.com/docs/en/api/http/compliance/apps/sessions)
5. [Local](https://platform.claude.com/docs/en/api/http/compliance/apps/sessions/local)
# List local sessions
Copy page
API version 2023-06-01
GET/v1/compliance/apps/sessions/local
List local sessions across the organizations the key may read.
Results are ordered by `created_at` descending. Pagination is forward-only via `next_page`; there is no reverse cursor.
##### Query parameters
created_at: optional object{ gt, gte, lt, lte }
gt: optional string
Only return sessions whose first inference call is strictly after this time (RFC 3339; a UTC offset is required).
formatdate-time
gte: optional string
Only return sessions whose first inference call is at or after this time (RFC 3339; a UTC offset is required).
formatdate-time
lt: optional string
Only return sessions whose first inference call is strictly before this time (RFC 3339; a UTC offset is required).
formatdate-time
lte: optional string
Only return sessions whose first inference call is at or before this time (RFC 3339; a UTC offset is required).
formatdate-time
limit: optional number
Maximum results (default: 100, max: 500)
default100
minimum1
maximum500
page: optional string
Opaque pagination token from a previous response's `next_page` field. Pass this to retrieve the next page of results. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.
updated_at: optional object{ gte }
gte: optional string
Only return sessions whose last inference call is at or after this time (RFC 3339; a UTC offset is required). Combines with the `created_at` filters and does not change the ordering or pagination. Use it to poll for sessions that have been active since a previous pass — a session that becomes active later can only enter the result, never leave it.
formatdate-time
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"x-api-key": optional string
##### Returns
data: array of object{ type: "compliance_local_session", id, created_at, 6 more }
Page of local sessions, ordered by `created_at` descending; ties are broken by a fixed server-side order. `updated_at` never participates in the ordering; the `updated_at.gte` query parameter filters on it without changing the order or the pagination cursor.
type: "compliance_local_session"
defaultcompliance_local_session
id: string
Local session identifier, prefixed `clls_`. Unique within the parent organization. Treat as an opaque string; the format may change without notice.
created_at: string
Timestamp of the session's first retained inference call (RFC 3339, UTC). When a session's activity spans the child organization's retention boundary, calls older than the boundary are no longer reflected, so this value is the timestamp of the earliest retained call: always strictly after the boundary, never the boundary itself.
formatdate-time
organization_uuid: string
UUID of the child organization the session belongs to
product_surface: string or null
The product the session ran in: `cowork` (Cowork in Claude Desktop on the user's machine); `claude_code` (Claude Code); `claude_science` (Claude Science); `claude_in_chrome` (the Claude in Chrome browser extension's built-in chat); `office_agents/excel`, `office_agents/powerpoint`, `office_agents/word` or `office_agents/outlook` (Claude for Microsoft 365, by app); `office_agents/google_docs`, `office_agents/google_sheets` or `office_agents/google_slides` (the Claude add-ins for Google Docs, Google Sheets, and Google Slides, by app); or `office_agents` alone (Claude for Microsoft 365 or one of the Google add-ins, app not identified). New values appear as coverage expands; treat unrecognized values as opaque. `null` when the surface was not recorded.
truncated: boolean
True when the session has more inference calls than the service can return for one session (100,000). The messages endpoint then returns only the session's earliest calls, up to that many, and ends before the session does; `updated_at` is a lower bound on the latest call and can differ between the list and retrieve endpoints. False for every session within that bound.
defaultfalse
updated_at: string
Timestamp of the session's last retained inference call (RFC 3339, UTC). Always at or after `created_at`. When a session's activity spans the child organization's retention boundary, calls older than the boundary are no longer reflected — but because retention removes only the oldest calls, this value (unlike `created_at`) is unaffected until the entire session has aged out. On the list endpoint this value is a lower bound: for a session still active at a page boundary or the upper end of a `created_at` window it can momentarily lag the session's true last activity. Retrieving the session, or its messages, always reflects the exact latest retained call.
formatdate-time
user: object{ id, email_address }
The authenticated user at the time of the session. Always set; `user.id` is always populated. `user.email_address` is null when the user's account has been deleted or the user is no longer a member of an organization the key may read.
id: string
User identifier (tagged ID, prefixed `user_`). Always set, so attribution survives after the user's account is deleted or the user leaves the organizations the key may read.
email_address: string or null
User's email address. Null when the user's account has been deleted or the user is no longer a member of an organization the key may read. The messages endpoint does not resolve email addresses; this field is always null there.
workspace_id: string or null
Workspace identifier (tagged ID, prefixed `wrkspc_`). Null for sessions not attributed to a workspace.
next_page: string or null
Opaque pagination cursor (prefixed `page_`) for the next page. Null when there is no further page. Treat as an opaque string; the format may change without notice.
List local sessions
cURL
```python
curl https://api.anthropic.com/v1/compliance/apps/sessions/local \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
```
Response 200
```python
{
"data": [
{
"type": "compliance_local_session",
"id": "clls_eyJ2IjoxLCJvIjoiOWEx…",
"organization_uuid": "9a1e0000-0000-0000-0000-000000000000",
"workspace_id": "wrkspc_01SvYKoWVRVHoEbwESNvzYdR",
"user": {
"id": "user_01GpKpLmNoPqRsTuVwXyZaBc",
"email_address": "engineer@example.com"
},
"product_surface": "cowork",
"created_at": "2026-07-09T14:02:11Z",
"updated_at": "2026-07-09T15:47:33Z"
}
]
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"type": "compliance_local_session",
"id": "clls_eyJ2IjoxLCJvIjoiOWEx…",
"organization_uuid": "9a1e0000-0000-0000-0000-000000000000",
"workspace_id": "wrkspc_01SvYKoWVRVHoEbwESNvzYdR",
"user": {
"id": "user_01GpKpLmNoPqRsTuVwXyZaBc",
"email_address": "engineer@example.com"
},
"product_surface": "cowork",
"created_at": "2026-07-09T14:02:11Z",
"updated_at": "2026-07-09T15:47:33Z"
---
## Retrieve local session messages - Claude API Reference
Source: https://platform.claude.com/docs/en/api/compliance/apps/sessions/local/messages/list
Path: 04-API-Reference/Admin/compliance-apps-sessions-local-messages-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fcompliance%2Fapps%2Fsessions%2Flocal%2Fmessages%2Flist)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Chats
Projects
Artifacts
Sessions
Local
List local sessions
Retrieve a local session
Messages
Retrieve local session messages
Remote
Code
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[AWS IAM actions](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[Migrating to API version 2026-10-21](../Endpoints/migration-2026-10-21.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
To enable the Compliance API, see the setup guide.
[Set up the Compliance API](../Other/manage-claude-compliance-api-access.md)
Copy page
API version 2023-06-01
This page documents API version 2023-06-01. [See this page for the newer version, 2026-10-21](compliance-apps-sessions-local-messages-list.md), or read [what changed in 2026-10-21](../Endpoints/migration-2026-10-21.md).
1. [API reference](../Endpoints/http.md)
2. [Compliance API](../Endpoints/http-compliance.md)
3. [Apps](https://platform.claude.com/docs/en/api/http/compliance/apps)
4. [Sessions](https://platform.claude.com/docs/en/api/http/compliance/apps/sessions)
5. [Local](https://platform.claude.com/docs/en/api/http/compliance/apps/sessions/local)
6. [Messages](https://platform.claude.com/docs/en/api/http/compliance/apps/sessions/local/messages)
# Retrieve local session messages
Copy page
API version 2023-06-01
GET/v1/compliance/apps/sessions/local/{local_session_id}/messages
Read one local session's transcript, oldest-first by default.
Retention is enforced read-side: turns at or before the child organization's retention boundary are never returned; a session that straddles the boundary carries one leading `content_unavailable` placeholder (`reason: "retention_elapsed"`) in their place. The boundary is pinned on the walk's first page and honored for 24 hours: a cursor older than that is rejected with an explicit 400; restart the walk to read under the current boundary.
On a very large session, some pages are too large to read and return a 400; retrying does not help. If the request used `order=desc`, read the session oldest first from its first page instead (omit `order` and `page`, then follow `next_page`). Rarely, an oldest-first page returns this 400 too; contact Anthropic support and quote the `request-id` response header.
##### Path parameters
local_session_id: string
##### Query parameters
limit: optional number
Maximum results (default: 100, max: 1000)
default100
minimum1
maximum1000
order: optional "asc" or "desc"
Sort direction. `asc` (oldest-first, default) or `desc`. On very large sessions some pages are too large to read and return a 400, far more often with `desc`; read those sessions with `asc`, starting again from the first page.
defaultasc
One of the following:
"asc"
"desc"
page: optional string
Opaque pagination token from a previous response's `next_page` field. Pass this to retrieve the next page of results. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.
tool_result_max_bytes: optional number
Truncate each text item inside a tool result to at most this many bytes (cut on a code-point boundary). Pass `-1` to request the server maximum (approximately 1 MiB); larger values are clamped to it. `0` is not a valid value.
default10000
minimum-1
maximum2147483647
tool_use_input_max_bytes: optional number
Truncate each tool-use input to at most this many bytes (cut on a code-point boundary so the result is valid UTF-8). Pass `-1` to request the server maximum (approximately 1 MiB); larger values are clamped to it. `0` is not a valid value.
default10000
minimum-1
maximum2147483647
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"x-api-key": optional string
##### Returns
data: array of object{ type: "compliance_local_session_message", id, content, 4 more }
Transcript turns for this page, in call order: oldest call first by default, newest call first with `order=desc`. The messages of one call carry the call's timestamp and follow each other in transcript order; a page boundary can fall between them.
type: "compliance_local_session_message"
defaultcompliance_local_session_message
id: string
Message identifier, prefixed `clsm_`. Stable for as long as the message's turn is retained: identifiers of retained turns do not change as older turns age out of the organization's retention period. The `retention_elapsed` placeholder's identifier is distinct from every retained turn's and changes only when further turns age out.
content: array of Text or ToolUse or ToolResult
Content blocks within the message, discriminated on `type` (`text` / `tool_use` / `tool_result`: the same discriminator values as the claude.ai chat-messages endpoint; the tool variants omit `integration_name` and `mcp_server_url`, and `text` carries `truncated`). Extended-thinking content is never included. The request's `system` field is never included; a presence-only marker message is emitted when it was set. The request's `tools[]` definitions are never included as transcript messages. Project-level instructions (such as CLAUDE.md files) appear in the message stream as a user-role context block and are included. Empty when `provenance.type` is `content_unavailable`.
One of the following:
Text object{ type: "text", text, truncated }
Text content block.
type: "text"
defaulttext
text: string
Text content from the user or the assistant
truncated: boolean
True when `text` was shortened by the server's fixed per-string bound (approximately 1 MiB), or when ancillary content the block carried (such as citations) was omitted, or when this block stands in for a non-text block whose content is not shown, or when it is an explanatory marker the server inserted (its text enclosed in square brackets, e.g. prefacing client-asserted history). There is no request parameter that raises the per-string bound.
defaultfalse
ToolUse object{ type: "tool_use", id, input, 2 more }
Tool invocation requested by the assistant.
type: "tool_use"
defaulttool_use
id: string or null
Tool-use ID, e.g. 'toolu_01AbC...'
input: string
Arguments passed to the tool, as a JSON-encoded string. May be shortened (see the `truncated` field); a truncated value is cut mid-document and is not valid JSON.
name: string
Name of the tool invoked
truncated: boolean
True when `input` was shortened. Pass `tool_use_input_max_bytes=-1` to request the server maximum.
defaultfalse
ToolResult object{ type: "tool_result", content, is_error, 3 more }
Result returned by a tool invocation.
type: "tool_result"
defaulttool_result
content: array of object{ type: "text", text }
Text content returned by the tool. Non-text item types are omitted and signalled via `truncated` with an in-band item-count marker.
type: "text"
defaulttext
text: string
Text returned by the tool
is_error: boolean
True when the tool reported an error
name: string
Name of the tool that produced this result
tool_use_id: string or null
ID of the tool_use block this result responds to
truncated: boolean
True when one or more text items in `content` were shortened or non-text items were omitted. Pass `tool_result_max_bytes=-1` to request the server maximum.
defaultfalse
created_at: string
When the message was recorded (RFC 3339, UTC)
formatdate-time
model: string or null
The model that served this assistant turn, as reported in the `model` field of the underlying Messages API response. Null on user messages and on any assistant message whose `provenance` is set: client-asserted history and synthetic markers were not produced by a model during this session, and for unavailable content the serving model is not known.
provenance: ContentUnavailable or ClientAsserted or SyntheticMarker or null
Where this turn's content came from, discriminated on `type`. Null (the common case) means verified content: on an assistant message, content Claude produced during this session; on a user message, content the user sent. `content_unavailable`: the turn's content cannot be returned and `content` is empty; `reason` says why. `client_asserted`: assistant content the client supplied as conversation history; `content` shows what the model received but its authorship is not verified; never on user-role messages. `synthetic_marker`: a transcript marker the endpoint generated rather than content either party sent during the session. Both `client_asserted` and `synthetic_marker` can result from normal request or client processing, not only client modification. Callers should tolerate unrecognized `type` values.
One of the following:
ContentUnavailable object{ type: "content_unavailable", reason }
The turn's content cannot be returned; `content` is empty.
type: "content_unavailable"
defaultcontent_unavailable
reason: string
Why this turn's content cannot be returned, e.g. `not_captured` (the content was not captured for compliance retrieval), `client_aborted` (the client closed the connection or cancelled the request before the response completed, so the response was not captured for this turn; any partial output already streamed to the client is not included; assistant-role turns only), `cmek_key_revoked` (the content is encrypted under the organization's customer-managed key and that key is unavailable), `retention_elapsed` (the content lies past the organization's retention boundary; on the placeholder standing in for every pre-boundary turn), or `oversize` (the message exceeds the server's per-message size bound even after per-block truncation). Callers should tolerate unrecognized values. `not_captured` is not proof that no record was stored: content withheld by the storage layer's fail-closed access policies carries the same reason and is deliberately indistinguishable from content that was never captured.
ClientAsserted object{ type: "client_asserted" }
Assistant content the client supplied as conversation history rather than produced by Claude during this session. `content` shows what the model received but its authorship is not verified; this can result from normal request or client processing, not only client modification. Never on user-role messages.
type: "client_asserted"
defaultclient_asserted
SyntheticMarker object{ type: "synthetic_marker" }
A transcript marker generated by the endpoint rather than sent by either party during the session. Marker messages indicate that the prompt history diverged from what was captured, that the request's `system` field was present but is not shown, or that earlier turns that a request re-sent as history were withheld because they cannot be dated against the child organization's data-retention period (only for organizations with a finite retention period; the request's new user input after its last assistant turn is not affected). The marker's text names the cause. Markers that report a mismatch with captured history can result from normal request or client processing, not only client modification.
type: "synthetic_marker"
defaultsynthetic_marker
role: "assistant" or "user"
Message sender (`user` or `assistant`)
One of the following:
"assistant"
"user"
next_page: string or null
Opaque pagination cursor (prefixed `page_`) for the next page. Null when there is no further page. Treat as an opaque string; the format may change without notice.
session: object{ type: "compliance_local_session", id, created_at, 6 more }
The local session the messages belong to. `user.email_address` is always null on this endpoint; the messages endpoint does not resolve email addresses.
type: "compliance_local_session"
defaultcompliance_local_session
id: string
Local session identifier, prefixed `clls_`. Unique within the parent organization. Treat as an opaque string; the format may change without notice.
created_at: string
Timestamp of the session's first retained inference call (RFC 3339, UTC). When a session's activity spans the child organization's retention boundary, calls older than the boundary are no longer reflected, so this value is the timestamp of the earliest retained call: always strictly after the boundary, never the boundary itself.
formatdate-time
organization_uuid: string
UUID of the child organization the session belongs to
product_surface: string or null
The product the session ran in: `cowork` (Cowork in Claude Desktop on the user's machine); `claude_code` (Claude Code); `claude_science` (Claude Science); `claude_in_chrome` (the Claude in Chrome browser extension's built-in chat); `office_agents/excel`, `office_agents/powerpoint`, `office_agents/word` or `office_agents/outlook` (Claude for Microsoft 365, by app); `office_agents/google_docs`, `office_agents/google_sheets` or `office_agents/google_slides` (the Claude add-ins for Google Docs, Google Sheets, and Google Slides, by app); or `office_agents` alone (Claude for Microsoft 365 or one of the Google add-ins, app not identified). New values appear as coverage expands; treat unrecognized values as opaque. `null` when the surface was not recorded.
truncated: boolean
True when the session has more inference calls than the service can return for one session (100,000). The messages endpoint then returns only the session's earliest calls, up to that many, and ends before the session does; `updated_at` is a lower bound on the latest call and can differ between the list and retrieve endpoints. False for every session within that bound.
defaultfalse
updated_at: string
Timestamp of the session's last retained inference call (RFC 3339, UTC). Always at or after `created_at`. When a session's activity spans the child organization's retention boundary, calls older than the boundary are no longer reflected — but because retention removes only the oldest calls, this value (unlike `created_at`) is unaffected until the entire session has aged out. On the list endpoint this value is a lower bound: for a session still active at a page boundary or the upper end of a `created_at` window it can momentarily lag the session's true last activity. Retrieving the session, or its messages, always reflects the exact latest retained call.
formatdate-time
user: object{ id, email_address }
The authenticated user at the time of the session. Always set; `user.id` is always populated. `user.email_address` is null when the user's account has been deleted or the user is no longer a member of an organization the key may read.
id: string
User identifier (tagged ID, prefixed `user_`). Always set, so attribution survives after the user's account is deleted or the user leaves the organizations the key may read.
email_address: string or null
User's email address. Null when the user's account has been deleted or the user is no longer a member of an organization the key may read. The messages endpoint does not resolve email addresses; this field is always null there.
workspace_id: string or null
Workspace identifier (tagged ID, prefixed `wrkspc_`). Null for sessions not attributed to a workspace.
Retrieve local session messages
cURL
```python
curl https://api.anthropic.com/v1/compliance/apps/sessions/local/$LOCAL_SESSION_ID/messages \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
```
Response 200
```python
{
"data": [
{
"id": "clsm_eyJ2IjoxLCJsIjoi…",
"content": [
{
"text": "text",
"truncated": true,
"type": "text"
}
],
"created_at": "2025-03-12T18:22:41.123456Z",
"model": "claude-opus-5",
"provenance": {
"reason": "not_captured",
"type": "content_unavailable"
},
"role": "assistant",
"type": "compliance_local_session_message"
}
],
"next_page": "page_eyJ2IjoxLCJmIjoibSIs…",
"session": {
"id": "clls_eyJ2IjoxLCJvIjoiOWEx…",
"created_at": "2025-03-12T18:22:41.123456Z",
"organization_uuid": "a1b2c3d4-e5f6-4789-a012-3456789abcde",
"product_surface": "cowork",
"truncated": true,
"type": "compliance_local_session",
"updated_at": "2025-03-12T18:22:41.123456Z",
"user": {
"id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"email_address": "jane.doe@example.com"
},
"workspace_id": "wrkspc_01SvYKoWVRVHoEbwESNvzYdR"
}
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"id": "clsm_eyJ2IjoxLCJsIjoi…",
"content": [
{
"text": "text",
"truncated": true,
"type": "text"
}
],
"created_at": "2025-03-12T18:22:41.123456Z",
"model": "claude-opus-5",
"provenance": {
"reason": "not_captured",
"type": "content_unavailable"
},
"role": "assistant",
"type": "compliance_local_session_message"
}
],
"next_page": "page_eyJ2IjoxLCJmIjoibSIs…",
"session": {
"id": "clls_eyJ2IjoxLCJvIjoiOWEx…",
"created_at": "2025-03-12T18:22:41.123456Z",
"organization_uuid": "a1b2c3d4-e5f6-4789-a012-3456789abcde",
"product_surface": "cowork",
"truncated": true,
"type": "compliance_local_session",
"updated_at": "2025-03-12T18:22:41.123456Z",
"user": {
"id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"email_address": "jane.doe@example.com"
},
"workspace_id": "wrkspc_01SvYKoWVRVHoEbwESNvzYdR"
---
## Messages - Claude API Reference
Source: https://platform.claude.com/docs/en/api/compliance/apps/sessions/local/messages
Path: 04-API-Reference/Admin/compliance-apps-sessions-local-messages.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fcompliance%2Fapps%2Fsessions%2Flocal%2Fmessages)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Chats
Projects
Artifacts
Sessions
Local
List local sessions
Retrieve a local session
Messages
Retrieve local session messages
Remote
Code
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[AWS IAM actions](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[Migrating to API version 2026-10-21](../Endpoints/migration-2026-10-21.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
To enable the Compliance API, see the setup guide.
[Set up the Compliance API](../Other/manage-claude-compliance-api-access.md)
Copy page
API version 2023-06-01
This page documents API version 2023-06-01. [See this page for the newer version, 2026-10-21](compliance-apps-sessions-local-messages.md), or read [what changed in 2026-10-21](../Endpoints/migration-2026-10-21.md).
1. [API reference](../Endpoints/http.md)
2. [Compliance API](../Endpoints/http-compliance.md)
3. [Apps](https://platform.claude.com/docs/en/api/http/compliance/apps)
4. [Sessions](https://platform.claude.com/docs/en/api/http/compliance/apps/sessions)
5. [Local](https://platform.claude.com/docs/en/api/http/compliance/apps/sessions/local)
# Messages
Copy page
API version 2023-06-01
##### [Retrieve local session messages](https://platform.claude.com/docs/en/api/http/compliance/apps/sessions/local/messages/list)
GET/v1/compliance/apps/sessions/local/{local_session_id}/messages
Read one local session's transcript, oldest-first by default.
##### Models
MessageListResponse object{ type: "compliance_local_session_message", id, content, 4 more }
A single user or assistant turn in a local session transcript.
---
## Retrieve a local session - Claude API Reference
Source: https://platform.claude.com/docs/en/api/compliance/apps/sessions/local/retrieve
Path: 04-API-Reference/Admin/compliance-apps-sessions-local-retrieve.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fcompliance%2Fapps%2Fsessions%2Flocal%2Fretrieve)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Chats
Projects
Artifacts
Sessions
Local
List local sessions
Retrieve a local session
Messages
Remote
Code
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[AWS IAM actions](../Endpoints/claude-platform-on-aws-iam-actions.md)[Google Cloud IAM permissions](../Endpoints/claude-models-on-google-cloud-anthropic-managed-iam-permissions.md)[Versions](../Endpoints/versioning.md)[Migrating to API version 2026-10-21](../Endpoints/migration-2026-10-21.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
To enable the Compliance API, see the setup guide.
[Set up the Compliance API](../Other/manage-claude-compliance-api-access.md)
Copy page
API version 2026-10-21
1. [API reference](../Endpoints/http.md)
2. [Compliance API](../Endpoints/http-compliance.md)
3. [Apps](https://platform.claude.com/docs/en/api/http/compliance/apps)
4. [Sessions](https://platform.claude.com/docs/en/api/http/compliance/apps/sessions)
5. [Local](https://platform.claude.com/docs/en/api/http/compliance/apps/sessions/local)
# Retrieve a local session
Copy page
API version 2026-10-21
GET/v1/compliance/apps/sessions/local/{local_session_id}
Retrieve one local session.
The response is the same session object the list endpoint returns, with `user.email_address` resolved the same way. Retention is enforced when the response is served: a session whose every inference call has aged out returns 404.
##### Path parameters
local_session_id: string
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"x-api-key": optional string
##### Returns
type: "compliance_local_session"
defaultcompliance_local_session
id: string
Local session identifier, prefixed `clls_`. Unique within the parent organization. Treat as an opaque string; the format may change without notice.
created_at: string
Timestamp of the session's first retained inference call (RFC 3339, UTC). When a session's activity spans the child organization's retention boundary, calls older than the boundary are no longer reflected, so this value is the timestamp of the earliest retained call: always strictly after the boundary, never the boundary itself.
formatdate-time
organization_uuid: string
UUID of the child organization the session belongs to
product_surface: string or null
The product the session ran in: `cowork` (Cowork in Claude Desktop on the user's machine); `claude_code` (Claude Code); `claude_science` (Claude Science); `claude_in_chrome` (the Claude in Chrome browser extension's built-in chat); `office_agents/excel`, `office_agents/powerpoint`, `office_agents/word` or `office_agents/outlook` (Claude for Microsoft 365, by app); `office_agents/google_docs`, `office_agents/google_sheets` or `office_agents/google_slides` (the Claude add-ins for Google Docs, Google Sheets, and Google Slides, by app); or `office_agents` alone (Claude for Microsoft 365 or one of the Google add-ins, app not identified). New values appear as coverage expands; treat unrecognized values as opaque. `null` when the surface was not recorded.
truncated: boolean
True when the session has more inference calls than the service can return for one session (100,000). The messages endpoint then returns only the session's earliest calls, up to that many, and ends before the session does; `updated_at` is a lower bound on the latest call and can differ between the list and retrieve endpoints. False for every session within that bound.
defaultfalse
updated_at: string
Timestamp of the session's last retained inference call (RFC 3339, UTC). Always at or after `created_at`. When a session's activity spans the child organization's retention boundary, calls older than the boundary are no longer reflected — but because retention removes only the oldest calls, this value (unlike `created_at`) is unaffected until the entire session has aged out. On the list endpoint this value is a lower bound: for a session still active at a page boundary or the upper end of a `created_at` window it can momentarily lag the session's true last activity. Retrieving the session, or its messages, always reflects the exact latest retained call.
formatdate-time
user: object{ id, email_address }
The authenticated user at the time of the session. Always set; `user.id` is always populated. `user.email_address` is null when the user's account has been deleted or the user is no longer a member of an organization the key may read.
id: string
User identifier (tagged ID, prefixed `user_`). Always set, so attribution survives after the user's account is deleted or the user leaves the organizations the key may read.
email_address: string or null
User's email address. Null when the user's account has been deleted or the user is no longer a member of an organization the key may read. The messages endpoint does not resolve email addresses; this field is always null there.
workspace_id: string or null
Workspace identifier (tagged ID, prefixed `wrkspc_`). Null for sessions not attributed to a workspace.
Retrieve a local session
cURL
```python
curl https://api.anthropic.com/v1/compliance/apps/sessions/local/$LOCAL_SESSION_ID \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
```
Response 200
```python
{
"type": "compliance_local_session",
"id": "clls_eyJ2IjoxLCJvIjoiOWEx…",
"organization_uuid": "9a1e0000-0000-0000-0000-000000000000",
"workspace_id": "wrkspc_01SvYKoWVRVHoEbwESNvzYdR",
"user": {
"id": "user_01GpKpLmNoPqRsTuVwXyZaBc",
"email_address": "engineer@example.com"
},
"product_surface": "cowork",
"created_at": "2026-07-09T14:02:11Z",
"updated_at": "2026-07-09T15:47:33Z"
}
```
##### Returns Examples
Response 200
```python
{
"type": "compliance_local_session",
"id": "clls_eyJ2IjoxLCJvIjoiOWEx…",
"organization_uuid": "9a1e0000-0000-0000-0000-000000000000",
"workspace_id": "wrkspc_01SvYKoWVRVHoEbwESNvzYdR",
"user": {
"id": "user_01GpKpLmNoPqRsTuVwXyZaBc",
"email_address": "engineer@example.com"
},
"product_surface": "cowork",
"created_at": "2026-07-09T14:02:11Z",
"updated_at": "2026-07-09T15:47:33Z"
---
## Local - Claude API Reference
Source: https://platform.claude.com/docs/en/api/compliance/apps/sessions/local
Path: 04-API-Reference/Admin/compliance-apps-sessions-local.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fcompliance%2Fapps%2Fsessions%2Flocal)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Chats
Projects
Artifacts
Sessions
Local
List local sessions
Retrieve a local session
Messages
Remote
Code
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[AWS IAM actions](../Endpoints/claude-platform-on-aws-iam-actions.md)[Google Cloud IAM permissions](../Endpoints/claude-models-on-google-cloud-anthropic-managed-iam-permissions.md)[Versions](../Endpoints/versioning.md)[Migrating to API version 2026-10-21](../Endpoints/migration-2026-10-21.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
To enable the Compliance API, see the setup guide.
[Set up the Compliance API](../Other/manage-claude-compliance-api-access.md)
Copy page
API version 2026-10-21
1. [API reference](../Endpoints/http.md)
2. [Compliance API](../Endpoints/http-compliance.md)
3. [Apps](https://platform.claude.com/docs/en/api/http/compliance/apps)
4. [Sessions](https://platform.claude.com/docs/en/api/http/compliance/apps/sessions)
# Local
Copy page
API version 2026-10-21
##### [List local sessions](https://platform.claude.com/docs/en/api/http/compliance/apps/sessions/local/list)
GET/v1/compliance/apps/sessions/local
List local sessions across the organizations the key may read.
##### [Retrieve a local session](https://platform.claude.com/docs/en/api/http/compliance/apps/sessions/local/retrieve)
GET/v1/compliance/apps/sessions/local/{local_session_id}
Retrieve one local session.
##### Models
LocalRetrieveResponse object{ type: "compliance_local_session", id, created_at, 6 more }
A session that a user ran on their own computer in a Claude app while signed in with their organization account.
LocalListResponse object{ type: "compliance_local_session", id, created_at, 6 more }
A session that a user ran on their own computer in a Claude app while signed in with their organization account.
#### Local[Messages](https://platform.claude.com/docs/en/api/http/compliance/apps/sessions/local/messages)
##### [Retrieve local session messages](https://platform.claude.com/docs/en/api/http/compliance/apps/sessions/local/messages/list)
GET/v1/compliance/apps/sessions/local/{local_session_id}/messages
Read one local session's transcript, oldest-first by default.
---
## List remote sessions - Claude API Reference
Source: https://platform.claude.com/docs/en/api/compliance/apps/sessions/remote/list
Path: 04-API-Reference/Admin/compliance-apps-sessions-remote-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fcompliance%2Fapps%2Fsessions%2Fremote%2Flist)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Chats
Projects
Artifacts
Sessions
Local
Remote
List remote sessions
Messages
Code
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[AWS IAM actions](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[Migrating to API version 2026-10-21](../Endpoints/migration-2026-10-21.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
To enable the Compliance API, see the setup guide.
[Set up the Compliance API](../Other/manage-claude-compliance-api-access.md)
Copy page
API version 2023-06-01
This page documents API version 2023-06-01. [See this page for the newer version, 2026-10-21](compliance-apps-sessions-remote-list.md), or read [what changed in 2026-10-21](../Endpoints/migration-2026-10-21.md).
1. [API reference](../Endpoints/http.md)
2. [Compliance API](../Endpoints/http-compliance.md)
3. [Apps](https://platform.claude.com/docs/en/api/http/compliance/apps)
4. [Sessions](https://platform.claude.com/docs/en/api/http/compliance/apps/sessions)
5. [Remote](https://platform.claude.com/docs/en/api/http/compliance/apps/sessions/remote)
# List remote sessions
Copy page
API version 2023-06-01
GET/v1/compliance/apps/sessions/remote
List remote sessions (Cowork sessions that run in Anthropic-managed cloud environments) across the organizations the key may read.
Each entry carries session metadata only; retrieve a session's transcript from the messages endpoint. By default the list spans every such organization; pass up to 500 `organization_ids[]` values to narrow it. Pass 1 to 10 `user_ids[]` values to scope the list to specific users: that filter matches the session's owning user, so agent-owned sessions are excluded whenever it is set. Bound results in time with the `created_at` range parameters (`created_at.gte`, `created_at.gt`, `created_at.lt`, `created_at.lte`; RFC 3339). There is no `updated_at` filter.
Results are sorted newest first by `created_at`, with at most `limit` sessions per page (default 100, maximum 500). Pagination is forward-only: pass the response's `next_page` value back as `page` to retrieve the next page, and stop when `next_page` is null.
##### Query parameters
created_at: optional object{ gt, gte, lt, lte }
gt: optional string
Filter remote sessions created after this time (RFC 3339 format)
formatdate-time
gte: optional string
Filter remote sessions created at or after this time (RFC 3339 format)
formatdate-time
lt: optional string
Filter remote sessions created before this time (RFC 3339 format)
formatdate-time
lte: optional string
Filter remote sessions created at or before this time (RFC 3339 format)
formatdate-time
limit: optional number
Maximum results (default: 100, max: 500)
default100
minimum1
maximum500
organization_ids: optional array of string
Filter to specific child organization identifiers. Omit to enumerate every child organization the key may read.
maxItems500
page: optional string
Opaque pagination token from a previous response's `next_page` field. Pass this to retrieve the next page of results. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.
user_ids: optional array of string
Filter to sessions owned by specific users (max 10 per request). Agent-owned sessions are excluded when this filter is set.
maxItems10
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"x-api-key": optional string
##### Returns
data: array of object{ id, agent_id, claude_project_id, 7 more }
id: string
Remote session identifier
agent_id: string or null
Identifier of the automated agent that owns the session. Null for user-owned sessions. At most one of `user` and `agent_id` is set.
claude_project_id: string or null
ID of the project the session is bound to. Null when the session has no project binding.
created_at: string
When the session was created (RFC 3339, UTC)
formatdate-time
organization_uuid: string
UUID of the organization the session belongs to
product_surface: string or null
The Claude product the session was created from. Currently `cowork_remote`, for Cowork sessions started on claude.ai web or mobile. More values will appear as other surfaces launch, so treat any unrecognized value as an unclassified surface rather than an error. Null for sessions created before this field was recorded, for surfaces that do not stamp it, and for unrecognized tag values.
started_by_user: object{ id, email_address } or null
The user who initiated an agent-owned session (for example, by mentioning Claude in Slack or via a scheduled trigger). Null for user-owned sessions — where the session's `user` started it — and for agent sessions with no human initiator. For initiators no longer a member of an organization the key may read, the object is populated with `email_address` null.
id: string
User identifier
email_address: string or null
User's email address. Null when the user is no longer a member of an organization the key may read — `id` remains set so attribution is preserved. The messages endpoint does not resolve email addresses; this field is always null there.
status: string
Session lifecycle state. One of `active`, `paused`, `archived`, or `failed` — the lifecycle states the owning product surface exposes — plus `pending`, a brief transient state that resolves before any transcript content exists. The list endpoint includes `pending`; the messages endpoint returns 404 for it. Deleted sessions are not returned on either endpoint. Treat unrecognized values as an unknown state rather than an error.
updated_at: string
When the session was last modified (RFC 3339, UTC)
formatdate-time
user: object{ id, email_address } or null
The user who owns the session. Null for sessions owned by an automated agent rather than a user. At most one of `user` and `agent_id` is set. For users no longer a member of an organization the key may read, the object is populated with `email_address` null.
id: string
User identifier
email_address: string or null
User's email address. Null when the user is no longer a member of an organization the key may read — `id` remains set so attribution is preserved. The messages endpoint does not resolve email addresses; this field is always null there.
next_page: string or null
Opaque page token; pass as `page` to retrieve the next page. Null when no rows exist after this page. Treat this value as opaque; do not parse or store it long-term, as the format may change without notice.
List remote sessions
cURL
```python
curl https://api.anthropic.com/v1/compliance/apps/sessions/remote \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
```
Response 200
```python
{
"data": [
{
"id": "cse_01A0000000000000000000000",
"organization_uuid": "00000000-0000-0000-0000-000000000000",
"user": {
"id": "user_01A0000000000000000000000",
"email_address": "user@example.com"
},
"status": "active",
"created_at": "2026-01-02T03:04:05.000000Z",
"updated_at": "2026-01-02T03:04:05.000000Z",
"product_surface": "cowork_remote",
"claude_project_id": "claude_proj_01Nm7PqRsTuVwXyZaBcDeFgH"
}
],
"next_page": "page_AAE..."
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"id": "cse_01A0000000000000000000000",
"organization_uuid": "00000000-0000-0000-0000-000000000000",
"user": {
"id": "user_01A0000000000000000000000",
"email_address": "user@example.com"
},
"status": "active",
"created_at": "2026-01-02T03:04:05.000000Z",
"updated_at": "2026-01-02T03:04:05.000000Z",
"product_surface": "cowork_remote",
"claude_project_id": "claude_proj_01Nm7PqRsTuVwXyZaBcDeFgH"
}
],
"next_page": "page_AAE..."
---
## Retrieve remote session messages - Claude API Reference
Source: https://platform.claude.com/docs/en/api/compliance/apps/sessions/remote/messages/list
Path: 04-API-Reference/Admin/compliance-apps-sessions-remote-messages-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fcompliance%2Fapps%2Fsessions%2Fremote%2Fmessages%2Flist)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Chats
Projects
Artifacts
Sessions
Local
Remote
List remote sessions
Messages
Retrieve remote session messages
Code
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[AWS IAM actions](../Endpoints/claude-platform-on-aws-iam-actions.md)[Google Cloud IAM permissions](../Endpoints/claude-models-on-google-cloud-anthropic-managed-iam-permissions.md)[Versions](../Endpoints/versioning.md)[Migrating to API version 2026-10-21](../Endpoints/migration-2026-10-21.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
To enable the Compliance API, see the setup guide.
[Set up the Compliance API](../Other/manage-claude-compliance-api-access.md)
Copy page
API version 2026-10-21
1. [API reference](../Endpoints/http.md)
2. [Compliance API](../Endpoints/http-compliance.md)
3. [Apps](https://platform.claude.com/docs/en/api/http/compliance/apps)
4. [Sessions](https://platform.claude.com/docs/en/api/http/compliance/apps/sessions)
5. [Remote](https://platform.claude.com/docs/en/api/http/compliance/apps/sessions/remote)
6. [Messages](https://platform.claude.com/docs/en/api/http/compliance/apps/sessions/remote/messages)
# Retrieve remote session messages
Copy page
API version 2026-10-21
GET/v1/compliance/apps/sessions/remote/{claude_remote_session_id}/messages
Retrieve one remote session's transcript: user prompts, assistant responses, and tool calls and results. Thinking blocks and images are not included.
Messages are returned oldest first by default; pass `order=desc` to reverse. Pagination uses the same `page`/`next_page` scheme as the list endpoint, with at most `limit` messages per page (default 100, maximum 1000); keep paginating until `next_page` is null. `tool_use_input_max_bytes` and `tool_result_max_bytes` cap how many bytes of each tool-use input and each tool-result text item are returned; a block shortened by either cap carries `truncated: true`.
The response embeds the session's metadata under `session` alongside the paginated `data` array. On this endpoint `session.user.email_address` and `session.started_by_user` are always null; read them from the list endpoint instead.
Returns 404 while the session is still `pending`, for deleted sessions, and for sessions outside the organizations the key may read. A malformed session identifier returns 400.
##### Path parameters
claude_remote_session_id: string
The remote session identifier (`cse_...`) to retrieve
##### Query parameters
limit: optional number
Maximum results (default: 100, max: 1000)
default100
minimum1
maximum1000
order: optional "asc" or "desc"
Sort direction. `asc` (oldest-first) or `desc`.
defaultasc
One of the following:
"asc"
"desc"
page: optional string
Opaque pagination token from a previous response's `next_page` field. Pass this to retrieve the next page of results. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.
tool_result_max_bytes: optional number
Truncate each text item inside a tool result to at most this many bytes (cut on a code-point boundary). Pass `-1` to request the server maximum. `0` is not a valid value.
default10000
minimum-1
maximum2147483647
tool_use_input_max_bytes: optional number
Truncate each tool-use input to at most this many bytes (cut on a code-point boundary so the result is valid UTF-8). Pass `-1` to request the server maximum. `0` is not a valid value.
default10000
minimum-1
maximum2147483647
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"x-api-key": optional string
##### Returns
data: array of object{ id, content, content_unavailable, 3 more }
Transcript turns for this page, ordered by transcript position. `created_at` is a commit timestamp and may tie or invert under concurrent writes; do not re-sort by it.
id: string
Unique identifier for the message, e.g. `csev_abc123`
content: array of Text or ToolUse or ToolResult
Content blocks within the message
One of the following:
Text object{ type: "text", text, truncated }
Text content block.
type: "text"
defaulttext
text: string
Text content from the user or the assistant
truncated: boolean
True when `text` exceeded the server-defined maximum (approximately 1 MiB) and was shortened.
defaultfalse
ToolUse object{ type: "tool_use", id, input, 2 more }
Tool invocation requested by the assistant.
type: "tool_use"
defaulttool_use
id: string or null
Tool-use ID, e.g. 'toolu_01AbC...'
input: string
Arguments passed to the tool, as a JSON-encoded string. May be shortened — see the `truncated` field
name: string
Name of the tool invoked
truncated: boolean
True when `input` was shortened. Pass `tool_use_input_max_bytes=-1` to request full content, subject to the server-side maximum.
defaultfalse
ToolResult object{ type: "tool_result", content, is_error, 3 more }
Result returned by a tool invocation.
type: "tool_result"
defaulttool_result
content: array of object{ type: "text", text }
Text content returned by the tool. Non-text item types are omitted.
type: "text"
defaulttext
text: string
Text returned by the tool
is_error: boolean
True when the tool reported an error
name: string
Name of the tool that produced this result
tool_use_id: string or null
ID of the tool_use block this result responds to
truncated: boolean
True when one or more text items in `content` were shortened. Pass `tool_result_max_bytes=-1` to request full content, subject to the server-side maximum.
defaultfalse
content_unavailable: boolean
True when the stored content could not be returned — it could not be decrypted, or it exceeded the server's per-event size bound. `content` is empty in that case; this distinguishes 'no content' from 'content withheld'.
defaultfalse
created_at: string
When the message was recorded (RFC 3339, UTC)
formatdate-time
role: "assistant" or "user"
Message sender (`user` or `assistant`)
One of the following:
"assistant"
"user"
sent_by_user_id: string or null
Identifier of the human account that sent this turn on an agent-owned session. Null on user-owned sessions, where every user-role turn was sent by the session's `user`.
next_page: string or null
Opaque page token; pass as `page` to retrieve the next page. Null when no rows exist after this page. Treat this value as opaque; do not parse or store it long-term, as the format may change without notice.
session: object{ id, agent_id, claude_project_id, 7 more }
Session metadata. `started_by_user`, `user.email_address`, and `claude_project_id` are always null on this endpoint; the messages endpoint resolves neither email addresses nor project bindings.
id: string
Remote session identifier
agent_id: string or null
Identifier of the automated agent that owns the session. Null for user-owned sessions. At most one of `user` and `agent_id` is set.
claude_project_id: string or null
ID of the project the session is bound to. Null when the session has no project binding.
created_at: string
When the session was created (RFC 3339, UTC)
formatdate-time
organization_uuid: string
UUID of the organization the session belongs to
product_surface: string or null
The Claude product the session was created from. Currently `cowork_remote`, for Cowork sessions started on claude.ai web or mobile. More values will appear as other surfaces launch, so treat any unrecognized value as an unclassified surface rather than an error. Null for sessions created before this field was recorded, for surfaces that do not stamp it, and for unrecognized tag values.
started_by_user: object{ id, email_address } or null
The user who initiated an agent-owned session (for example, by mentioning Claude in Slack or via a scheduled trigger). Null for user-owned sessions — where the session's `user` started it — and for agent sessions with no human initiator. For initiators no longer a member of an organization the key may read, the object is populated with `email_address` null.
id: string
User identifier
email_address: string or null
User's email address. Null when the user is no longer a member of an organization the key may read — `id` remains set so attribution is preserved. The messages endpoint does not resolve email addresses; this field is always null there.
status: string
Session lifecycle state. One of `active`, `paused`, `archived`, or `failed` — the lifecycle states the owning product surface exposes — plus `pending`, a brief transient state that resolves before any transcript content exists. The list endpoint includes `pending`; the messages endpoint returns 404 for it. Deleted sessions are not returned on either endpoint. Treat unrecognized values as an unknown state rather than an error.
updated_at: string
When the session was last modified (RFC 3339, UTC)
formatdate-time
user: object{ id, email_address } or null
The user who owns the session. Null for sessions owned by an automated agent rather than a user. At most one of `user` and `agent_id` is set. For users no longer a member of an organization the key may read, the object is populated with `email_address` null.
id: string
User identifier
email_address: string or null
User's email address. Null when the user is no longer a member of an organization the key may read — `id` remains set so attribution is preserved. The messages endpoint does not resolve email addresses; this field is always null there.
Retrieve remote session messages
cURL
```python
curl https://api.anthropic.com/v1/compliance/apps/sessions/remote/$CLAUDE_REMOTE_SESSION_ID/messages \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
```
Response 200
```python
{
"data": [
{
"id": "id",
"content": [
{
"text": "text",
"truncated": true,
"type": "text"
}
],
"content_unavailable": true,
"created_at": "2019-12-27T18:11:19.117Z",
"role": "assistant",
"sent_by_user_id": "sent_by_user_id"
}
],
"next_page": "next_page",
"session": {
"id": "id",
"agent_id": "agent_id",
"claude_project_id": "claude_project_id",
"created_at": "2019-12-27T18:11:19.117Z",
"organization_uuid": "organization_uuid",
"product_surface": "product_surface",
"started_by_user": {
"id": "id",
"email_address": "email_address"
},
"status": "status",
"updated_at": "2019-12-27T18:11:19.117Z",
"user": {
"id": "id",
"email_address": "email_address"
}
}
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"id": "id",
"content": [
{
"text": "text",
"truncated": true,
"type": "text"
}
],
"content_unavailable": true,
"created_at": "2019-12-27T18:11:19.117Z",
"role": "assistant",
"sent_by_user_id": "sent_by_user_id"
}
],
"next_page": "next_page",
"session": {
"id": "id",
"agent_id": "agent_id",
"claude_project_id": "claude_project_id",
"created_at": "2019-12-27T18:11:19.117Z",
"organization_uuid": "organization_uuid",
"product_surface": "product_surface",
"started_by_user": {
"id": "id",
"email_address": "email_address"
},
"status": "status",
"updated_at": "2019-12-27T18:11:19.117Z",
"user": {
"id": "id",
"email_address": "email_address"
---
## Messages - Claude API Reference
Source: https://platform.claude.com/docs/en/api/compliance/apps/sessions/remote/messages
Path: 04-API-Reference/Admin/compliance-apps-sessions-remote-messages.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fcompliance%2Fapps%2Fsessions%2Fremote%2Fmessages)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Chats
Projects
Artifacts
Sessions
Local
Remote
List remote sessions
Messages
Retrieve remote session messages
Code
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[AWS IAM actions](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[Migrating to API version 2026-10-21](../Endpoints/migration-2026-10-21.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
To enable the Compliance API, see the setup guide.
[Set up the Compliance API](../Other/manage-claude-compliance-api-access.md)
Copy page
API version 2023-06-01
This page documents API version 2023-06-01. [See this page for the newer version, 2026-10-21](compliance-apps-sessions-remote-messages.md), or read [what changed in 2026-10-21](../Endpoints/migration-2026-10-21.md).
1. [API reference](../Endpoints/http.md)
2. [Compliance API](../Endpoints/http-compliance.md)
3. [Apps](https://platform.claude.com/docs/en/api/http/compliance/apps)
4. [Sessions](https://platform.claude.com/docs/en/api/http/compliance/apps/sessions)
5. [Remote](https://platform.claude.com/docs/en/api/http/compliance/apps/sessions/remote)
# Messages
Copy page
API version 2023-06-01
##### [Retrieve remote session messages](https://platform.claude.com/docs/en/api/http/compliance/apps/sessions/remote/messages/list)
GET/v1/compliance/apps/sessions/remote/{claude_remote_session_id}/messages
Retrieve one remote session's transcript: user prompts, assistant responses, and tool calls and results. Thinking blocks and images are not included.
##### Models
MessageListResponse object{ id, content, content_unavailable, 3 more }
A single user or assistant turn in a remote session transcript.
`content` is a discriminated union of `text`, `tool_use`, and `tool_result` blocks.
---
## Remote - Claude API Reference
Source: https://platform.claude.com/docs/en/api/compliance/apps/sessions/remote
Path: 04-API-Reference/Admin/compliance-apps-sessions-remote.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fcompliance%2Fapps%2Fsessions%2Fremote)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Chats
Projects
Artifacts
Sessions
Local
Remote
List remote sessions
Messages
Code
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[AWS IAM actions](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[Migrating to API version 2026-10-21](../Endpoints/migration-2026-10-21.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
To enable the Compliance API, see the setup guide.
[Set up the Compliance API](../Other/manage-claude-compliance-api-access.md)
Copy page
API version 2023-06-01
This page documents API version 2023-06-01. [See this page for the newer version, 2026-10-21](compliance-apps-sessions-remote.md), or read [what changed in 2026-10-21](../Endpoints/migration-2026-10-21.md).
1. [API reference](../Endpoints/http.md)
2. [Compliance API](../Endpoints/http-compliance.md)
3. [Apps](https://platform.claude.com/docs/en/api/http/compliance/apps)
4. [Sessions](https://platform.claude.com/docs/en/api/http/compliance/apps/sessions)
# Remote
Copy page
API version 2023-06-01
##### [List remote sessions](https://platform.claude.com/docs/en/api/http/compliance/apps/sessions/remote/list)
GET/v1/compliance/apps/sessions/remote
List remote sessions (Cowork sessions that run in Anthropic-managed cloud environments) across the organizations the key may read.
##### Models
RemoteListResponse object{ id, agent_id, claude_project_id, 7 more }
Metadata for one remote session, as returned in the list response and in the messages response's `session` field.
Carries session attributes only, not transcript content. Use the messages endpoint to retrieve a session's transcript.
#### Remote[Messages](https://platform.claude.com/docs/en/api/http/compliance/apps/sessions/remote/messages)
##### [Retrieve remote session messages](https://platform.claude.com/docs/en/api/http/compliance/apps/sessions/remote/messages/list)
GET/v1/compliance/apps/sessions/remote/{claude_remote_session_id}/messages
Retrieve one remote session's transcript: user prompts, assistant responses, and tool calls and results. Thinking blocks and images are not included.
---
## Sessions - Claude API Reference
Source: https://platform.claude.com/docs/en/api/compliance/apps/sessions
Path: 04-API-Reference/Admin/compliance-apps-sessions.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fcompliance%2Fapps%2Fsessions)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Chats
Projects
Artifacts
Sessions
Local
Remote
Code
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[AWS IAM actions](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[Migrating to API version 2026-10-21](../Endpoints/migration-2026-10-21.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
To enable the Compliance API, see the setup guide.
[Set up the Compliance API](../Other/manage-claude-compliance-api-access.md)
Copy page
API version 2023-06-01
This page documents API version 2023-06-01. [See this page for the newer version, 2026-10-21](compliance-apps-sessions.md), or read [what changed in 2026-10-21](../Endpoints/migration-2026-10-21.md).
1. [API reference](../Endpoints/http.md)
2. [Compliance API](../Endpoints/http-compliance.md)
3. [Apps](https://platform.claude.com/docs/en/api/http/compliance/apps)
# Sessions
Copy page
API version 2023-06-01
#### Sessions[Local](https://platform.claude.com/docs/en/api/http/compliance/apps/sessions/local)
##### [List local sessions](https://platform.claude.com/docs/en/api/http/compliance/apps/sessions/local/list)
GET/v1/compliance/apps/sessions/local
List local sessions across the organizations the key may read.
##### [Retrieve a local session](https://platform.claude.com/docs/en/api/http/compliance/apps/sessions/local/retrieve)
GET/v1/compliance/apps/sessions/local/{local_session_id}
Retrieve one local session.
#### SessionsLocal[Messages](https://platform.claude.com/docs/en/api/http/compliance/apps/sessions/local/messages)
##### [Retrieve local session messages](https://platform.claude.com/docs/en/api/http/compliance/apps/sessions/local/messages/list)
GET/v1/compliance/apps/sessions/local/{local_session_id}/messages
Read one local session's transcript, oldest-first by default.
#### Sessions[Remote](https://platform.claude.com/docs/en/api/http/compliance/apps/sessions/remote)
##### [List remote sessions](https://platform.claude.com/docs/en/api/http/compliance/apps/sessions/remote/list)
GET/v1/compliance/apps/sessions/remote
List remote sessions (Cowork sessions that run in Anthropic-managed cloud environments) across the organizations the key may read.
#### SessionsRemote[Messages](https://platform.claude.com/docs/en/api/http/compliance/apps/sessions/remote/messages)
##### [Retrieve remote session messages](https://platform.claude.com/docs/en/api/http/compliance/apps/sessions/remote/messages/list)
GET/v1/compliance/apps/sessions/remote/{claude_remote_session_id}/messages
Retrieve one remote session's transcript: user prompts, assistant responses, and tool calls and results. Thinking blocks and images are not included.
---
## Apps - Claude API Reference
Source: https://platform.claude.com/docs/en/api/compliance/apps
Path: 04-API-Reference/Admin/compliance-apps.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fcompliance%2Fapps)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Chats
Projects
Artifacts
Sessions
Code
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
To enable the Compliance API, see the setup guide.
[Set up the Compliance API](../Other/manage-claude-compliance-api-access.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Compliance API](../Endpoints/http-compliance.md)
# Apps
Copy page
#### Apps[Chats](https://platform.claude.com/docs/en/api/http/compliance/apps/chats)
##### [List chats](https://platform.claude.com/docs/en/api/http/compliance/apps/chats/list)
GET/v1/compliance/apps/chats
Lists chat metadata with filtering capabilities for targeted compliance review. Results are sorted chronologically (time ascending) by the `order_by` key, with ties broken by id.
##### [Delete chat](https://platform.claude.com/docs/en/api/http/compliance/apps/chats/delete)
DELETE/v1/compliance/apps/chats/{claude_chat_id}
Permanently deletes a chat and all associated messages and files. This is a destructive operation that cannot be undone.
#### AppsChats[Messages](https://platform.claude.com/docs/en/api/http/compliance/apps/chats/messages)
##### [Get chat messages](https://platform.claude.com/docs/en/api/http/compliance/apps/chats/messages/list)
GET/v1/compliance/apps/chats/{claude_chat_id}/messages
Retrieves message history and file metadata for a specific chat.
#### AppsChats[Files](https://platform.claude.com/docs/en/api/http/compliance/apps/chats/files)
##### [Get file metadata](https://platform.claude.com/docs/en/api/http/compliance/apps/chats/files/retrieve)
GET/v1/compliance/apps/chats/files/{claude_file_id}
Retrieves metadata for a file referenced in chat messages, without downloading the file content. Use the sibling `/content` endpoint to download the bytes.
##### [Delete file](https://platform.claude.com/docs/en/api/http/compliance/apps/chats/files/delete)
DELETE/v1/compliance/apps/chats/files/{claude_file_id}
Permanently deletes a specific file. This is a destructive operation that cannot be undone.
##### [Download file content](https://platform.claude.com/docs/en/api/http/compliance/apps/chats/files/download)
GET/v1/compliance/apps/chats/files/{claude_file_id}/content
Downloads the binary content of a file referenced in chat messages.
#### AppsChats[Generated Files](https://platform.claude.com/docs/en/api/http/compliance/apps/chats/generated_files)
##### [Get Claude-generated file metadata](https://platform.claude.com/docs/en/api/http/compliance/apps/chats/generated_files/retrieve)
GET/v1/compliance/apps/chats/generated-files/{claude_gen_file_id}
Returns metadata for a file the assistant created via tool use.
##### [Download a Claude-generated file](https://platform.claude.com/docs/en/api/http/compliance/apps/chats/generated_files/download)
GET/v1/compliance/apps/chats/generated-files/{claude_gen_file_id}/content
Downloads the binary content of a file the assistant created via tool use.
#### Apps[Projects](https://platform.claude.com/docs/en/api/http/compliance/apps/projects)
##### [List projects](https://platform.claude.com/docs/en/api/http/compliance/apps/projects/list)
GET/v1/compliance/apps/projects
Lists project metadata with filtering capabilities. Results are sorted chronologically (time ascending) by created_at.
##### [Get project details](https://platform.claude.com/docs/en/api/http/compliance/apps/projects/retrieve)
GET/v1/compliance/apps/projects/{project_id}
Get detailed information for a specific project.
##### [Delete project](https://platform.claude.com/docs/en/api/http/compliance/apps/projects/delete)
DELETE/v1/compliance/apps/projects/{project_id}
Delete a project for compliance purposes.
#### AppsProjects[Attachments](https://platform.claude.com/docs/en/api/http/compliance/apps/projects/attachments)
##### [List project attachments](https://platform.claude.com/docs/en/api/http/compliance/apps/projects/attachments/list)
GET/v1/compliance/apps/projects/{project_id}/attachments
List files and documents attached to a project.
#### AppsProjects[Collaborators](https://platform.claude.com/docs/en/api/http/compliance/apps/projects/collaborators)
##### [List project collaborators](https://platform.claude.com/docs/en/api/http/compliance/apps/projects/collaborators/list)
GET/v1/compliance/apps/projects/{project_id}/collaborators
List the users, groups, and organization-wide grants on a project.
#### AppsProjects[Documents](https://platform.claude.com/docs/en/api/http/compliance/apps/projects/documents)
##### [Get project document content](https://platform.claude.com/docs/en/api/http/compliance/apps/projects/documents/retrieve)
GET/v1/compliance/apps/projects/documents/{document_id}
Get detailed information for a specific project document.
##### [Get project document metadata](https://platform.claude.com/docs/en/api/http/compliance/apps/projects/documents/metadata)
GET/v1/compliance/apps/projects/documents/{document_id}/metadata
Returns metadata for a project document, without the content body.
##### [Delete project document](https://platform.claude.com/docs/en/api/http/compliance/apps/projects/documents/delete)
DELETE/v1/compliance/apps/projects/documents/{document_id}
Delete a project document for compliance purposes.
#### Apps[Artifacts](https://platform.claude.com/docs/en/api/http/compliance/apps/artifacts)
##### [Get artifact metadata](https://platform.claude.com/docs/en/api/http/compliance/apps/artifacts/retrieve)
GET/v1/compliance/apps/artifacts/{artifact_version_id}
Returns metadata for an artifact version, without the content body.
##### [Download artifact content](https://platform.claude.com/docs/en/api/http/compliance/apps/artifacts/download)
GET/v1/compliance/apps/artifacts/{artifact_version_id}/content
Download the content of an artifact version for compliance purposes.
#### AppsSessions[Local](https://platform.claude.com/docs/en/api/http/compliance/apps/sessions/local)
##### [List local sessions](https://platform.claude.com/docs/en/api/http/compliance/apps/sessions/local/list)
GET/v1/compliance/apps/sessions/local
List local sessions across the organizations the key may read.
##### [Retrieve a local session](https://platform.claude.com/docs/en/api/http/compliance/apps/sessions/local/retrieve)
GET/v1/compliance/apps/sessions/local/{local_session_id}
Retrieve one local session.
#### AppsSessionsLocal[Messages](https://platform.claude.com/docs/en/api/http/compliance/apps/sessions/local/messages)
##### [Retrieve local session messages](https://platform.claude.com/docs/en/api/http/compliance/apps/sessions/local/messages/list)
GET/v1/compliance/apps/sessions/local/{local_session_id}/messages
Read one local session's transcript, oldest-first by default.
#### AppsSessions[Remote](https://platform.claude.com/docs/en/api/http/compliance/apps/sessions/remote)
##### [List remote sessions](https://platform.claude.com/docs/en/api/http/compliance/apps/sessions/remote/list)
GET/v1/compliance/apps/sessions/remote
List remote sessions (Cowork sessions that run in Anthropic-managed cloud environments) across the organizations the key may read.
#### AppsSessionsRemote[Messages](https://platform.claude.com/docs/en/api/http/compliance/apps/sessions/remote/messages)
##### [Retrieve remote session messages](https://platform.claude.com/docs/en/api/http/compliance/apps/sessions/remote/messages/list)
GET/v1/compliance/apps/sessions/remote/{claude_remote_session_id}/messages
Retrieve one remote session's transcript: user prompts, assistant responses, and tool calls and results. Thinking blocks and images are not included.
#### AppsCode[Artifacts](https://platform.claude.com/docs/en/api/http/compliance/apps/code/artifacts)
##### [List Code Artifacts](https://platform.claude.com/docs/en/api/http/compliance/apps/code/artifacts/list)
GET/v1/compliance/apps/code/artifacts
List Claude Code Artifacts owned by organizations under the parent organization.
##### [Download Code Artifact Version Content](https://platform.claude.com/docs/en/api/http/compliance/apps/code/artifacts/retrieve_version)
GET/v1/compliance/apps/code/artifacts/{artifact_id}/versions/{version_id}
Streams the content of one version of a Claude Code Artifact as the response body.
##### [Download Code Artifact Content](https://platform.claude.com/docs/en/api/http/compliance/apps/code/artifacts/download)
GET/v1/compliance/apps/code/artifacts/{artifact_id}/content
Streams an Artifact's current content as the response body. For a Claude Doc, that is the Doc's text as a ZIP archive of Word files, one per text tab, and the request must set `multi_file_format=zip`. For any other Artifact, it is the latest version, as `GET /v1/compliance/apps/code/artifacts/{artifact_id}/versions/{version_id}` returns it.
##### [Delete Code Artifact](https://platform.claude.com/docs/en/api/http/compliance/apps/code/artifacts/delete)
DELETE/v1/compliance/apps/code/artifacts/{artifact_id}
Permanently deletes a Code Artifact and all its versions. This is a destructive operation that cannot be undone. A 200 response means the deletion is initiated and the Artifact is claimed; content removal completes asynchronously.
---
## Delete Code Artifact - Claude API Reference
Source: https://platform.claude.com/docs/en/api/compliance/code/artifacts/delete
Path: 04-API-Reference/Admin/compliance-code-artifacts-delete.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fcompliance%2Fcode%2Fartifacts%2Fdelete)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Code
Artifacts
List Code Artifacts
Download Code Artifact Version Content
Delete Code Artifact
Completions
Create a Text Completion Deprecated
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
To enable the Compliance API, see the setup guide.
[Set up the Compliance API](../Other/manage-claude-compliance-api-access.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Compliance API](../Endpoints/http-compliance.md)
3. [Code](https://platform.claude.com/docs/en/api/http/compliance/code)
4. [Artifacts](https://platform.claude.com/docs/en/api/http/compliance/code/artifacts)
# Delete Code Artifact
Copy page
DELETE/v1/compliance/apps/code/artifacts/{artifact_id}
Permanently deletes a Code Artifact and all its versions. This is a destructive operation that cannot be undone. A 200 response means the deletion is initiated and the Artifact is claimed; content removal completes asynchronously.
Returns 404 for Artifacts that don't exist or belong to another parent organization. Returns 404 on a repeated delete of an already-deleted Artifact.
##### Path parameters
artifact_id: string
The Artifact ID (tagged ID, e.g., cart_abc123)
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"x-api-key": optional string
##### Returns
type: "code_artifact_deleted"
Constant string confirming deletion
defaultcode_artifact_deleted
id: string
The ID of the Artifact that was deleted
Delete Code Artifact
cURL
```python
curl https://api.anthropic.com/v1/compliance/apps/code/artifacts/$ARTIFACT_ID \
-X DELETE \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
```
Response 200
```python
{
"id": "cart_xyz789",
"type": "code_artifact_deleted"
}
```
##### Returns Examples
Response 200
```python
{
"id": "cart_xyz789",
"type": "code_artifact_deleted"
---
## List Code Artifacts - Claude API Reference
Source: https://platform.claude.com/docs/en/api/compliance/code/artifacts/list
Path: 04-API-Reference/Admin/compliance-code-artifacts-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fcompliance%2Fcode%2Fartifacts%2Flist)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Code
Artifacts
List Code Artifacts
Download Code Artifact Version Content
Delete Code Artifact
Completions
Create a Text Completion Deprecated
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
To enable the Compliance API, see the setup guide.
[Set up the Compliance API](../Other/manage-claude-compliance-api-access.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Compliance API](../Endpoints/http-compliance.md)
3. [Code](https://platform.claude.com/docs/en/api/http/compliance/code)
4. [Artifacts](https://platform.claude.com/docs/en/api/http/compliance/code/artifacts)
# List Code Artifacts
Copy page
GET/v1/compliance/apps/code/artifacts
List Claude Code Artifacts owned by organizations under the parent organization.
Results are sorted by Artifact identifier. Pages may be short or empty while `next_page` is still set — continue until `next_page` is absent. Artifacts are sorted by identifier (not creation time): an Artifact published during an export may land before the cursor and be omitted, so for a point-in-time-complete export re-enumerate after publishing quiesces.
Artifacts owned by a since-deleted child organization are not returned.
##### Query parameters
limit: optional number
Maximum results (default: 20, max: 100)
default20
minimum1
maximum100
organization_ids: optional array of string
Filter by organization IDs (accepts `org_...` or organization UUID, up to 500). Enumerate IDs via `GET /v1/compliance/organizations`.
maxItems500
page: optional string
Opaque pagination token from a previous response's `next_page` field. Pass this to retrieve the next page of results. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.
updated_at: optional object{ gt, gte, lt, lte }
gt: optional string
Return only Artifacts updated after this time (RFC 3339 format). See `updated_at.gte` for the completeness caveat.
formatdate-time
gte: optional string
Return only Artifacts updated at or after this time (RFC 3339 format). Time filters match an eventually-consistent index and Artifacts published before this field was recorded never match — omit the time filter for compliance-complete enumeration. For incremental export, apply a generous overlap margin between windows and dedupe by `id`: adjacent tiling silently misses items whose index update lagged their publish.
formatdate-time
lt: optional string
Return only Artifacts updated before this time (RFC 3339 format). Multiple time operators are AND-ed to the tightest bound. See `updated_at.gte` for the completeness caveat.
formatdate-time
lte: optional string
Return only Artifacts updated at or before this time (RFC 3339 format). See `updated_at.gte` for the completeness caveat.
formatdate-time
user_ids: optional array of string
Filter by owner user IDs (up to 200). Enumerate IDs via `GET /v1/compliance/organizations/{org_uuid}/users`.
maxItems200
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"x-api-key": optional string
##### Returns
data: array of object{ id, artifact_type, organization_uuid, 6 more }
Page of Artifacts
id: string
Artifact identifier (tagged ID)
artifact_type: "claude_design" or "claude_design_systems" or "claude_docs" or 4 more
Which kind of Artifact this is: `code` for a site published from Claude Code, or the built-in Artifact type it was made from — `claude_docs` (Claude Docs), `claude_slides` (Slides), `claude_design` (Design), `claude_design_systems` (a design system) or `claude_motion` (Motion). `other` is an Artifact made from a built-in type this list does not name yet.
One of the following:
"claude_design"
"claude_design_systems"
"claude_docs"
"claude_motion"
"claude_slides"
"code"
"other"
organization_uuid: string
Organization UUID this Artifact belongs to
owner_user_id: string or null
Artifact owner's user identifier (tagged ID), or null for Artifacts published by an agent session rather than a user account. When set, it survives after the owner's account is deleted or the owner leaves every organization under the parent.
published_version_id: string or null
Identifier of the version a non-owner viewer would render when `read_mode` permits them — the version the owner has pinned for non-owner readers if one is pinned, otherwise the owner's latest. When `read_mode` is `owner` no non-owner renders any version; the field still reports which version would be served were read_mode widened.
read_mode: "org" or "owner" or "public" or "users"
Who can view this Artifact: only its owner, a named set of users, every member of its organization, or anyone on the internet (`public`)
One of the following:
"org"
"owner"
"public"
"users"
updated_at: string or null
Artifact last update timestamp, or null for Artifacts published before this field was recorded
formatdate-time
user: object{ id, email_address } or null
Artifact owner with email, or null if the Artifact was published by an agent session, the owner's account has been deleted, or the owner is no longer a member of an organization the key may read
id: string
User identifier (tagged ID)
email_address: string
User's email address
versions: array of object{ id, created_at, name }
Up to roughly 20 most-recently-published versions of this Artifact (older versions are not retained). Metadata only — use `GET /v1/compliance/apps/code/artifacts/{artifact_id}/versions/{version_id}` to download a version's content.
id: string
Opaque version identifier
created_at: string or null
When this version was published
formatdate-time
name: string
Artifact title at this version. Falls back to the version identifier when the title for an older version is no longer retained.
has_more: boolean
Whether `next_page` is set. May be true for a page whose next page is empty — continue until `next_page` is absent.
next_page: string or null
Token to retrieve the next page. Use this as the 'page' parameter in your next request
List Code Artifacts
cURL
```python
curl https://api.anthropic.com/v1/compliance/apps/code/artifacts \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
```
Response 200
```python
{
"data": [
{
"id": "cart_01Tu9VwXyZaBcDeFgHiJkLmN",
"artifact_type": "claude_docs",
"organization_uuid": "a1b2c3d4-e5f6-4789-a012-3456789abcde",
"owner_user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"published_version_id": "1741803761-9f3a",
"read_mode": "org",
"updated_at": "2025-03-14T09:05:17.456789Z",
"user": {
"id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"email_address": "jane.doe@example.com"
},
"versions": [
{
"id": "1741803761-9f3a",
"created_at": "2025-03-12T18:22:41.123456Z",
"name": "Team dashboard"
}
]
}
],
"has_more": true,
"next_page": "cGFnZV90b2tlbl9leGFtcGxlXzE3MzQ1Njc4OTA="
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"id": "cart_01Tu9VwXyZaBcDeFgHiJkLmN",
"artifact_type": "claude_docs",
"organization_uuid": "a1b2c3d4-e5f6-4789-a012-3456789abcde",
"owner_user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"published_version_id": "1741803761-9f3a",
"read_mode": "org",
"updated_at": "2025-03-14T09:05:17.456789Z",
"user": {
"id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"email_address": "jane.doe@example.com"
},
"versions": [
{
"id": "1741803761-9f3a",
"created_at": "2025-03-12T18:22:41.123456Z",
"name": "Team dashboard"
}
]
}
],
"has_more": true,
"next_page": "cGFnZV90b2tlbl9leGFtcGxlXzE3MzQ1Njc4OTA="
---
## Download Code Artifact Version Content - Claude API Reference
Source: https://platform.claude.com/docs/en/api/compliance/code/artifacts/retrieve_version
Path: 04-API-Reference/Admin/compliance-code-artifacts-retrieve-version.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fcompliance%2Fcode%2Fartifacts%2Fretrieve_version)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Code
Artifacts
List Code Artifacts
Download Code Artifact Version Content
Delete Code Artifact
Completions
Create a Text Completion Deprecated
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
To enable the Compliance API, see the setup guide.
[Set up the Compliance API](../Other/manage-claude-compliance-api-access.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Compliance API](../Endpoints/http-compliance.md)
3. [Code](https://platform.claude.com/docs/en/api/http/compliance/code)
4. [Artifacts](https://platform.claude.com/docs/en/api/http/compliance/code/artifacts)
# Download Code Artifact Version Content
Copy page
GET/v1/compliance/apps/code/artifacts/{artifact_id}/versions/{version_id}
Streams the content of one version of a Claude Code Artifact as the response body.
Returns 404 for Artifacts that don't exist or belong to another parent organization. A listed version id can start returning 404 if subsequent publishes rotated it out of retained history — re-list on 404. Returns 503 while the version's content upload is still in flight or was abandoned — retry with backoff. Returns 422 for a version that has more than one file, because the Compliance API returns only single-file versions. Do not retry a 422. The 422's `error.details.error_code` is `multi_file_unavailable`. Oversized encoded content aborts mid-stream: headers and initial bytes arrive but the body terminates early — an aborted chunked transfer is the only truncation signal for encoded content. `Content-MD5` is emitted only for identity-stored content; validate against it when present.
##### Path parameters
artifact_id: string
The Artifact ID (tagged ID, e.g., cart_abc123)
version_id: string
Opaque version identifier from the Artifact's `versions` list
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"x-api-key": optional string
Download Code Artifact Version Content
cURL
```python
curl https://api.anthropic.com/v1/compliance/apps/code/artifacts/$ARTIFACT_ID/versions/$VERSION_ID \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
---
## Artifacts - Claude API Reference
Source: https://platform.claude.com/docs/en/api/compliance/code/artifacts
Path: 04-API-Reference/Admin/compliance-code-artifacts.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fcompliance%2Fcode%2Fartifacts)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Code
Artifacts
List Code Artifacts
Download Code Artifact Version Content
Delete Code Artifact
Completions
Create a Text Completion Deprecated
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
To enable the Compliance API, see the setup guide.
[Set up the Compliance API](../Other/manage-claude-compliance-api-access.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Compliance API](../Endpoints/http-compliance.md)
3. [Code](https://platform.claude.com/docs/en/api/http/compliance/code)
# Artifacts
Copy page
##### [List Code Artifacts](https://platform.claude.com/docs/en/api/http/compliance/code/artifacts/list)
GET/v1/compliance/apps/code/artifacts
List Claude Code Artifacts owned by organizations under the parent organization.
##### [Download Code Artifact Version Content](https://platform.claude.com/docs/en/api/http/compliance/code/artifacts/retrieve_version)
GET/v1/compliance/apps/code/artifacts/{artifact_id}/versions/{version_id}
Streams the content of one version of a Claude Code Artifact as the response body.
##### [Delete Code Artifact](https://platform.claude.com/docs/en/api/http/compliance/code/artifacts/delete)
DELETE/v1/compliance/apps/code/artifacts/{artifact_id}
Permanently deletes a Code Artifact and all its versions. This is a destructive operation that cannot be undone. A 200 response means the deletion is initiated and the Artifact is claimed; content removal completes asynchronously.
##### Models
ArtifactListResponse object{ id, artifact_type, organization_uuid, 6 more }
An Artifact: a site published from Claude Code, or a document made from one of Anthropic's built-in Artifact types (Claude Docs, Slides, Design, …). `artifact_type` says which.
ArtifactDeleteResponse object{ type: "code_artifact_deleted", id }
Response for deleting a Code Artifact.
type: "code_artifact_deleted"
Constant string confirming deletion
defaultcode_artifact_deleted
id: string
The ID of the Artifact that was deleted
---
## Code - Claude API Reference
Source: https://platform.claude.com/docs/en/api/compliance/code
Path: 04-API-Reference/Admin/compliance-code.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fcompliance%2Fcode)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Code
Artifacts
Completions
Create a Text Completion Deprecated
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
To enable the Compliance API, see the setup guide.
[Set up the Compliance API](../Other/manage-claude-compliance-api-access.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Compliance API](../Endpoints/http-compliance.md)
# Code
Copy page
#### Code[Artifacts](https://platform.claude.com/docs/en/api/http/compliance/code/artifacts)
##### [List Code Artifacts](https://platform.claude.com/docs/en/api/http/compliance/code/artifacts/list)
GET/v1/compliance/apps/code/artifacts
List Claude Code Artifacts owned by organizations under the parent organization.
##### [Download Code Artifact Version Content](https://platform.claude.com/docs/en/api/http/compliance/code/artifacts/retrieve_version)
GET/v1/compliance/apps/code/artifacts/{artifact_id}/versions/{version_id}
Streams the content of one version of a Claude Code Artifact as the response body.
##### [Delete Code Artifact](https://platform.claude.com/docs/en/api/http/compliance/code/artifacts/delete)
DELETE/v1/compliance/apps/code/artifacts/{artifact_id}
Permanently deletes a Code Artifact and all its versions. This is a destructive operation that cannot be undone. A 200 response means the deletion is initiated and the Artifact is claimed; content removal completes asynchronously.
---
## List Compliance Groups - Claude API Reference
Source: https://platform.claude.com/docs/en/api/compliance/groups/list
Path: 04-API-Reference/Admin/compliance-groups-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fcompliance%2Fgroups%2Flist)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
List Compliance Groups
Get Compliance Group
Members
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
To enable the Compliance API, see the setup guide.
[Set up the Compliance API](../Other/manage-claude-compliance-api-access.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Compliance API](../Endpoints/http-compliance.md)
3. [Groups](https://platform.claude.com/docs/en/api/http/compliance/groups)
# List Compliance Groups
Copy page
GET/v1/compliance/groups
List Compliance Groups
##### Query parameters
limit: optional number
Maximum results (default: 500, max: 1000)
default500
minimum1
maximum1000
name_prefix: optional string
Filter groups by name prefix
default""
page: optional string
Opaque pagination token from a previous response's `next_page` field. Pass this to retrieve the next page of results. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"x-api-key": optional string
##### Returns
data: array of object{ id, created_at, description, 4 more }
List of groups
id: string
Group identifier (tagged ID)
created_at: string or null
Group creation timestamp (RFC 3339)
formatdate-time
description: string
Group description
name: string
Group name
roles: array of string or null
Role IDs assigned to this group.
source_type: string
How the group was created ('direct' or 'scim')
updated_at: string or null
Group last-updated timestamp (RFC 3339)
formatdate-time
has_more: boolean
Whether more records exist beyond the current result set
next_page: string or null
Token to retrieve the next page. Use this as the 'page' parameter in your next request
List Compliance Groups
cURL
```python
curl https://api.anthropic.com/v1/compliance/groups \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
```
Response 200
```python
{
"data": [
{
"id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"created_at": "2025-03-12T18:22:41.123456Z",
"description": "All members of the engineering organization",
"name": "Engineering Team",
"roles": [
"rbac_role_01SGBg3kEnZrdsVR2QmyJbvD",
"rbac_role_01HtCd4mFoAseWS3RnzKcwE7"
],
"source_type": "scim",
"updated_at": "2025-03-14T09:05:17.456789Z"
}
],
"has_more": true,
"next_page": "cGFnZV90b2tlbl9leGFtcGxlXzE3MzQ1Njc4OTA="
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"created_at": "2025-03-12T18:22:41.123456Z",
"description": "All members of the engineering organization",
"name": "Engineering Team",
"roles": [
"rbac_role_01SGBg3kEnZrdsVR2QmyJbvD",
"rbac_role_01HtCd4mFoAseWS3RnzKcwE7"
],
"source_type": "scim",
"updated_at": "2025-03-14T09:05:17.456789Z"
}
],
"has_more": true,
"next_page": "cGFnZV90b2tlbl9leGFtcGxlXzE3MzQ1Njc4OTA="
---
## List Compliance Group Members - Claude API Reference
Source: https://platform.claude.com/docs/en/api/compliance/groups/members/list
Path: 04-API-Reference/Admin/compliance-groups-members-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fcompliance%2Fgroups%2Fmembers%2Flist)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
List Compliance Groups
Get Compliance Group
Members
List Compliance Group Members
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
To enable the Compliance API, see the setup guide.
[Set up the Compliance API](../Other/manage-claude-compliance-api-access.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Compliance API](../Endpoints/http-compliance.md)
3. [Groups](https://platform.claude.com/docs/en/api/http/compliance/groups)
4. [Members](https://platform.claude.com/docs/en/api/http/compliance/groups/members)
# List Compliance Group Members
Copy page
GET/v1/compliance/groups/{group_id}/members
List Compliance Group Members
##### Path parameters
group_id: string
The group ID (tagged ID, e.g., rbac_group_abc123)
##### Query parameters
limit: optional number
Maximum results (default: 500, max: 1000)
default500
minimum1
maximum1000
page: optional string
Opaque pagination token from a previous response's `next_page` field. Pass this to retrieve the next page of results. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"x-api-key": optional string
##### Returns
data: array of object{ created_at, email, updated_at, user_id }
List of group members
created_at: string or null
Membership creation timestamp (RFC 3339)
formatdate-time
email: string
Member email address
updated_at: string or null
Membership last-updated timestamp (RFC 3339)
formatdate-time
user_id: string
Member user identifier (tagged ID)
has_more: boolean
Whether more records exist beyond the current result set
next_page: string or null
Token to retrieve the next page. Use this as the 'page' parameter in your next request
List Compliance Group Members
cURL
```python
curl https://api.anthropic.com/v1/compliance/groups/$GROUP_ID/members \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
```
Response 200
```python
{
"data": [
{
"created_at": "2025-03-12T18:22:41.123456Z",
"email": "jane.doe@example.com",
"updated_at": "2025-03-14T09:05:17.456789Z",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
}
],
"has_more": true,
"next_page": "cGFnZV90b2tlbl9leGFtcGxlXzE3MzQ1Njc4OTA="
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"created_at": "2025-03-12T18:22:41.123456Z",
"email": "jane.doe@example.com",
"updated_at": "2025-03-14T09:05:17.456789Z",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
}
],
"has_more": true,
"next_page": "cGFnZV90b2tlbl9leGFtcGxlXzE3MzQ1Njc4OTA="
---
## Members - Claude API Reference
Source: https://platform.claude.com/docs/en/api/compliance/groups/members
Path: 04-API-Reference/Admin/compliance-groups-members.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fcompliance%2Fgroups%2Fmembers)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
List Compliance Groups
Get Compliance Group
Members
List Compliance Group Members
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
To enable the Compliance API, see the setup guide.
[Set up the Compliance API](../Other/manage-claude-compliance-api-access.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Compliance API](../Endpoints/http-compliance.md)
3. [Groups](https://platform.claude.com/docs/en/api/http/compliance/groups)
# Members
Copy page
##### [List Compliance Group Members](https://platform.claude.com/docs/en/api/http/compliance/groups/members/list)
GET/v1/compliance/groups/{group_id}/members
##### Models
MemberListResponse object{ created_at, email, updated_at, user_id }
Group member for compliance responses.
created_at: string or null
Membership creation timestamp (RFC 3339)
formatdate-time
email: string
Member email address
updated_at: string or null
Membership last-updated timestamp (RFC 3339)
formatdate-time
user_id: string
Member user identifier (tagged ID)
---
## Get Compliance Group - Claude API Reference
Source: https://platform.claude.com/docs/en/api/compliance/groups/retrieve
Path: 04-API-Reference/Admin/compliance-groups-retrieve.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fcompliance%2Fgroups%2Fretrieve)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
List Compliance Groups
Get Compliance Group
Members
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
To enable the Compliance API, see the setup guide.
[Set up the Compliance API](../Other/manage-claude-compliance-api-access.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Compliance API](../Endpoints/http-compliance.md)
3. [Groups](https://platform.claude.com/docs/en/api/http/compliance/groups)
# Get Compliance Group
Copy page
GET/v1/compliance/groups/{group_id}
Get Compliance Group
##### Path parameters
group_id: string
The group ID (tagged ID, e.g., rbac_group_abc123)
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"x-api-key": optional string
##### Returns
id: string
Group identifier (tagged ID)
created_at: string or null
Group creation timestamp (RFC 3339)
formatdate-time
description: string
Group description
name: string
Group name
roles: array of string or null
Role IDs assigned to this group.
source_type: string
How the group was created ('direct' or 'scim')
updated_at: string or null
Group last-updated timestamp (RFC 3339)
formatdate-time
Get Compliance Group
cURL
```python
curl https://api.anthropic.com/v1/compliance/groups/$GROUP_ID \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
```
Response 200
```python
{
"id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"created_at": "2025-03-12T18:22:41.123456Z",
"description": "All members of the engineering organization",
"name": "Engineering Team",
"roles": [
"rbac_role_01SGBg3kEnZrdsVR2QmyJbvD",
"rbac_role_01HtCd4mFoAseWS3RnzKcwE7"
],
"source_type": "scim",
"updated_at": "2025-03-14T09:05:17.456789Z"
}
```
##### Returns Examples
Response 200
```python
{
"id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"created_at": "2025-03-12T18:22:41.123456Z",
"description": "All members of the engineering organization",
"name": "Engineering Team",
"roles": [
"rbac_role_01SGBg3kEnZrdsVR2QmyJbvD",
"rbac_role_01HtCd4mFoAseWS3RnzKcwE7"
],
"source_type": "scim",
"updated_at": "2025-03-14T09:05:17.456789Z"
---
## Groups - Claude API Reference
Source: https://platform.claude.com/docs/en/api/compliance/groups
Path: 04-API-Reference/Admin/compliance-groups.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fcompliance%2Fgroups)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
List Compliance Groups
Get Compliance Group
Members
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
To enable the Compliance API, see the setup guide.
[Set up the Compliance API](../Other/manage-claude-compliance-api-access.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Compliance API](../Endpoints/http-compliance.md)
# Groups
Copy page
##### [List Compliance Groups](https://platform.claude.com/docs/en/api/http/compliance/groups/list)
GET/v1/compliance/groups
##### [Get Compliance Group](https://platform.claude.com/docs/en/api/http/compliance/groups/retrieve)
GET/v1/compliance/groups/{group_id}
##### Models
GroupRetrieveResponse object{ id, created_at, description, 4 more }
Group information for compliance responses.
id: string
Group identifier (tagged ID)
created_at: string or null
Group creation timestamp (RFC 3339)
formatdate-time
description: string
Group description
name: string
Group name
roles: array of string or null
Role IDs assigned to this group.
source_type: string
How the group was created ('direct' or 'scim')
updated_at: string or null
Group last-updated timestamp (RFC 3339)
formatdate-time
GroupListResponse object{ id, created_at, description, 4 more }
Group information for compliance responses.
id: string
Group identifier (tagged ID)
created_at: string or null
Group creation timestamp (RFC 3339)
formatdate-time
description: string
Group description
name: string
Group name
roles: array of string or null
Role IDs assigned to this group.
source_type: string
How the group was created ('direct' or 'scim')
updated_at: string or null
Group last-updated timestamp (RFC 3339)
formatdate-time
#### Groups[Members](https://platform.claude.com/docs/en/api/http/compliance/groups/members)
##### [List Compliance Group Members](https://platform.claude.com/docs/en/api/http/compliance/groups/members/list)
GET/v1/compliance/groups/{group_id}/members
---
## List organizations - Claude API Reference
Source: https://platform.claude.com/docs/en/api/compliance/organizations/list
Path: 04-API-Reference/Admin/compliance-organizations-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fcompliance%2Forganizations%2Flist)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
List organizations
Users
User Preferences
Roles
Settings
Plugins
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
To enable the Compliance API, see the setup guide.
[Set up the Compliance API](../Other/manage-claude-compliance-api-access.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Compliance API](../Endpoints/http-compliance.md)
3. [Organizations](https://platform.claude.com/docs/en/api/http/compliance/organizations)
# List organizations
Copy page
GET/v1/compliance/organizations
List organizations under the parent organization.
Returns organizations sorted by creation date in ascending order. Use `limit` and `page` to paginate: each response includes `has_more` and a `next_page` token to pass on the next request.
##### Query parameters
limit: optional number
Maximum results (default: 1000, max: 1000)
default1000
minimum1
maximum1000
page: optional string
Opaque pagination token from a previous response's `next_page` field. Pass this to retrieve the next page of results. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"x-api-key": optional string
##### Returns
data: array of object{ created_at, name, uuid }
List of organizations sorted by creation date, ascending
created_at: string
Organization creation time (RFC 3339 format)
name: string
Organization name
uuid: string
Unique identifier for the organization (UUID format)
has_more: boolean
Whether more records exist beyond the current result set
next_page: optional string or null
Token to retrieve the next page. Use this as the 'page' parameter in your next request
List organizations
cURL
```python
curl https://api.anthropic.com/v1/compliance/organizations \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
```
Response 200
```python
{
"data": [
{
"created_at": "2025-03-12T18:22:41.123456+00:00",
"name": "Acme Corp",
"uuid": "a1b2c3d4-e5f6-4789-a012-3456789abcde"
}
],
"has_more": true,
"next_page": "cGFnZV90b2tlbl9leGFtcGxlXzE3MzQ1Njc4OTA="
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"created_at": "2025-03-12T18:22:41.123456+00:00",
"name": "Acme Corp",
"uuid": "a1b2c3d4-e5f6-4789-a012-3456789abcde"
}
],
"has_more": true,
"next_page": "cGFnZV90b2tlbl9leGFtcGxlXzE3MzQ1Njc4OTA="
---
## List Compliance Roles - Claude API Reference
Source: https://platform.claude.com/docs/en/api/compliance/organizations/roles/list
Path: 04-API-Reference/Admin/compliance-organizations-roles-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fcompliance%2Forganizations%2Froles%2Flist)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
List organizations
Users
User Preferences
Roles
List Compliance Roles
Get Compliance Role
Permissions
Settings
Plugins
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
To enable the Compliance API, see the setup guide.
[Set up the Compliance API](../Other/manage-claude-compliance-api-access.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Compliance API](../Endpoints/http-compliance.md)
3. [Organizations](https://platform.claude.com/docs/en/api/http/compliance/organizations)
4. [Roles](https://platform.claude.com/docs/en/api/http/compliance/organizations/roles)
# List Compliance Roles
Copy page
GET/v1/compliance/organizations/{org_uuid}/roles
List Compliance Roles
##### Path parameters
org_uuid: string
The organization UUID
##### Query parameters
limit: optional number
Maximum results (default: 500, max: 1000)
default500
minimum1
maximum1000
page: optional string
Opaque pagination token from a previous response's `next_page` field. Pass this to retrieve the next page of results. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"x-api-key": optional string
##### Returns
data: array of object{ id, created_at, description, 2 more }
List of roles
id: string
Role identifier (tagged ID)
created_at: string or null
Role creation timestamp (RFC 3339)
formatdate-time
description: string
Role description
name: string
Role name
updated_at: string or null
Role last-updated timestamp (RFC 3339)
formatdate-time
has_more: boolean
Whether more records exist beyond the current result set
next_page: string or null
Token to retrieve the next page. Use this as the 'page' parameter in your next request
List Compliance Roles
cURL
```python
curl https://api.anthropic.com/v1/compliance/organizations/$ORG_UUID/roles \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
```
Response 200
```python
{
"data": [
{
"id": "rbac_role_01SGBg3kEnZrdsVR2QmyJbvD",
"created_at": "2025-03-12T18:22:41.123456Z",
"description": "Full administrative access to organization settings and members",
"name": "Organization Admin",
"updated_at": "2025-03-14T09:05:17.456789Z"
}
],
"has_more": true,
"next_page": "cGFnZV90b2tlbl9leGFtcGxlXzE3MzQ1Njc4OTA="
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"id": "rbac_role_01SGBg3kEnZrdsVR2QmyJbvD",
"created_at": "2025-03-12T18:22:41.123456Z",
"description": "Full administrative access to organization settings and members",
"name": "Organization Admin",
"updated_at": "2025-03-14T09:05:17.456789Z"
}
],
"has_more": true,
"next_page": "cGFnZV90b2tlbl9leGFtcGxlXzE3MzQ1Njc4OTA="
---
## List Compliance Role Permissions - Claude API Reference
Source: https://platform.claude.com/docs/en/api/compliance/organizations/roles/permissions/list
Path: 04-API-Reference/Admin/compliance-organizations-roles-permissions-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fcompliance%2Forganizations%2Froles%2Fpermissions%2Flist)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
List organizations
Users
User Preferences
Roles
List Compliance Roles
Get Compliance Role
Permissions
List Compliance Role Permissions
Settings
Plugins
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
To enable the Compliance API, see the setup guide.
[Set up the Compliance API](../Other/manage-claude-compliance-api-access.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Compliance API](../Endpoints/http-compliance.md)
3. [Organizations](https://platform.claude.com/docs/en/api/http/compliance/organizations)
4. [Roles](https://platform.claude.com/docs/en/api/http/compliance/organizations/roles)
5. [Permissions](https://platform.claude.com/docs/en/api/http/compliance/organizations/roles/permissions)
# List Compliance Role Permissions
Copy page
GET/v1/compliance/organizations/{org_uuid}/roles/{role_id}/permissions
List Compliance Role Permissions
##### Path parameters
org_uuid: string
The organization UUID
role_id: string
The role ID (tagged ID, e.g., rbac_role_abc123)
##### Query parameters
limit: optional number
Maximum results (default: 500, max: 1000)
default500
minimum1
maximum1000
page: optional string
Opaque pagination token from a previous response's `next_page` field. Pass this to retrieve the next page of results. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"x-api-key": optional string
##### Returns
data: array of object{ action, resource_id, resource_type }
List of permissions
action: string
Action permitted on the resource
resource_id: string
Identifier of the resource the permission applies to
resource_type: string
Type of resource the permission applies to
has_more: boolean
Whether more records exist beyond the current result set
next_page: string or null
Token to retrieve the next page. Use this as the 'page' parameter in your next request
List Compliance Role Permissions
cURL
```python
curl https://api.anthropic.com/v1/compliance/organizations/$ORG_UUID/roles/$ROLE_ID/permissions \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
```
Response 200
```python
{
"data": [
{
"action": "claude_code",
"resource_id": "a1b2c3d4-e5f6-4789-a012-3456789abcde",
"resource_type": "organization"
}
],
"has_more": true,
"next_page": "cGFnZV90b2tlbl9leGFtcGxlXzE3MzQ1Njc4OTA="
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"action": "claude_code",
"resource_id": "a1b2c3d4-e5f6-4789-a012-3456789abcde",
"resource_type": "organization"
}
],
"has_more": true,
"next_page": "cGFnZV90b2tlbl9leGFtcGxlXzE3MzQ1Njc4OTA="
---
## Permissions - Claude API Reference
Source: https://platform.claude.com/docs/en/api/compliance/organizations/roles/permissions
Path: 04-API-Reference/Admin/compliance-organizations-roles-permissions.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fcompliance%2Forganizations%2Froles%2Fpermissions)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
List organizations
Users
User Preferences
Roles
List Compliance Roles
Get Compliance Role
Permissions
List Compliance Role Permissions
Settings
Plugins
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
To enable the Compliance API, see the setup guide.
[Set up the Compliance API](../Other/manage-claude-compliance-api-access.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Compliance API](../Endpoints/http-compliance.md)
3. [Organizations](https://platform.claude.com/docs/en/api/http/compliance/organizations)
4. [Roles](https://platform.claude.com/docs/en/api/http/compliance/organizations/roles)
# Permissions
Copy page
##### [List Compliance Role Permissions](https://platform.claude.com/docs/en/api/http/compliance/organizations/roles/permissions/list)
GET/v1/compliance/organizations/{org_uuid}/roles/{role_id}/permissions
##### Models
PermissionListResponse object{ action, resource_id, resource_type }
Permission granted by a role.
action: string
Action permitted on the resource
resource_id: string
Identifier of the resource the permission applies to
resource_type: string
Type of resource the permission applies to
---
## Get Compliance Role - Claude API Reference
Source: https://platform.claude.com/docs/en/api/compliance/organizations/roles/retrieve
Path: 04-API-Reference/Admin/compliance-organizations-roles-retrieve.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fcompliance%2Forganizations%2Froles%2Fretrieve)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
List organizations
Users
User Preferences
Roles
List Compliance Roles
Get Compliance Role
Permissions
Settings
Plugins
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
To enable the Compliance API, see the setup guide.
[Set up the Compliance API](../Other/manage-claude-compliance-api-access.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Compliance API](../Endpoints/http-compliance.md)
3. [Organizations](https://platform.claude.com/docs/en/api/http/compliance/organizations)
4. [Roles](https://platform.claude.com/docs/en/api/http/compliance/organizations/roles)
# Get Compliance Role
Copy page
GET/v1/compliance/organizations/{org_uuid}/roles/{role_id}
Get Compliance Role
##### Path parameters
org_uuid: string
The organization UUID
role_id: string
The role ID (tagged ID, e.g., rbac_role_abc123)
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"x-api-key": optional string
##### Returns
id: string
Role identifier (tagged ID)
created_at: string or null
Role creation timestamp (RFC 3339)
formatdate-time
description: string
Role description
name: string
Role name
updated_at: string or null
Role last-updated timestamp (RFC 3339)
formatdate-time
Get Compliance Role
cURL
```python
curl https://api.anthropic.com/v1/compliance/organizations/$ORG_UUID/roles/$ROLE_ID \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
```
Response 200
```python
{
"id": "rbac_role_01SGBg3kEnZrdsVR2QmyJbvD",
"created_at": "2025-03-12T18:22:41.123456Z",
"description": "Full administrative access to organization settings and members",
"name": "Organization Admin",
"updated_at": "2025-03-14T09:05:17.456789Z"
}
```
##### Returns Examples
Response 200
```python
{
"id": "rbac_role_01SGBg3kEnZrdsVR2QmyJbvD",
"created_at": "2025-03-12T18:22:41.123456Z",
"description": "Full administrative access to organization settings and members",
"name": "Organization Admin",
"updated_at": "2025-03-14T09:05:17.456789Z"
---
## Roles - Claude API Reference
Source: https://platform.claude.com/docs/en/api/compliance/organizations/roles
Path: 04-API-Reference/Admin/compliance-organizations-roles.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fcompliance%2Forganizations%2Froles)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
List organizations
Users
User Preferences
Roles
List Compliance Roles
Get Compliance Role
Permissions
Settings
Plugins
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
To enable the Compliance API, see the setup guide.
[Set up the Compliance API](../Other/manage-claude-compliance-api-access.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Compliance API](../Endpoints/http-compliance.md)
3. [Organizations](https://platform.claude.com/docs/en/api/http/compliance/organizations)
# Roles
Copy page
##### [List Compliance Roles](https://platform.claude.com/docs/en/api/http/compliance/organizations/roles/list)
GET/v1/compliance/organizations/{org_uuid}/roles
##### [Get Compliance Role](https://platform.claude.com/docs/en/api/http/compliance/organizations/roles/retrieve)
GET/v1/compliance/organizations/{org_uuid}/roles/{role_id}
##### Models
RoleRetrieveResponse object{ id, created_at, description, 2 more }
Role information for compliance responses.
id: string
Role identifier (tagged ID)
created_at: string or null
Role creation timestamp (RFC 3339)
formatdate-time
description: string
Role description
name: string
Role name
updated_at: string or null
Role last-updated timestamp (RFC 3339)
formatdate-time
RoleListResponse object{ id, created_at, description, 2 more }
Role information for compliance responses.
id: string
Role identifier (tagged ID)
created_at: string or null
Role creation timestamp (RFC 3339)
formatdate-time
description: string
Role description
name: string
Role name
updated_at: string or null
Role last-updated timestamp (RFC 3339)
formatdate-time
#### Roles[Permissions](https://platform.claude.com/docs/en/api/http/compliance/organizations/roles/permissions)
##### [List Compliance Role Permissions](https://platform.claude.com/docs/en/api/http/compliance/organizations/roles/permissions/list)
GET/v1/compliance/organizations/{org_uuid}/roles/{role_id}/permissions
---
## Get effective organization settings - Claude API Reference
Source: https://platform.claude.com/docs/en/api/compliance/organizations/settings/retrieve
Path: 04-API-Reference/Admin/compliance-organizations-settings-retrieve.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fcompliance%2Forganizations%2Fsettings%2Fretrieve)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
List organizations
Users
User Preferences
Roles
Settings
Get effective organization settings
Plugins
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
To enable the Compliance API, see the setup guide.
[Set up the Compliance API](../Other/manage-claude-compliance-api-access.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Compliance API](../Endpoints/http-compliance.md)
3. [Organizations](https://platform.claude.com/docs/en/api/http/compliance/organizations)
4. [Settings](https://platform.claude.com/docs/en/api/http/compliance/organizations/settings)
# Get effective organization settings
Copy page
GET/v1/compliance/organizations/{organization_id}/settings
Retrieve the effective settings for an organization.
Returns the settings currently in force for the given organization — the enforced state after all policies are applied, which may differ from what is configured in the admin console. Settings an organization's administrators cannot change (for example, ones controlled by Anthropic policy or not available to the organization) are omitted from the list. Settings that report a compliance arrangement with Anthropic are the exception: the HIPAA and Access Transparency settings are always included; the API zero data retention setting is reported for Claude Console organizations, and the Claude Code zero data retention and customer-managed encryption keys (CMEK) settings for Claude Enterprise organizations. Each reports whether the arrangement is in place at the organization level; a retention setting on an individual workspace is not reflected.
The organization must belong to the API key's organization hierarchy; unknown organizations and organizations outside the hierarchy return 404.
##### Path parameters
organization_id: string
The organization's UUID
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"x-api-key": optional string
##### Returns
type: optional "effective_organization_settings"
defaulteffective_organization_settings
api_keys: array of object{ type: "compliance_api_key", id, created_at, 5 more }
Compliance API keys configured for the organization hierarchy, ordered by creation time ascending. Key secret values are never included.
type: optional "compliance_api_key"
defaultcompliance_api_key
id: string
Unique identifier for the API key.
created_at: string
When the key was created.
formatdate-time
created_by_id: string or null
Identifier of the user who created the key, or null when the key was created by automation or its creator's account no longer exists.
is_active: boolean
Whether the key is currently active. A deactivated key is listed for audit visibility but cannot authenticate requests.
name: string
The name given to the API key when it was created.
scopes: array of string
The permission scopes granted to the key.
expires_at: optional string or null
When the key will stop authenticating, or null when the key does not expire.
formatdate-time
organization_id: string
settings: array of Boolean or Integer or String or 3 more
One of the following:
Boolean object{ type: "boolean", name, value }
A setting whose enforced value is a single true/false flag.
type: optional "boolean"
defaultboolean
name: "access_transparency_enabled" or "ai_powered_artifacts_enabled" or "api_workbench_feedback_collection_enabled" or 61 more
One of the following:
"access_transparency_enabled"
"ai_powered_artifacts_enabled"
"api_workbench_feedback_collection_enabled"
"api_zero_data_retention_enabled"
"artifact_connectors_enabled"
"ask_your_org_enabled"
"chat_cowork_unified_enabled"
"chat_enabled"
"claude_academy_inference_enabled"
"claude_ai_chat_sharing_enabled"
"claude_ai_feedback_collection_enabled"
"claude_ai_integration_sharing_enabled"
"claude_ai_skill_plugins_scanning_enabled"
"claude_code_desktop_bypass_permissions_enabled"
"claude_code_desktop_enabled"
"claude_code_fast_mode_enabled"
"claude_code_metrics_logging_enabled"
"claude_code_remote_control_enabled"
"claude_code_review_enabled"
"claude_code_routines_enabled"
"claude_code_security_enabled"
"claude_code_trusted_devices_required"
"claude_code_web_enabled"
"claude_code_workflows_enabled"
"claude_design_enabled"
"claude_enterprise_claude_code_zero_data_retention_enabled"
"claude_in_slack_enabled"
"claude_science_custom_connectors_enabled"
"claude_science_custom_skills_enabled"
"claude_science_enabled"
"claude_science_local_work_import_enabled"
"claude_science_managed_network_allowlist_enabled"
"claude_science_memory_enabled"
"claude_science_modal_enabled"
"claude_science_scientific_model_endpoints_enabled"
"claude_science_ssh_hosts_enabled"
"cmek_enabled"
"code_execution_enabled"
"code_execution_network_egress_enabled"
"connector_tools_default_always_allow"
"content_redaction_enabled"
"cowork_trusted_devices_required"
"desktop_extension_allowlist_enabled"
"directory_sync_enabled"
"frontier_data_use_enabled"
"group_skill_sharing_enabled"
"hipaa_compliance_enabled"
"inline_visualizations_enabled"
"ip_allowlist_enabled"
"location_metadata_enabled"
"member_usage_dashboard_visible"
"memory_enabled"
"org_wide_skill_sharing_enabled"
"project_sharing_enabled"
"public_projects_enabled"
"skill_sharing_enabled"
"skills_enabled"
"sso_claude_ai_enforced"
"sso_console_enforced"
"sso_enabled"
"third_party_interactive_content_enabled"
"user_skill_creation_enabled"
"web_search_enabled"
"work_across_apps_enabled"
value: boolean
Integer object{ type: "integer", name, value }
A setting whose enforced value is a whole number; null means no limit is in force.
type: optional "integer"
defaultinteger
name: "account_session_duration_seconds"
value: number or null
String object{ type: "string", name, value }
A setting whose enforced value is a single string; null means no value is configured.
type: optional "string"
defaultstring
name: "claude_code_default_worker_environment_id" or "claude_code_default_worker_pool_id"
One of the following:
"claude_code_default_worker_environment_id"
"claude_code_default_worker_pool_id"
value: string or null
StringList object{ type: "string_list", name, value }
A setting whose enforced value is a list of strings.
type: optional "string_list"
defaultstring_list
name: "allowed_invite_domains" or "disabled_admin_request_types" or "ip_allowlist_ip_ranges"
One of the following:
"allowed_invite_domains"
"disabled_admin_request_types"
"ip_allowlist_ip_ranges"
value: array of string
ProvisioningMode object{ type: "provisioning_mode", value, name }
How organization members are provisioned, resolved to the enforced mode.
A configured mode is reported only while the mechanism that enforces it is active: just-in-time modes require single sign-on to be enabled, and SCIM modes require directory sync to be enabled. Otherwise `login_only` is reported, regardless of any stored configuration.
type: optional "provisioning_mode"
defaultprovisioning_mode
value: "jit_advanced" or "jit_permissive" or "login_only" or 2 more
How organization members are provisioned under SSO.
One of the following:
"jit_advanced"
"jit_permissive"
"login_only"
"scim_advanced"
"scim_permissive"
name: optional "sso_provisioning_mode"
defaultsso_provisioning_mode
DataRetention object{ type: "data_retention", value, name }
The data retention periods in force, keyed by the type of data they apply to.
A key of `all` covers every data type and is exclusive: when present it is the only key. A missing key means no organization-level administrator-configured retention period is in force for that data type; Anthropic's service defaults may still apply.
type: optional "data_retention"
defaultdata_retention
value: map\[Fixed or Indefinite\]
One of the following:
Fixed object{ type: "fixed", duration, timescale }
A fixed retention window measured from each item's last activity.
type: optional "fixed"
defaultfixed
duration: number
timescale: "day" or "month"
One of the following:
"day"
"month"
Indefinite object{ type: "indefinite" }
An indefinite retention period: data is kept with no time limit.
type: optional "indefinite"
defaultindefinite
name: optional "data_retention_periods"
defaultdata_retention_periods
Get effective organization settings
cURL
```python
curl https://api.anthropic.com/v1/compliance/organizations/$ORGANIZATION_ID/settings \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
```
Response 200
```python
{
"api_keys": [
{
"id": "id",
"created_at": "2019-12-27T18:11:19.117Z",
"created_by_id": "created_by_id",
"is_active": true,
"name": "name",
"scopes": [
"string"
],
"expires_at": "2019-12-27T18:11:19.117Z",
"type": "compliance_api_key"
}
],
"organization_id": "organization_id",
"settings": [
{
"name": "access_transparency_enabled",
"value": true,
"type": "boolean"
}
],
"type": "effective_organization_settings"
}
```
##### Returns Examples
Response 200
```python
{
"api_keys": [
{
"id": "id",
"created_at": "2019-12-27T18:11:19.117Z",
"created_by_id": "created_by_id",
"is_active": true,
"name": "name",
"scopes": [
"string"
],
"expires_at": "2019-12-27T18:11:19.117Z",
"type": "compliance_api_key"
}
],
"organization_id": "organization_id",
"settings": [
{
"name": "access_transparency_enabled",
"value": true,
"type": "boolean"
}
],
"type": "effective_organization_settings"
---
## Settings - Claude API Reference
Source: https://platform.claude.com/docs/en/api/compliance/organizations/settings
Path: 04-API-Reference/Admin/compliance-organizations-settings.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fcompliance%2Forganizations%2Fsettings)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
List organizations
Users
User Preferences
Roles
Settings
Get effective organization settings
Plugins
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
To enable the Compliance API, see the setup guide.
[Set up the Compliance API](../Other/manage-claude-compliance-api-access.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Compliance API](../Endpoints/http-compliance.md)
3. [Organizations](https://platform.claude.com/docs/en/api/http/compliance/organizations)
# Settings
Copy page
##### [Get effective organization settings](https://platform.claude.com/docs/en/api/http/compliance/organizations/settings/retrieve)
GET/v1/compliance/organizations/{organization_id}/settings
Retrieve the effective settings for an organization.
##### Models
SettingRetrieveResponse object{ type: "effective_organization_settings", api_keys, organization_id, settings }
The resolved settings in force for one organization at read time.
Settings appear at most once each, in a fixed relative order, and values reflect the enforced state. A setting the organization's administrators cannot change — for example, one controlled by Anthropic policy or not available to the organization — is omitted from the list. Settings that report a compliance arrangement with Anthropic are the exception: the HIPAA and Access Transparency settings are always included; the API zero data retention setting is reported for Claude Console organizations, and the Claude Code zero data retention and customer-managed encryption keys (CMEK) settings for Claude Enterprise organizations. Each reports whether the arrangement is in place at the organization level; a retention setting on an individual workspace is not reflected.
---
## List organization members' personal preferences - Claude API Reference
Source: https://platform.claude.com/docs/en/api/compliance/organizations/user_preferences/list
Path: 04-API-Reference/Admin/compliance-organizations-user-preferences-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fcompliance%2Forganizations%2Fuser_preferences%2Flist)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
List organizations
Users
User Preferences
List organization members' personal preferences
Roles
Settings
Plugins
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
To enable the Compliance API, see the setup guide.
[Set up the Compliance API](../Other/manage-claude-compliance-api-access.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Compliance API](../Endpoints/http-compliance.md)
3. [Organizations](https://platform.claude.com/docs/en/api/http/compliance/organizations)
4. [User Preferences](https://platform.claude.com/docs/en/api/http/compliance/organizations/user_preferences)
# List organization members' personal preferences
Copy page
GET/v1/compliance/organizations/{org_uuid}/user_preferences
List the personal preferences of an organization's current members.
Returns each member's "Instructions for Claude" and Cowork "Global instructions" text. Both are account-level settings: the same text is returned under every organization the member belongs to. Members are listed in the order they joined the organization, oldest first; use `limit` and `page` to paginate. A page may hold fewer than `limit` rows, or none at all, without being the last page: the server bounds the work it does per request. Follow `next_page` until it is `null`.
##### Path parameters
org_uuid: string
The organization's UUID
##### Query parameters
include_unset: optional boolean
When true, list every current member, with `null` for each value they have not set. By default only members with at least one value set are listed.
defaultfalse
limit: optional number
Maximum results (default: 20, max: 100)
default20
minimum1
maximum100
page: optional string
Opaque pagination token from a previous response's `next_page` field. Pass this to retrieve the next page of results. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.
user_ids: optional array of string
Restrict the list to these users (max 10 per request). An entry that does not name a current member of the organization matches nothing. Omit to list every eligible member. Enumerate IDs via `GET /v1/compliance/organizations/{org_uuid}/users`.
maxItems10
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"x-api-key": optional string
##### Returns
data: array of object{ conversation_preferences, cowork_global_instructions, user }
Current organization members in the order they joined the organization, oldest first. By default only members with at least one value set are listed; with `include_unset=true` every member is.
conversation_preferences: string or null
The member's "Instructions for Claude" text from their personal settings, with leading and trailing whitespace removed. `null` when the member has never set it or has cleared it.
cowork_global_instructions: string or null
The member's "Global instructions" text for Cowork, Claude's desktop agent, with leading and trailing whitespace removed. `null` when the member has never set it or has cleared it.
user: object{ id, email_address }
The organization member.
id: string
User identifier
email_address: string
User's current email address
has_more: boolean
Whether there is a further page to request. A page can hold fewer records than `limit`, or none, and still have more: the server bounds the work it does per request.
next_page: string or null
Token to retrieve the next page. Use this as the 'page' parameter in your next request; `null` on the last page.
List organization members' personal preferences
cURL
```python
curl https://api.anthropic.com/v1/compliance/organizations/$ORG_UUID/user_preferences \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
```
Response 200
```python
{
"data": [
{
"conversation_preferences": "Always answer in British English.",
"cowork_global_instructions": "Prefer short status updates.",
"user": {
"id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"email_address": "jane.doe@example.com"
}
}
],
"has_more": true,
"next_page": "cGFnZV90b2tlbl9leGFtcGxlXzE3MzQ1Njc4OTA="
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"conversation_preferences": "Always answer in British English.",
"cowork_global_instructions": "Prefer short status updates.",
"user": {
"id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"email_address": "jane.doe@example.com"
}
}
],
"has_more": true,
"next_page": "cGFnZV90b2tlbl9leGFtcGxlXzE3MzQ1Njc4OTA="
---
## User Preferences - Claude API Reference
Source: https://platform.claude.com/docs/en/api/compliance/organizations/user_preferences
Path: 04-API-Reference/Admin/compliance-organizations-user-preferences.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fcompliance%2Forganizations%2Fuser_preferences)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
List organizations
Users
User Preferences
List organization members' personal preferences
Roles
Settings
Plugins
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
To enable the Compliance API, see the setup guide.
[Set up the Compliance API](../Other/manage-claude-compliance-api-access.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Compliance API](../Endpoints/http-compliance.md)
3. [Organizations](https://platform.claude.com/docs/en/api/http/compliance/organizations)
# User Preferences
Copy page
##### [List organization members' personal preferences](https://platform.claude.com/docs/en/api/http/compliance/organizations/user_preferences/list)
GET/v1/compliance/organizations/{org_uuid}/user_preferences
List the personal preferences of an organization's current members.
##### Models
UserPreferenceListResponse object{ conversation_preferences, cowork_global_instructions, user }
The personal preferences a member of the organization has written in their settings.
conversation_preferences: string or null
The member's "Instructions for Claude" text from their personal settings, with leading and trailing whitespace removed. `null` when the member has never set it or has cleared it.
cowork_global_instructions: string or null
The member's "Global instructions" text for Cowork, Claude's desktop agent, with leading and trailing whitespace removed. `null` when the member has never set it or has cleared it.
user: object{ id, email_address }
The organization member.
---
## List organization users - Claude API Reference
Source: https://platform.claude.com/docs/en/api/compliance/organizations/users/list
Path: 04-API-Reference/Admin/compliance-organizations-users-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fcompliance%2Forganizations%2Fusers%2Flist)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
List organizations
Users
List organization users
User Preferences
Roles
Settings
Plugins
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
To enable the Compliance API, see the setup guide.
[Set up the Compliance API](../Other/manage-claude-compliance-api-access.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Compliance API](../Endpoints/http-compliance.md)
3. [Organizations](https://platform.claude.com/docs/en/api/http/compliance/organizations)
4. [Users](https://platform.claude.com/docs/en/api/http/compliance/organizations/users)
# List organization users
Copy page
GET/v1/compliance/organizations/{org_uuid}/users
List current user members of an organization.
##### Path parameters
org_uuid: string
The organization UUID
##### Query parameters
limit: optional number
Maximum results (default: 500, max: 1000)
default500
minimum1
maximum1000
page: optional string
Opaque pagination token from a previous response's `next_page` field. Pass this to retrieve the next page of results. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
"x-api-key": optional string
##### Returns
data: array of object{ id, created_at, email, 2 more }
List of current organization members sorted by organization join date ascending
id: string
User identifier (tagged ID)
created_at: string
User account creation timestamp
formatdate-time
email: string
User's current email address
full_name: string
User's current full name
organization_role: "admin" or "billing" or "claude_code_user" or 8 more
User's built-in role within the organization. This is distinct from any custom RBAC roles that may also be assigned.
One of the following:
"admin"
"billing"
"claude_code_user"
"developer"
"managed"
"membership_admin"
"owner"
"parent_org_admin"
"parent_org_owner"
"primary_owner"
"user"
has_more: boolean
Whether more records exist beyond the current result set
next_page: string or null
Token to retrieve the next page. Use this as the 'page' parameter in your next request
List organization users
cURL
```python
curl https://api.anthropic.com/v1/compliance/organizations/$ORG_UUID/users \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
```
Response 200
```python
{
"data": [
{
"id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"created_at": "2025-03-12T18:22:41.123456Z",
"email": "jane.doe@example.com",
"full_name": "Jane Doe",
"organization_role": "admin"
}
],
"has_more": true,
"next_page": "cGFnZV90b2tlbl9leGFtcGxlXzE3MzQ1Njc4OTA="
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"created_at": "2025-03-12T18:22:41.123456Z",
"email": "jane.doe@example.com",
"full_name": "Jane Doe",
"organization_role": "admin"
}
],
"has_more": true,
"next_page": "cGFnZV90b2tlbl9leGFtcGxlXzE3MzQ1Njc4OTA="
---
## Users - Claude API Reference
Source: https://platform.claude.com/docs/en/api/compliance/organizations/users
Path: 04-API-Reference/Admin/compliance-organizations-users.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fcompliance%2Forganizations%2Fusers)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
List organizations
Users
List organization users
User Preferences
Roles
Settings
Plugins
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
To enable the Compliance API, see the setup guide.
[Set up the Compliance API](../Other/manage-claude-compliance-api-access.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Compliance API](../Endpoints/http-compliance.md)
3. [Organizations](https://platform.claude.com/docs/en/api/http/compliance/organizations)
# Users
Copy page
##### [List organization users](https://platform.claude.com/docs/en/api/http/compliance/organizations/users/list)
GET/v1/compliance/organizations/{org_uuid}/users
List current user members of an organization.
##### Models
UserListResponse object{ id, created_at, email, 2 more }
User member information for compliance responses.
---
## Organizations - Claude API Reference
Source: https://platform.claude.com/docs/en/api/compliance/organizations
Path: 04-API-Reference/Admin/compliance-organizations.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fcompliance%2Forganizations)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
List organizations
Users
User Preferences
Roles
Settings
Plugins
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
To enable the Compliance API, see the setup guide.
[Set up the Compliance API](../Other/manage-claude-compliance-api-access.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Compliance API](../Endpoints/http-compliance.md)
# Organizations
Copy page
##### [List organizations](https://platform.claude.com/docs/en/api/http/compliance/organizations/list)
GET/v1/compliance/organizations
List organizations under the parent organization.
##### Models
OrganizationListResponse object{ created_at, name, uuid }
Information about an organization.
created_at: string
Organization creation time (RFC 3339 format)
name: string
Organization name
uuid: string
Unique identifier for the organization (UUID format)
#### Organizations[Users](https://platform.claude.com/docs/en/api/http/compliance/organizations/users)
##### [List organization users](https://platform.claude.com/docs/en/api/http/compliance/organizations/users/list)
GET/v1/compliance/organizations/{org_uuid}/users
List current user members of an organization.
#### Organizations[User Preferences](https://platform.claude.com/docs/en/api/http/compliance/organizations/user_preferences)
##### [List organization members' personal preferences](https://platform.claude.com/docs/en/api/http/compliance/organizations/user_preferences/list)
GET/v1/compliance/organizations/{org_uuid}/user_preferences
List the personal preferences of an organization's current members.
#### Organizations[Roles](https://platform.claude.com/docs/en/api/http/compliance/organizations/roles)
##### [List Compliance Roles](https://platform.claude.com/docs/en/api/http/compliance/organizations/roles/list)
GET/v1/compliance/organizations/{org_uuid}/roles
##### [Get Compliance Role](https://platform.claude.com/docs/en/api/http/compliance/organizations/roles/retrieve)
GET/v1/compliance/organizations/{org_uuid}/roles/{role_id}
#### OrganizationsRoles[Permissions](https://platform.claude.com/docs/en/api/http/compliance/organizations/roles/permissions)
##### [List Compliance Role Permissions](https://platform.claude.com/docs/en/api/http/compliance/organizations/roles/permissions/list)
GET/v1/compliance/organizations/{org_uuid}/roles/{role_id}/permissions
#### Organizations[Settings](https://platform.claude.com/docs/en/api/http/compliance/organizations/settings)
##### [Get effective organization settings](https://platform.claude.com/docs/en/api/http/compliance/organizations/settings/retrieve)
GET/v1/compliance/organizations/{organization_id}/settings
Retrieve the effective settings for an organization.
---
## Compliance API - Claude API Reference
Source: https://platform.claude.com/docs/en/api/compliance
Path: 04-API-Reference/Admin/compliance.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fcompliance)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
To enable the Compliance API, see the setup guide.
[Set up the Compliance API](../Other/manage-claude-compliance-api-access.md)
Copy page
1. [API reference](../Endpoints/http.md)
# Compliance API
Copy page
#### Compliance API[Activities](https://platform.claude.com/docs/en/api/http/compliance/activities)
##### [Query compliance activities](https://platform.claude.com/docs/en/api/http/compliance/activities/list)
GET/v1/compliance/activities
List compliance activities for the authenticated tenant.
#### Compliance API[Organizations](https://platform.claude.com/docs/en/api/http/compliance/organizations)
##### [List organizations](https://platform.claude.com/docs/en/api/http/compliance/organizations/list)
GET/v1/compliance/organizations
List organizations under the parent organization.
#### Compliance APIOrganizations[Users](https://platform.claude.com/docs/en/api/http/compliance/organizations/users)
##### [List organization users](https://platform.claude.com/docs/en/api/http/compliance/organizations/users/list)
GET/v1/compliance/organizations/{org_uuid}/users
List current user members of an organization.
#### Compliance APIOrganizations[User Preferences](https://platform.claude.com/docs/en/api/http/compliance/organizations/user_preferences)
##### [List organization members' personal preferences](https://platform.claude.com/docs/en/api/http/compliance/organizations/user_preferences/list)
GET/v1/compliance/organizations/{org_uuid}/user_preferences
List the personal preferences of an organization's current members.
#### Compliance APIOrganizations[Roles](https://platform.claude.com/docs/en/api/http/compliance/organizations/roles)
##### [List Compliance Roles](https://platform.claude.com/docs/en/api/http/compliance/organizations/roles/list)
GET/v1/compliance/organizations/{org_uuid}/roles
##### [Get Compliance Role](https://platform.claude.com/docs/en/api/http/compliance/organizations/roles/retrieve)
GET/v1/compliance/organizations/{org_uuid}/roles/{role_id}
#### Compliance APIOrganizationsRoles[Permissions](https://platform.claude.com/docs/en/api/http/compliance/organizations/roles/permissions)
##### [List Compliance Role Permissions](https://platform.claude.com/docs/en/api/http/compliance/organizations/roles/permissions/list)
GET/v1/compliance/organizations/{org_uuid}/roles/{role_id}/permissions
#### Compliance APIOrganizations[Settings](https://platform.claude.com/docs/en/api/http/compliance/organizations/settings)
##### [Get effective organization settings](https://platform.claude.com/docs/en/api/http/compliance/organizations/settings/retrieve)
GET/v1/compliance/organizations/{organization_id}/settings
Retrieve the effective settings for an organization.
#### Compliance API[Groups](https://platform.claude.com/docs/en/api/http/compliance/groups)
##### [List Compliance Groups](https://platform.claude.com/docs/en/api/http/compliance/groups/list)
GET/v1/compliance/groups
##### [Get Compliance Group](https://platform.claude.com/docs/en/api/http/compliance/groups/retrieve)
GET/v1/compliance/groups/{group_id}
#### Compliance APIGroups[Members](https://platform.claude.com/docs/en/api/http/compliance/groups/members)
##### [List Compliance Group Members](https://platform.claude.com/docs/en/api/http/compliance/groups/members/list)
GET/v1/compliance/groups/{group_id}/members
#### Compliance APIApps[Chats](https://platform.claude.com/docs/en/api/http/compliance/apps/chats)
##### [List chats](https://platform.claude.com/docs/en/api/http/compliance/apps/chats/list)
GET/v1/compliance/apps/chats
Lists chat metadata with filtering capabilities for targeted compliance review. Results are sorted chronologically (time ascending) by the `order_by` key, with ties broken by id.
##### [Delete chat](https://platform.claude.com/docs/en/api/http/compliance/apps/chats/delete)
DELETE/v1/compliance/apps/chats/{claude_chat_id}
Permanently deletes a chat and all associated messages and files. This is a destructive operation that cannot be undone.
#### Compliance APIAppsChats[Messages](https://platform.claude.com/docs/en/api/http/compliance/apps/chats/messages)
##### [Get chat messages](https://platform.claude.com/docs/en/api/http/compliance/apps/chats/messages/list)
GET/v1/compliance/apps/chats/{claude_chat_id}/messages
Retrieves message history and file metadata for a specific chat.
#### Compliance APIAppsChats[Files](https://platform.claude.com/docs/en/api/http/compliance/apps/chats/files)
##### [Get file metadata](https://platform.claude.com/docs/en/api/http/compliance/apps/chats/files/retrieve)
GET/v1/compliance/apps/chats/files/{claude_file_id}
Retrieves metadata for a file referenced in chat messages, without downloading the file content. Use the sibling `/content` endpoint to download the bytes.
##### [Delete file](https://platform.claude.com/docs/en/api/http/compliance/apps/chats/files/delete)
DELETE/v1/compliance/apps/chats/files/{claude_file_id}
Permanently deletes a specific file. This is a destructive operation that cannot be undone.
##### [Download file content](https://platform.claude.com/docs/en/api/http/compliance/apps/chats/files/download)
GET/v1/compliance/apps/chats/files/{claude_file_id}/content
Downloads the binary content of a file referenced in chat messages.
#### Compliance APIAppsChats[Generated Files](https://platform.claude.com/docs/en/api/http/compliance/apps/chats/generated_files)
##### [Get Claude-generated file metadata](https://platform.claude.com/docs/en/api/http/compliance/apps/chats/generated_files/retrieve)
GET/v1/compliance/apps/chats/generated-files/{claude_gen_file_id}
Returns metadata for a file the assistant created via tool use.
##### [Download a Claude-generated file](https://platform.claude.com/docs/en/api/http/compliance/apps/chats/generated_files/download)
GET/v1/compliance/apps/chats/generated-files/{claude_gen_file_id}/content
Downloads the binary content of a file the assistant created via tool use.
#### Compliance APIApps[Projects](https://platform.claude.com/docs/en/api/http/compliance/apps/projects)
##### [List projects](https://platform.claude.com/docs/en/api/http/compliance/apps/projects/list)
GET/v1/compliance/apps/projects
Lists project metadata with filtering capabilities. Results are sorted chronologically (time ascending) by created_at.
##### [Get project details](https://platform.claude.com/docs/en/api/http/compliance/apps/projects/retrieve)
GET/v1/compliance/apps/projects/{project_id}
Get detailed information for a specific project.
##### [Delete project](https://platform.claude.com/docs/en/api/http/compliance/apps/projects/delete)
DELETE/v1/compliance/apps/projects/{project_id}
Delete a project for compliance purposes.
#### Compliance APIAppsProjects[Attachments](https://platform.claude.com/docs/en/api/http/compliance/apps/projects/attachments)
##### [List project attachments](https://platform.claude.com/docs/en/api/http/compliance/apps/projects/attachments/list)
GET/v1/compliance/apps/projects/{project_id}/attachments
List files and documents attached to a project.
#### Compliance APIAppsProjects[Collaborators](https://platform.claude.com/docs/en/api/http/compliance/apps/projects/collaborators)
##### [List project collaborators](https://platform.claude.com/docs/en/api/http/compliance/apps/projects/collaborators/list)
GET/v1/compliance/apps/projects/{project_id}/collaborators
List the users, groups, and organization-wide grants on a project.
#### Compliance APIAppsProjects[Documents](https://platform.claude.com/docs/en/api/http/compliance/apps/projects/documents)
##### [Get project document content](https://platform.claude.com/docs/en/api/http/compliance/apps/projects/documents/retrieve)
GET/v1/compliance/apps/projects/documents/{document_id}
Get detailed information for a specific project document.
##### [Get project document metadata](https://platform.claude.com/docs/en/api/http/compliance/apps/projects/documents/metadata)
GET/v1/compliance/apps/projects/documents/{document_id}/metadata
Returns metadata for a project document, without the content body.
##### [Delete project document](https://platform.claude.com/docs/en/api/http/compliance/apps/projects/documents/delete)
DELETE/v1/compliance/apps/projects/documents/{document_id}
Delete a project document for compliance purposes.
#### Compliance APIApps[Artifacts](https://platform.claude.com/docs/en/api/http/compliance/apps/artifacts)
##### [Get artifact metadata](https://platform.claude.com/docs/en/api/http/compliance/apps/artifacts/retrieve)
GET/v1/compliance/apps/artifacts/{artifact_version_id}
Returns metadata for an artifact version, without the content body.
##### [Download artifact content](https://platform.claude.com/docs/en/api/http/compliance/apps/artifacts/download)
GET/v1/compliance/apps/artifacts/{artifact_version_id}/content
Download the content of an artifact version for compliance purposes.
#### Compliance APIAppsSessions[Local](https://platform.claude.com/docs/en/api/http/compliance/apps/sessions/local)
##### [List local sessions](https://platform.claude.com/docs/en/api/http/compliance/apps/sessions/local/list)
GET/v1/compliance/apps/sessions/local
List local sessions across the organizations the key may read.
##### [Retrieve a local session](https://platform.claude.com/docs/en/api/http/compliance/apps/sessions/local/retrieve)
GET/v1/compliance/apps/sessions/local/{local_session_id}
Retrieve one local session.
#### Compliance APIAppsSessionsLocal[Messages](https://platform.claude.com/docs/en/api/http/compliance/apps/sessions/local/messages)
##### [Retrieve local session messages](https://platform.claude.com/docs/en/api/http/compliance/apps/sessions/local/messages/list)
GET/v1/compliance/apps/sessions/local/{local_session_id}/messages
Read one local session's transcript, oldest-first by default.
#### Compliance APIAppsSessions[Remote](https://platform.claude.com/docs/en/api/http/compliance/apps/sessions/remote)
##### [List remote sessions](https://platform.claude.com/docs/en/api/http/compliance/apps/sessions/remote/list)
GET/v1/compliance/apps/sessions/remote
List remote sessions (Cowork sessions that run in Anthropic-managed cloud environments) across the organizations the key may read.
#### Compliance APIAppsSessionsRemote[Messages](https://platform.claude.com/docs/en/api/http/compliance/apps/sessions/remote/messages)
##### [Retrieve remote session messages](https://platform.claude.com/docs/en/api/http/compliance/apps/sessions/remote/messages/list)
GET/v1/compliance/apps/sessions/remote/{claude_remote_session_id}/messages
Retrieve one remote session's transcript: user prompts, assistant responses, and tool calls and results. Thinking blocks and images are not included.
#### Compliance APIAppsCode[Artifacts](https://platform.claude.com/docs/en/api/http/compliance/apps/code/artifacts)
##### [List Code Artifacts](https://platform.claude.com/docs/en/api/http/compliance/apps/code/artifacts/list)
GET/v1/compliance/apps/code/artifacts
List Claude Code Artifacts owned by organizations under the parent organization.
##### [Download Code Artifact Version Content](https://platform.claude.com/docs/en/api/http/compliance/apps/code/artifacts/retrieve_version)
GET/v1/compliance/apps/code/artifacts/{artifact_id}/versions/{version_id}
Streams the content of one version of a Claude Code Artifact as the response body.
##### [Download Code Artifact Content](https://platform.claude.com/docs/en/api/http/compliance/apps/code/artifacts/download)
GET/v1/compliance/apps/code/artifacts/{artifact_id}/content
Streams an Artifact's current content as the response body. For a Claude Doc, that is the Doc's text as a ZIP archive of Word files, one per text tab, and the request must set `multi_file_format=zip`. For any other Artifact, it is the latest version, as `GET /v1/compliance/apps/code/artifacts/{artifact_id}/versions/{version_id}` returns it.
##### [Delete Code Artifact](https://platform.claude.com/docs/en/api/http/compliance/apps/code/artifacts/delete)
DELETE/v1/compliance/apps/code/artifacts/{artifact_id}
Permanently deletes a Code Artifact and all its versions. This is a destructive operation that cannot be undone. A 200 response means the deletion is initiated and the Artifact is claimed; content removal completes asynchronously.
---
## Get Artifact Activity - Claude API Reference
Source: https://platform.claude.com/docs/en/api/http/admin/analytics/artifacts/list
Path: 04-API-Reference/Admin/http-admin-analytics-artifacts-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fhttp%2Fadmin%2Fanalytics%2Fartifacts%2Flist)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
API Keys
External Keys
Usage Report
Cost Report
Analytics
Get Activity Summaries
Usage
Cost
Users
Skills
Connectors
Chat Projects
Plugins
Artifacts
Get Artifact Activity
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [Analytics](http-admin-analytics.md)
4. [Artifacts](http-admin-analytics-artifacts.md)
# Get Artifact Activity
GET/v1/organizations/analytics/artifacts
Get artifact-creation activity for a given day, broken out by MIME type.
Returns the full (`artifact_type`, `is_shared`) cube for the organization; `next_page` is null except for grouped queries, which paginate. The cube can be broken out per product, per member, or per RBAC group via `group_by[]`, and scoped via `filter[]`. Requires an API key with the `read:analytics` scope.
##### Query parameters
date: string
UTC date in YYYY-MM-DD format. The day to get artifact activity for. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day) and may be revised by a few percent over the following days. No earlier than 2026-01-01.
formatdate
filter: optional array of string
Filters as `dimension:value`, e.g. `filter[]=rbac_group_id:{id}`. Repeat the param for OR within a dimension and across dimensions for AND. Supported dimensions on this endpoint: `artifact_type`, `is_shared`, `product`, `rbac_group_id`, `user_id`. Value forms: `artifact_type` is a canonical artifact MIME type (e.g. `text/markdown`) or `other`; `is_shared` is `true` or `false`; `product` is `chat`, `claude_code`, or `cowork` (the surfaces that create artifacts); `rbac_group_id` takes the tagged id (`rbac_group_...`, as emitted in responses and by the spend-limits API) or a bare group UUID, and matches users who held the group at any point during each covered UTC day (time-of-usage attribution); `user_id` takes a tagged user id (`user_...`), as emitted in responses. An unsupported dimension returns 400. At most 100 entries.
maxItems100
group_by: optional array of "product" or "rbac_group_id" or "user_id"
Dimensions to break results out by: `product`, `user_id` and/or `rbac_group_id`. The ungrouped artifact-type cube is finite and returned in full; grouped queries multiply the cube and paginate via `next_page`. `product` takes the values `chat`, `claude_code`, or `cowork` (the surfaces that create artifacts). `rbac_group_id` attributes a user to every group they held at any point during the requested UTC day, so grouped rows are not an exclusive partition. At most 100 entries.
maxItems100
One of the following:
"product"
"rbac_group_id"
"user_id"
limit: optional number
Maximum rows to return (1-1000, default 100). The ungrouped artifact-type cube is finite and returned in full; `limit` is the page size only when `group_by[]` multiplies the cube.
minimum1
maximum1000
page: optional string
Opaque cursor from a previous response's `next_page` field. Only valid with `group_by[]` — the ungrouped cube is never paginated.
##### Returns
ArtifactUsage object{ data, next_page }
Response for GET /v1/organizations/analytics/artifacts.
`next_page` is null on ungrouped queries — the artifact-type cube is finite and returned in full. Grouped queries (`group_by[]` on `product` / `user_id` / `rbac_group_id`) multiply the cube and paginate like the other analytics list endpoints.
Get Artifact Activity
cURL
```python
curl https://api.anthropic.com/v1/organizations/analytics/artifacts \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY"
```
Response 200
```python
{
"data": [
{
"artifact_type": "artifact_type",
"artifacts_created_count": 0,
"distinct_user_count": 0,
"is_shared": true,
"published_artifacts_created_count": 0,
"product": "product",
"rbac_group_id": "rbac_group_id",
"rbac_group_name": "rbac_group_name",
"user_id": "user_id"
}
],
"next_page": "next_page"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"artifact_type": "artifact_type",
"artifacts_created_count": 0,
"distinct_user_count": 0,
"is_shared": true,
"published_artifacts_created_count": 0,
"product": "product",
"rbac_group_id": "rbac_group_id",
"rbac_group_name": "rbac_group_name",
---
## Artifacts - Claude API Reference
Source: https://platform.claude.com/docs/en/api/http/admin/analytics/artifacts
Path: 04-API-Reference/Admin/http-admin-analytics-artifacts.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fhttp%2Fadmin%2Fanalytics%2Fartifacts)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
API Keys
External Keys
Usage Report
Cost Report
Analytics
Get Activity Summaries
Usage
Cost
Users
Skills
Connectors
Chat Projects
Plugins
Artifacts
Get Artifact Activity
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [Analytics](http-admin-analytics.md)
# Artifacts
##### [Get Artifact Activity](http-admin-analytics-artifacts-list.md)
GET/v1/organizations/analytics/artifacts
##### Models
ArtifactUsage object{ data, next_page }
Response for GET /v1/organizations/analytics/artifacts.
`next_page` is null on ungrouped queries — the artifact-type cube is finite and returned in full. Grouped queries (`group_by[]` on `product` / `user_id` / `rbac_group_id`) multiply the cube and paginate like the other analytics list endpoints.
---
## Get Chat Project Usage - Claude API Reference
Source: https://platform.claude.com/docs/en/api/http/admin/analytics/chat_projects/list
Path: 04-API-Reference/Admin/http-admin-analytics-chat-projects-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fhttp%2Fadmin%2Fanalytics%2Fchat_projects%2Flist)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
API Keys
External Keys
Usage Report
Cost Report
Analytics
Get Activity Summaries
Usage
Cost
Users
Skills
Connectors
Chat Projects
Get Chat Project Usage
Plugins
Artifacts
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [Analytics](http-admin-analytics.md)
4. [Chat Projects](http-admin-analytics-chat-projects.md)
# Get Chat Project Usage
GET/v1/organizations/analytics/apps/chat/projects
Get per-project activity for a given day, with cursor-based pagination.
Returns activity metrics for each project in the organization, sorted by project ID. Use `group_by[]` to break projects out per member or per RBAC group, and `filter[]` to scope results; the parameter descriptions list the supported dimensions. Available to organizations on a Claude Enterprise plan. Requires an API key with the `read:analytics` scope.
##### Query parameters
date: optional string
UTC date in YYYY-MM-DD format. The day to get project activity for. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day) and may be revised by a few percent over the following days. No earlier than 2026-01-01.
formatdate
ending_date: optional string
UTC date in YYYY-MM-DD format. End of the date range (exclusive); only valid with `starting_date`. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day), so this can be at most today — which is also the default when omitted, resolved once when the first page is served and reused for the rest of the pagination sequence. At most 366 days after `starting_date`.
formatdate
filter: optional array of string
Filters as `dimension:value`, e.g. `filter[]=rbac_group_id:{id}`. Repeat the param for OR within a dimension and across dimensions for AND. Supported dimensions on this endpoint: `project_id`, `rbac_group_id`, `user_id`. Value forms: `project_id` takes a tagged project id (`claude_proj_...`); `rbac_group_id` takes the tagged id (`rbac_group_...`, as emitted in responses and by the spend-limits API) or a bare group UUID, and matches users who held the group at any point during each covered UTC day (time-of-usage attribution); `user_id` takes a tagged user id (`user_...`), as emitted in responses. An unsupported dimension returns 400. At most 100 entries.
maxItems100
group_by: optional array of "rbac_group_id" or "user_id"
Dimensions to break results out by (e.g. `group_by[]=user_id`). Supported on this endpoint: `rbac_group_id`, `user_id`. Grouped rows carry the requested dimension values as additional fields and paginate like ungrouped responses via `next_page`; an unsupported dimension returns 400. `rbac_group_id` attributes a user to every group they held at any point during each covered UTC day, so grouped rows are not an exclusive partition and can sum above org-level totals. At most 100 entries.
maxItems100
One of the following:
"rbac_group_id"
"user_id"
limit: optional number
Number of results per page (1-1000, default 100).
minimum1
maximum1000
order: optional "asc" or "desc"
Sort direction: `asc` or `desc`. Defaults to `asc` for the endpoint's sort column and to `desc` when `order_by` names a metric (a top-N ranking). Applies to `order_by`, or to the endpoint's default sort field when `order_by` is omitted.
One of the following:
"asc"
"desc"
order_by: optional string
Sort field. Restricted to the endpoint's sort column plus its rankable metrics (metrics default to descending; a few metrics rank in date-range mode only, per the endpoint's documented orderable set).
page: optional string
Opaque cursor from a previous response's `next_page` field.
starting_date: optional string
UTC date in YYYY-MM-DD format. Start of a date range (inclusive). Enables rollup mode: one row per entity aggregated over the whole range — addable counters are summed across days, and a distinct count is never summed where summing could double-count (a field's range value is recomputed exactly over the window, approximate via HLL with typical error under 2%, null, or — for the creation-event counts, whose per-day values cannot overlap — a per-day sum that is itself exact; each field's own description says which). Use either `date` or `starting_date`, not both. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day) and may be revised by a few percent over the following days. No earlier than 2026-01-01.
formatdate
##### Returns
ChatProjectUsage object{ data, next_page }
Response for GET /v1/organizations/analytics/apps/chat/projects.
Get Chat Project Usage
cURL
```python
curl https://api.anthropic.com/v1/organizations/analytics/apps/chat/projects \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY"
```
Response 200
```python
{
"data": [
{
"distinct_user_count": 0,
"message_count": 0,
"project_id": "project_id",
"project_name": "project_name",
"created_at": "2019-12-27T18:11:19.117Z",
"created_by": {
"id": "id",
"email_address": "email_address",
"type": "user"
},
"distinct_conversation_count": 0,
"product": "product",
"rbac_group_id": "rbac_group_id",
"rbac_group_name": "rbac_group_name",
"user_id": "user_id"
}
],
"next_page": "next_page"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"distinct_user_count": 0,
"message_count": 0,
"project_id": "project_id",
"project_name": "project_name",
"created_at": "2019-12-27T18:11:19.117Z",
"created_by": {
"id": "id",
"email_address": "email_address",
"type": "user"
},
"distinct_conversation_count": 0,
"product": "product",
"rbac_group_id": "rbac_group_id",
"rbac_group_name": "rbac_group_name",
---
## Chat Projects - Claude API Reference
Source: https://platform.claude.com/docs/en/api/http/admin/analytics/chat_projects
Path: 04-API-Reference/Admin/http-admin-analytics-chat-projects.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fhttp%2Fadmin%2Fanalytics%2Fchat_projects)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
API Keys
External Keys
Usage Report
Cost Report
Analytics
Get Activity Summaries
Usage
Cost
Users
Skills
Connectors
Chat Projects
Get Chat Project Usage
Plugins
Artifacts
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [Analytics](http-admin-analytics.md)
# Chat Projects
##### [Get Chat Project Usage](http-admin-analytics-chat-projects-list.md)
GET/v1/organizations/analytics/apps/chat/projects
##### Models
ChatProjectUsage object{ data, next_page }
Response for GET /v1/organizations/analytics/apps/chat/projects.
---
## Get Connector Usage - Claude API Reference
Source: https://platform.claude.com/docs/en/api/http/admin/analytics/connectors/list
Path: 04-API-Reference/Admin/http-admin-analytics-connectors-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fhttp%2Fadmin%2Fanalytics%2Fconnectors%2Flist)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
API Keys
External Keys
Usage Report
Cost Report
Analytics
Get Activity Summaries
Usage
Cost
Users
Skills
Connectors
Get Connector Usage
Chat Projects
Plugins
Artifacts
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [Analytics](http-admin-analytics.md)
4. [Connectors](http-admin-analytics-connectors.md)
# Get Connector Usage
GET/v1/organizations/analytics/connectors
Get per-connector usage for a given day, with cursor-based pagination.
Returns connector usage metrics for the organization, sorted by connector name. Connector names are normalized from their various sources — for example, "Atlassian MCP server" and "mcp-atlassian" both appear as "atlassian". Use `group_by[]` to break usage out per member, per RBAC group, or per product surface, and `filter[]` to scope results; the parameter descriptions list the supported dimensions. Available to organizations on a Claude Enterprise plan. Requires an API key with the `read:analytics` scope.
##### Query parameters
date: optional string
UTC date in YYYY-MM-DD format. The day to get connector usage for. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day) and may be revised by a few percent over the following days. No earlier than 2026-01-01.
formatdate
ending_date: optional string
UTC date in YYYY-MM-DD format. End of the date range (exclusive); only valid with `starting_date`. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day), so this can be at most today — which is also the default when omitted, resolved once when the first page is served and reused for the rest of the pagination sequence. At most 366 days after `starting_date`.
formatdate
filter: optional array of string
Filters as `dimension:value`, e.g. `filter[]=rbac_group_id:{id}`. Repeat the param for OR within a dimension and across dimensions for AND. Supported dimensions on this endpoint: `connector_name`, `product`, `rbac_group_id`, `user_id`. Value forms: `connector_name` matches case-insensitively, a display name such as 'GitHub MCP' also matches its normalized stored form ('github'), and for rows whose `connector_name` is an opaque connector id the connector's display name (`connector_display_name`) also matches; `product` is one of `chat`, `claude_code`, `cowork`, or `office_agent`; `rbac_group_id` takes the tagged id (`rbac_group_...`, as emitted in responses and by the spend-limits API) or a bare group UUID, and matches users who held the group at any point during each covered UTC day (time-of-usage attribution); `user_id` takes a tagged user id (`user_...`), as emitted in responses. An unsupported dimension returns 400. At most 100 entries.
maxItems100
group_by: optional array of "product" or "rbac_group_id" or "user_id"
Dimensions to break results out by (e.g. `group_by[]=user_id`). Supported on this endpoint: `product`, `rbac_group_id`, `user_id`. Grouped rows carry the requested dimension values as additional fields and paginate like ungrouped responses via `next_page`; an unsupported dimension returns 400. `rbac_group_id` attributes a user to every group they held at any point during each covered UTC day, so grouped rows are not an exclusive partition and can sum above org-level totals. At most 100 entries.
maxItems100
One of the following:
"product"
"rbac_group_id"
"user_id"
limit: optional number
Number of results per page (1-1000, default 100).
minimum1
maximum1000
order: optional "asc" or "desc"
Sort direction: `asc` or `desc`. Defaults to `asc` for the endpoint's sort column and to `desc` when `order_by` names a metric (a top-N ranking). Applies to `order_by`, or to the endpoint's default sort field when `order_by` is omitted.
One of the following:
"asc"
"desc"
order_by: optional string
Sort field. Restricted to the endpoint's sort column plus its rankable metrics (metrics default to descending; a few metrics rank in date-range mode only, per the endpoint's documented orderable set).
page: optional string
Opaque cursor from a previous response's `next_page` field.
starting_date: optional string
UTC date in YYYY-MM-DD format. Start of a date range (inclusive). Enables rollup mode: one row per entity aggregated over the whole range — addable counters are summed across days, and a distinct count is never summed where summing could double-count (a field's range value is recomputed exactly over the window, approximate via HLL with typical error under 2%, null, or — for the creation-event counts, whose per-day values cannot overlap — a per-day sum that is itself exact; each field's own description says which). Use either `date` or `starting_date`, not both. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day) and may be revised by a few percent over the following days. No earlier than 2026-01-01.
formatdate
##### Returns
ConnectorUsage object{ data, next_page }
Response for GET /v1/organizations/analytics/connectors.
Get Connector Usage
cURL
```python
curl https://api.anthropic.com/v1/organizations/analytics/connectors \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY"
```
Response 200
```python
{
"data": [
{
"chat_metrics": {
"distinct_conversation_connector_used_count": 0
},
"claude_code_metrics": {
"distinct_session_connector_used_count": 0
},
"connector_name": "connector_name",
"cowork_metrics": {
"distinct_session_connector_used_count": 0
},
"distinct_user_count": 0,
"office_metrics": {
"excel": {
"distinct_session_connector_used_count": 0
},
"outlook": {
"distinct_session_connector_used_count": 0
},
"powerpoint": {
"distinct_session_connector_used_count": 0
},
"word": {
"distinct_session_connector_used_count": 0
}
},
"connector_display_name": "connector_display_name",
"individual_auth_distinct_user_count": 0,
"managed_auth_distinct_user_count": 0,
"product": "product",
"rbac_group_id": "rbac_group_id",
"rbac_group_name": "rbac_group_name",
"read_call_count": 0,
"unclassified_call_count": 0,
"user_id": "user_id",
"write_call_count": 0
}
],
"next_page": "next_page"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"chat_metrics": {
"distinct_conversation_connector_used_count": 0
},
"claude_code_metrics": {
"distinct_session_connector_used_count": 0
},
"connector_name": "connector_name",
"cowork_metrics": {
"distinct_session_connector_used_count": 0
},
"distinct_user_count": 0,
"office_metrics": {
"excel": {
"distinct_session_connector_used_count": 0
},
"outlook": {
"distinct_session_connector_used_count": 0
},
"powerpoint": {
"distinct_session_connector_used_count": 0
},
"word": {
"distinct_session_connector_used_count": 0
}
},
"connector_display_name": "connector_display_name",
"individual_auth_distinct_user_count": 0,
"managed_auth_distinct_user_count": 0,
"product": "product",
"rbac_group_id": "rbac_group_id",
"rbac_group_name": "rbac_group_name",
---
## Connectors - Claude API Reference
Source: https://platform.claude.com/docs/en/api/http/admin/analytics/connectors
Path: 04-API-Reference/Admin/http-admin-analytics-connectors.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fhttp%2Fadmin%2Fanalytics%2Fconnectors)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
API Keys
External Keys
Usage Report
Cost Report
Analytics
Get Activity Summaries
Usage
Cost
Users
Skills
Connectors
Get Connector Usage
Chat Projects
Plugins
Artifacts
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [Analytics](http-admin-analytics.md)
# Connectors
##### [Get Connector Usage](http-admin-analytics-connectors-list.md)
GET/v1/organizations/analytics/connectors
##### Models
ConnectorUsage object{ data, next_page }
Response for GET /v1/organizations/analytics/connectors.
---
## Get Per-User Cost - Claude API Reference
Source: https://platform.claude.com/docs/en/api/http/admin/analytics/cost/list_by_user
Path: 04-API-Reference/Admin/http-admin-analytics-cost-list-by-user.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fhttp%2Fadmin%2Fanalytics%2Fcost%2Flist_by_user)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
API Keys
External Keys
Usage Report
Cost Report
Analytics
Get Activity Summaries
Usage
Cost
Get Cost Over Time
Get Per-User Cost
Users
Skills
Connectors
Chat Projects
Plugins
Artifacts
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [Analytics](http-admin-analytics.md)
4. [Cost](http-admin-analytics-cost.md)
# Get Per-User Cost
GET/v1/organizations/analytics/user_cost_report
Get per-user cost in USD across a date range.
Returns one row per user, ranked by spend. Use this to see which users account for the most cost. Only cost attributable to a seat user is included; for organization-wide totals including direct API-key and automation traffic, use the bucketed `/v1/organizations/analytics/cost_report` endpoint. Available to organizations on a Claude Enterprise plan. Requires an API key with the `read:analytics` scope.
##### Query parameters
starting_at: string
Start of range, inclusive. RFC 3339 tz-aware. Must be within the last 365 days and no earlier than 2026-01-01T00:00:00Z.
formatdate-time
bucket_width: optional "1d" or "1h" or "1m"
Time-bucket granularity. When set, each row's `starting_at` and `ending_at` are populated and one actor may span several rows (one per time bucket with usage). The time bucket counts toward `limit`, so one page can return multiple rows for the same actor. `ending_at` is required when `bucket_width` is set, and with `bucket_width="1m"` the range may span at most 24 hours. When omitted, each row aggregates the full `[starting_at, ending_at)` range.
One of the following:
"1d"
"1h"
"1m"
claude_tag_categories: optional array of "dm" or "engaged" or "monitoring" or 2 more
Filter to Claude Tag (Claude in Slack) usage in specific spend categories. Usage with no category never matches. `dm` usage is reported under the user's product rather than `claude-tag`, so combining this filter with `products[]=claude-tag` excludes it. Use `group_by[]=claude_tag_category` to break out per-category values.
maxItems100
One of the following:
"dm"
"engaged"
"monitoring"
"proactive"
"scheduled"
claude_tag_user_ids: optional array of string
Filter to Claude Tag (Claude in Slack) usage attributed to specific Slack users, by Slack user ID (for example `U0123ABCDEF`), not claude.ai user ID. Usage that is not Claude Tag, and Claude Tag usage not attributed to a single user, never matches. Use `group_by[]=claude_tag_user_id` to break out per-user values.
maxItems100
context_windows: optional array of "0-200k" or "200k-1M"
Filter to specific context-window pricing tiers. Use `group_by[]=context_window` to break out per-tier values.
maxItems100
One of the following:
"0-200k"
"200k-1M"
ending_at: optional string
End of range, exclusive. When omitted, defaults to the earlier of now and `starting_at` + 31 days. The range may span at most 31 days.
formatdate-time
exclude_deleted_users: optional boolean
If true, omit rows for users who are deleted (`deleted: true`). A page may contain fewer than `limit` rows; use `has_more` and `next_page` to paginate as usual.
defaultfalse
group_by: optional array of "claude_tag_category" or "claude_tag_user_id" or "context_window" or 8 more
Break each actor's row out by the given dimensions. Accepts the same values as the bucketed `/cost_report` endpoint. The `product`, `model`, `context_window`, `inference_geo`, and `speed` dimensions — and the time bucket, when `bucket_width` is set — count toward `limit`. `cost_type` and `token_type` do not: `cost_type` returns one row per cost component (tokens, web search, code execution); `token_type` returns one row per token type, each with `cost_type: "tokens"`; combining both returns the per-token-type rows plus the web-search and code-execution rows. A page can therefore contain more rows than `limit` when `cost_type` or `token_type` is requested.
maxItems100
One of the following:
"claude_tag_category"
"claude_tag_user_id"
"context_window"
"cost_type"
"inference_geo"
"model"
"product"
"rbac_group_id"
"slack_channel_id"
"speed"
"token_type"
inference_geos: optional array of "global" or "not_available" or "us"
Filter to specific inference regions. `not_available` matches rows where the region is unset. Use `group_by[]=inference_geo` to break out per-region values.
maxItems100
One of the following:
"global"
"not_available"
"us"
limit: optional number
Number of rows per page (1-1000, default 20). One row per actor unless `group_by[]` or `bucket_width` splits an actor across rows; `cost_type`/`token_type` fan-out rows (cost endpoint only) are the exception — they do not count toward this limit, so `data` can exceed it.
default20
maximum1000
minimum1
models: optional array of string
Models to include. Defaults to all models. Use `group_by[]=model` to break out per-model values.
maxItems100
order: optional "asc" or "desc"
Sort direction. Defaults to `desc`.
defaultdesc
One of the following:
"asc"
"desc"
order_by: optional "amount" or "list_amount"
Metric to rank actors by. Defaults to `amount`.
defaultamount
One of the following:
"amount"
"list_amount"
page: optional string
Opaque cursor from a previous response's `next_page` field.
products: optional array of "chat" or "claude-tag" or "claude_code" or 4 more
Product surfaces to include. Defaults to all products.
maxItems100
One of the following:
"chat"
"claude-tag"
"claude_code"
"claude_design"
"claude_in_chrome"
"cowork"
"office_agent"
rbac_group_ids: optional array of string
Filter to usage attributed to specific RBAC groups. Accepts tagged RBAC group IDs (`rbac_group_...`) or bare group UUIDs. A row matches when the user belonged to any of the listed groups on the (UTC) day the usage occurred; usage with no group attribution never matches.
maxItems100
slack_channel_ids: optional array of string
Filter to usage originating from specific Slack channels. Use `group_by[]=slack_channel_id` to break out per-channel values.
maxItems100
speeds: optional array of "fast" or "standard"
Filter to fast or standard inference mode. Use `group_by[]=speed` to break out per-mode values.
maxItems100
One of the following:
"fast"
"standard"
user_ids: optional array of string
Filter to specific users by tagged user ID.
maxItems100
##### Returns
UserCost object{ data, data_refreshed_at, has_more, 2 more }
Get Per-User Cost
cURL
```python
curl https://api.anthropic.com/v1/organizations/analytics/user_cost_report \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY"
```
Response 200
```python
{
"data": [
{
"actor": {
"deleted": true,
"email": "jane@example.com",
"name": "Jane Smith",
"type": "user_actor",
"user_id": "user_01AbCdEfGhIjKlMnOpQrSt"
},
"amount": "41280.000000",
"claude_tag_category": "dm",
"claude_tag_user_id": "U0123ABCDEF",
"context_window": "0-200k",
"cost_type": "code_execution",
"currency": "USD",
"ending_at": "2019-12-27T18:11:19.117Z",
"inference_geo": "global",
"list_amount": "51600.000000",
"model": "claude-opus-5",
"product": "chat",
"rbac_group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"requests": 128,
"slack_channel_id": "C0123ABCDEF",
"speed": "fast",
"starting_at": "2019-12-27T18:11:19.117Z",
"token_type": "cache_creation.ephemeral_1h_input_tokens"
}
],
"data_refreshed_at": "2019-12-27T18:11:19.117Z",
"has_more": true,
"next_page": "next_page",
"organization_id": "org_013FP9SaFPBg7Kw7fetjn6cF"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"actor": {
"deleted": true,
"email": "jane@example.com",
"name": "Jane Smith",
"type": "user_actor",
"user_id": "user_01AbCdEfGhIjKlMnOpQrSt"
},
"amount": "41280.000000",
"claude_tag_category": "dm",
"claude_tag_user_id": "U0123ABCDEF",
"context_window": "0-200k",
"cost_type": "code_execution",
"currency": "USD",
"ending_at": "2019-12-27T18:11:19.117Z",
"inference_geo": "global",
"list_amount": "51600.000000",
"model": "claude-opus-5",
"product": "chat",
"rbac_group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"requests": 128,
"slack_channel_id": "C0123ABCDEF",
"speed": "fast",
"starting_at": "2019-12-27T18:11:19.117Z",
"token_type": "cache_creation.ephemeral_1h_input_tokens"
}
],
"data_refreshed_at": "2019-12-27T18:11:19.117Z",
"has_more": true,
"next_page": "next_page",
"organization_id": "org_013FP9SaFPBg7Kw7fetjn6cF"
---
## Get Cost Over Time - Claude API Reference
Source: https://platform.claude.com/docs/en/api/http/admin/analytics/cost/list
Path: 04-API-Reference/Admin/http-admin-analytics-cost-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fhttp%2Fadmin%2Fanalytics%2Fcost%2Flist)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
API Keys
External Keys
Usage Report
Cost Report
Analytics
Get Activity Summaries
Usage
Cost
Get Cost Over Time
Get Per-User Cost
Users
Skills
Connectors
Chat Projects
Plugins
Artifacts
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [Analytics](http-admin-analytics.md)
4. [Cost](http-admin-analytics-cost.md)
# Get Cost Over Time
GET/v1/organizations/analytics/cost_report
Get cost in USD over time across a date range.
Returns cost bucketed by minute, hour, or day, optionally broken down by product, model, context window, inference region, speed, cost type, or token type. Available to organizations on a Claude Enterprise plan. Requires an API key with the `read:analytics` scope.
##### Query parameters
starting_at: string
Start of range, inclusive. RFC 3339 tz-aware. Must be within the last 365 days and no earlier than 2026-01-01T00:00:00Z.
formatdate-time
bucket_width: optional "1d" or "1h" or "1m"
Time bucket granularity.
default1d
One of the following:
"1d"
"1h"
"1m"
claude_tag_categories: optional array of "dm" or "engaged" or "monitoring" or 2 more
Filter to Claude Tag (Claude in Slack) usage in specific spend categories. Usage with no category never matches. `dm` usage is reported under the user's product rather than `claude-tag`, so combining this filter with `products[]=claude-tag` excludes it. Use `group_by[]=claude_tag_category` to break out per-category values.
maxItems100
One of the following:
"dm"
"engaged"
"monitoring"
"proactive"
"scheduled"
claude_tag_user_ids: optional array of string
Filter to Claude Tag (Claude in Slack) usage attributed to specific Slack users, by Slack user ID (for example `U0123ABCDEF`), not claude.ai user ID. Usage that is not Claude Tag, and Claude Tag usage not attributed to a single user, never matches. Use `group_by[]=claude_tag_user_id` to break out per-user values.
maxItems100
context_windows: optional array of "0-200k" or "200k-1M"
Filter to specific context-window pricing tiers. Use `group_by[]=context_window` to break out per-tier values.
maxItems100
One of the following:
"0-200k"
"200k-1M"
ending_at: optional string
End of range, exclusive. When omitted, defaults to the earlier of now and `starting_at` + 31 days. The range may span at most 31 days.
formatdate-time
group_by: optional array of "claude_tag_category" or "claude_tag_user_id" or "context_window" or 8 more
Dimensions to break each time bucket out by. Defaults to no grouping (one total per bucket). Each bucket reports at most its top 100 groups; a group beyond that cap has no row in that bucket (there is no remainder row), so grouped buckets are not exhaustive when a dimension has more than 100 distinct values.
maxItems100
One of the following:
"claude_tag_category"
"claude_tag_user_id"
"context_window"
"cost_type"
"inference_geo"
"model"
"product"
"rbac_group_id"
"slack_channel_id"
"speed"
"token_type"
inference_geos: optional array of "global" or "not_available" or "us"
Filter to specific inference regions. `not_available` matches rows where the region is unset. Use `group_by[]=inference_geo` to break out per-region values.
maxItems100
One of the following:
"global"
"not_available"
"us"
limit: optional number
Maximum number of time buckets per page. Defaults and caps vary by `bucket_width` (`1d`: default 7, max 31; `1h`: default 24, max 168; `1m`: default 60, max 256).
minimum1
models: optional array of string
Models to include. Defaults to all models. Use `group_by[]=model` to break out per-model values.
maxItems100
page: optional string
Opaque cursor from a previous response's `next_page` field.
products: optional array of "chat" or "claude-tag" or "claude_code" or 4 more
Product surfaces to include. Defaults to all products. Use `group_by[]=product` to break out per-product values.
maxItems100
One of the following:
"chat"
"claude-tag"
"claude_code"
"claude_design"
"claude_in_chrome"
"cowork"
"office_agent"
rbac_group_ids: optional array of string
Filter to usage attributed to specific RBAC groups. Accepts tagged RBAC group IDs (`rbac_group_...`) or bare group UUIDs. A row matches when the user belonged to any of the listed groups on the (UTC) day the usage occurred; usage with no group attribution never matches.
maxItems100
slack_channel_ids: optional array of string
Filter to usage originating from specific Slack channels. Use `group_by[]=slack_channel_id` to break out per-channel values.
maxItems100
speeds: optional array of "fast" or "standard"
Filter to fast or standard inference mode. Use `group_by[]=speed` to break out per-mode values.
maxItems100
One of the following:
"fast"
"standard"
user_ids: optional array of string
Filter to specific users by tagged user ID.
maxItems100
##### Returns
CostBucket object{ data, data_refreshed_at, has_more, 2 more }
Get Cost Over Time
cURL
```python
curl https://api.anthropic.com/v1/organizations/analytics/cost_report \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY"
```
Response 200
```python
{
"data": [
{
"ending_at": "2019-12-27T18:11:19.117Z",
"results": [
{
"amount": "amount",
"claude_tag_category": "dm",
"claude_tag_user_id": "U0123ABCDEF",
"context_window": "0-200k",
"cost_type": "code_execution",
"currency": "USD",
"inference_geo": "global",
"list_amount": "list_amount",
"model": "claude-opus-5",
"product": "chat",
"rbac_group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"requests": 0,
"slack_channel_id": "C0123ABCDEF",
"speed": "fast",
"token_type": "cache_creation.ephemeral_1h_input_tokens"
}
],
"starting_at": "2019-12-27T18:11:19.117Z"
}
],
"data_refreshed_at": "2019-12-27T18:11:19.117Z",
"has_more": true,
"next_page": "next_page",
"organization_id": "org_013FP9SaFPBg7Kw7fetjn6cF"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"ending_at": "2019-12-27T18:11:19.117Z",
"results": [
{
"amount": "amount",
"claude_tag_category": "dm",
"claude_tag_user_id": "U0123ABCDEF",
"context_window": "0-200k",
"cost_type": "code_execution",
"currency": "USD",
"inference_geo": "global",
"list_amount": "list_amount",
"model": "claude-opus-5",
"product": "chat",
"rbac_group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"requests": 0,
"slack_channel_id": "C0123ABCDEF",
"speed": "fast",
"token_type": "cache_creation.ephemeral_1h_input_tokens"
}
],
"starting_at": "2019-12-27T18:11:19.117Z"
}
],
"data_refreshed_at": "2019-12-27T18:11:19.117Z",
"has_more": true,
"next_page": "next_page",
"organization_id": "org_013FP9SaFPBg7Kw7fetjn6cF"
---
## Cost - Claude API Reference
Source: https://platform.claude.com/docs/en/api/http/admin/analytics/cost
Path: 04-API-Reference/Admin/http-admin-analytics-cost.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fhttp%2Fadmin%2Fanalytics%2Fcost)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
API Keys
External Keys
Usage Report
Cost Report
Analytics
Get Activity Summaries
Usage
Cost
Get Cost Over Time
Get Per-User Cost
Users
Skills
Connectors
Chat Projects
Plugins
Artifacts
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [Analytics](http-admin-analytics.md)
# Cost
##### [Get Cost Over Time](http-admin-analytics-cost-list.md)
GET/v1/organizations/analytics/cost_report
##### [Get Per-User Cost](http-admin-analytics-cost-list-by-user.md)
GET/v1/organizations/analytics/user_cost_report
##### Models
CostBucket object{ data, data_refreshed_at, has_more, 2 more }
UserCost object{ data, data_refreshed_at, has_more, 2 more }
---
## Get Plugin Usage - Claude API Reference
Source: https://platform.claude.com/docs/en/api/http/admin/analytics/plugins/list
Path: 04-API-Reference/Admin/http-admin-analytics-plugins-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fhttp%2Fadmin%2Fanalytics%2Fplugins%2Flist)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
API Keys
External Keys
Usage Report
Cost Report
Analytics
Get Activity Summaries
Usage
Cost
Users
Skills
Connectors
Chat Projects
Plugins
Get Plugin Usage
Artifacts
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [Analytics](http-admin-analytics.md)
4. [Plugins](http-admin-analytics-plugins.md)
# Get Plugin Usage
GET/v1/organizations/analytics/plugins
Get per-plugin install + invocation usage for a given day, with pagination.
Returns plugin usage metrics for the organization across Cowork and Claude Code, sorted by plugin name. The `plugin_name` value `third-party` is an aggregate bucket, not a plugin: it collects plugin activity, from either surface, for which the reporting client did not provide a plugin name — so an organization's own plugins can contribute both to their own named rows and to this bucket. Use `group_by[]` to break usage out per member, per RBAC group, or per product surface (Cowork / Claude Code), and `filter[]` to scope results; the parameter descriptions list the supported dimensions. Requires an API key with the `read:analytics` scope. `starting_date` / `ending_date` select range-rollup mode like `/skills`.
##### Query parameters
date: optional string
UTC date in YYYY-MM-DD format. The day to get plugin usage for. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day) and may be revised by a few percent over the following days. No earlier than 2026-01-01.
formatdate
ending_date: optional string
UTC date in YYYY-MM-DD format. End of the date range (exclusive); only valid with `starting_date`. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day), so this can be at most today — which is also the default when omitted, resolved once when the first page is served and reused for the rest of the pagination sequence. At most 366 days after `starting_date`.
formatdate
filter: optional array of string
Filters as `dimension:value`, e.g. `filter[]=rbac_group_id:{id}`. Repeat the param for OR within a dimension and across dimensions for AND. Supported dimensions on this endpoint: `plugin_name`, `product`, `rbac_group_id`, `user_id`. Value forms: `plugin_name` matches case-insensitively; `product` is `claude_code` or `cowork` (the only surfaces with plugin attribution); `rbac_group_id` takes the tagged id (`rbac_group_...`, as emitted in responses and by the spend-limits API) or a bare group UUID, and matches users who held the group at any point during each covered UTC day (time-of-usage attribution); `user_id` takes a tagged user id (`user_...`), as emitted in responses. An unsupported dimension returns 400. At most 100 entries.
maxItems100
group_by: optional array of "product" or "rbac_group_id" or "user_id"
Dimensions to break results out by (e.g. `group_by[]=user_id`). Supported on this endpoint: `product`, `rbac_group_id`, `user_id`. On this endpoint `product` takes the values `claude_code` or `cowork` only (the surfaces with plugin attribution). Grouped rows carry the requested dimension values as additional fields and paginate like ungrouped responses via `next_page`; an unsupported dimension returns 400. `rbac_group_id` attributes a user to every group they held at any point during each covered UTC day, so grouped rows are not an exclusive partition and can sum above org-level totals. At most 100 entries.
maxItems100
One of the following:
"product"
"rbac_group_id"
"user_id"
limit: optional number
Number of results per page (1-1000, default 100).
minimum1
maximum1000
order: optional "asc" or "desc"
Sort direction: `asc` or `desc`. Defaults to `asc` for the endpoint's sort column and to `desc` when `order_by` names a metric (a top-N ranking). Applies to `order_by`, or to the endpoint's default sort field when `order_by` is omitted.
One of the following:
"asc"
"desc"
order_by: optional string
Sort field. Restricted to the endpoint's sort column plus its rankable metrics (metrics default to descending; a few metrics rank in date-range mode only, per the endpoint's documented orderable set).
page: optional string
Opaque cursor from a previous response's `next_page` field.
starting_date: optional string
UTC date in YYYY-MM-DD format. Start of a date range (inclusive). Enables rollup mode: one row per entity aggregated over the whole range — addable counters are summed across days, and a distinct count is never summed where summing could double-count (a field's range value is recomputed exactly over the window, approximate via HLL with typical error under 2%, null, or — for the creation-event counts, whose per-day values cannot overlap — a per-day sum that is itself exact; each field's own description says which). Use either `date` or `starting_date`, not both. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day) and may be revised by a few percent over the following days. No earlier than 2026-01-01.
formatdate
##### Returns
PluginUsage object{ data, next_page }
Response for GET /v1/organizations/analytics/plugins.
Get Plugin Usage
cURL
```python
curl https://api.anthropic.com/v1/organizations/analytics/plugins \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY"
```
Response 200
```python
{
"data": [
{
"claude_code_metrics": {
"distinct_session_plugin_used_count": 0
},
"cowork_metrics": {
"distinct_session_plugin_used_count": 0
},
"distinct_user_count": 0,
"install_count": 0,
"invocation_count": 0,
"plugin_name": "plugin_name",
"plugin_id": "plugin_id",
"product": "product",
"rbac_group_id": "rbac_group_id",
"rbac_group_name": "rbac_group_name",
"user_id": "user_id"
}
],
"next_page": "next_page"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"claude_code_metrics": {
"distinct_session_plugin_used_count": 0
},
"cowork_metrics": {
"distinct_session_plugin_used_count": 0
},
"distinct_user_count": 0,
"install_count": 0,
"invocation_count": 0,
"plugin_name": "plugin_name",
"plugin_id": "plugin_id",
"product": "product",
"rbac_group_id": "rbac_group_id",
"rbac_group_name": "rbac_group_name",
---
## Plugins - Claude API Reference
Source: https://platform.claude.com/docs/en/api/http/admin/analytics/plugins
Path: 04-API-Reference/Admin/http-admin-analytics-plugins.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fhttp%2Fadmin%2Fanalytics%2Fplugins)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
API Keys
External Keys
Usage Report
Cost Report
Analytics
Get Activity Summaries
Usage
Cost
Users
Skills
Connectors
Chat Projects
Plugins
Get Plugin Usage
Artifacts
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [Analytics](http-admin-analytics.md)
# Plugins
##### [Get Plugin Usage](http-admin-analytics-plugins-list.md)
GET/v1/organizations/analytics/plugins
##### Models
PluginUsage object{ data, next_page }
Response for GET /v1/organizations/analytics/plugins.
---
## Get Activity Summaries - Claude API Reference
Source: https://platform.claude.com/docs/en/api/http/admin/analytics/retrieve_summaries
Path: 04-API-Reference/Admin/http-admin-analytics-retrieve-summaries.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fhttp%2Fadmin%2Fanalytics%2Fretrieve_summaries)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
API Keys
External Keys
Usage Report
Cost Report
Analytics
Get Activity Summaries
Usage
Cost
Users
Skills
Connectors
Chat Projects
Plugins
Artifacts
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [Analytics](http-admin-analytics.md)
# Get Activity Summaries
GET/v1/organizations/analytics/summaries
Get organization-wide activity summaries for a date range.
Returns one entry per day from `starting_date` (inclusive) to `ending_date` (exclusive). Data is typically available with a 1-day lag and may be revised by a few percent over the following days: when `ending_date` is omitted it defaults to the most recent available day + 1, so the last entry covers the most recent available day. The series can be scoped to an RBAC group via `filter[]=rbac_group_id:{id}`. Available to organizations on a Claude Enterprise plan. Requires an API key with the `read:analytics` scope.
##### Query parameters
starting_date: string
UTC date in YYYY-MM-DD format. Start of the date range (inclusive). Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day) and may be revised by a few percent over the following days. No earlier than 2026-01-01.
formatdate
ending_date: optional string
UTC date in YYYY-MM-DD format. End of the date range (exclusive). Data is typically available with a 1-day lag, so this can be at most today — which is also the default when omitted, making the last entry cover the most recent available day. Data may be revised by a few percent over the following days. The range may span at most 366 days.
formatdate
filter: optional array of string
Filters as `dimension:value`. Only `rbac_group_id` is supported (e.g. `filter[]=rbac_group_id:{id}`); repeat the param to OR across groups. Scopes the whole day series to members of the matching group(s), re-aggregated from member-level activity — org-wide seat/invite fields and the adoption rates derived from them are null on scoped rows. `rbac_group_id` accepts the tagged id (`rbac_group_...`, as emitted in responses and by the spend-limits API) or a bare group UUID, and matches users who held the group at any point during each UTC day (time-of-usage attribution). At most 100 entries.
maxItems100
##### Returns
ActivitySummary object{ summaries }
Response for GET /v1/organizations/analytics/summaries.
Get Activity Summaries
cURL
```python
curl https://api.anthropic.com/v1/organizations/analytics/summaries \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY"
```
Response 200
```python
{
"summaries": [
{
"assigned_seat_count": 0,
"cowork_daily_active_user_count": 0,
"cowork_monthly_active_user_count": 0,
"cowork_weekly_active_user_count": 0,
"daily_active_user_count": 0,
"daily_adoption_rate": 0,
"ending_at": "2019-12-27T18:11:19.117Z",
"monthly_active_user_count": 0,
"monthly_adoption_rate": 0,
"pending_invite_count": 0,
"starting_at": "2019-12-27T18:11:19.117Z",
"weekly_active_user_count": 0,
"weekly_adoption_rate": 0,
"chat_daily_active_user_count": 0,
"chat_monthly_active_user_count": 0,
"chat_weekly_active_user_count": 0,
"claude_code_daily_active_user_count": 0,
"claude_code_monthly_active_user_count": 0,
"claude_code_weekly_active_user_count": 0,
"claude_design_daily_active_user_count": 0,
"claude_design_monthly_active_user_count": 0,
"claude_design_weekly_active_user_count": 0,
"office_agent_daily_active_user_count": 0,
"office_agent_monthly_active_user_count": 0,
"office_agent_weekly_active_user_count": 0,
"science_daily_active_user_count": 0,
"science_entitled_user_count": 0,
"science_monthly_active_user_count": 0,
"science_weekly_active_user_count": 0
}
]
}
```
##### Returns Examples
Response 200
```python
{
"summaries": [
{
"assigned_seat_count": 0,
"cowork_daily_active_user_count": 0,
"cowork_monthly_active_user_count": 0,
"cowork_weekly_active_user_count": 0,
"daily_active_user_count": 0,
"daily_adoption_rate": 0,
"ending_at": "2019-12-27T18:11:19.117Z",
"monthly_active_user_count": 0,
"monthly_adoption_rate": 0,
"pending_invite_count": 0,
"starting_at": "2019-12-27T18:11:19.117Z",
"weekly_active_user_count": 0,
"weekly_adoption_rate": 0,
"chat_daily_active_user_count": 0,
"chat_monthly_active_user_count": 0,
"chat_weekly_active_user_count": 0,
"claude_code_daily_active_user_count": 0,
"claude_code_monthly_active_user_count": 0,
"claude_code_weekly_active_user_count": 0,
"claude_design_daily_active_user_count": 0,
"claude_design_monthly_active_user_count": 0,
"claude_design_weekly_active_user_count": 0,
"office_agent_daily_active_user_count": 0,
"office_agent_monthly_active_user_count": 0,
"office_agent_weekly_active_user_count": 0,
"science_daily_active_user_count": 0,
"science_entitled_user_count": 0,
"science_monthly_active_user_count": 0,
"science_weekly_active_user_count": 0
---
## Get Skill Usage - Claude API Reference
Source: https://platform.claude.com/docs/en/api/http/admin/analytics/skills/list
Path: 04-API-Reference/Admin/http-admin-analytics-skills-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fhttp%2Fadmin%2Fanalytics%2Fskills%2Flist)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
API Keys
External Keys
Usage Report
Cost Report
Analytics
Get Activity Summaries
Usage
Cost
Users
Skills
Get Skill Usage
Connectors
Chat Projects
Plugins
Artifacts
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [Analytics](http-admin-analytics.md)
4. [Skills](http-admin-analytics-skills.md)
# Get Skill Usage
GET/v1/organizations/analytics/skills
Get per-skill usage for a given day, with cursor-based pagination.
Returns skill usage metrics for the organization, sorted by skill name. Use `group_by[]` to break usage out per member, per RBAC group, or per product surface, and `filter[]` to scope results; the parameter descriptions list the supported dimensions. Available to organizations on a Claude Enterprise plan. Requires an API key with the `read:analytics` scope.
##### Query parameters
date: optional string
UTC date in YYYY-MM-DD format. The day to get skill usage for. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day) and may be revised by a few percent over the following days. No earlier than 2026-01-01.
formatdate
ending_date: optional string
UTC date in YYYY-MM-DD format. End of the date range (exclusive); only valid with `starting_date`. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day), so this can be at most today — which is also the default when omitted, resolved once when the first page is served and reused for the rest of the pagination sequence. At most 366 days after `starting_date`.
formatdate
filter: optional array of string
Filters as `dimension:value`, e.g. `filter[]=rbac_group_id:{id}`. Repeat the param for OR within a dimension and across dimensions for AND. Supported dimensions on this endpoint: `product`, `rbac_group_id`, `share_status`, `skill_name`, `user_id`. Value forms: `product` is one of `chat`, `claude_code`, `cowork`, or `office_agent`; `rbac_group_id` takes the tagged id (`rbac_group_...`, as emitted in responses and by the spend-limits API) or a bare group UUID, and matches users who held the group at any point during each covered UTC day (time-of-usage attribution); `share_status` is one of `organization`, `private`, or `public`; `skill_name` matches case-insensitively; `user_id` takes a tagged user id (`user_...`), as emitted in responses. An unsupported dimension returns 400. At most 100 entries.
maxItems100
group_by: optional array of "product" or "rbac_group_id" or "user_id"
Dimensions to break results out by (e.g. `group_by[]=user_id`). Supported on this endpoint: `product`, `rbac_group_id`, `user_id`. Grouped rows carry the requested dimension values as additional fields and paginate like ungrouped responses via `next_page`; an unsupported dimension returns 400. `rbac_group_id` attributes a user to every group they held at any point during each covered UTC day, so grouped rows are not an exclusive partition and can sum above org-level totals. At most 100 entries.
maxItems100
One of the following:
"product"
"rbac_group_id"
"user_id"
limit: optional number
Number of results per page (1-1000, default 100).
minimum1
maximum1000
order: optional "asc" or "desc"
Sort direction: `asc` or `desc`. Defaults to `asc` for the endpoint's sort column and to `desc` when `order_by` names a metric (a top-N ranking). Applies to `order_by`, or to the endpoint's default sort field when `order_by` is omitted.
One of the following:
"asc"
"desc"
order_by: optional string
Sort field. Restricted to the endpoint's sort column plus its rankable metrics (metrics default to descending; a few metrics rank in date-range mode only, per the endpoint's documented orderable set).
page: optional string
Opaque cursor from a previous response's `next_page` field.
starting_date: optional string
UTC date in YYYY-MM-DD format. Start of a date range (inclusive). Enables rollup mode: one row per entity aggregated over the whole range — addable counters are summed across days, and a distinct count is never summed where summing could double-count (a field's range value is recomputed exactly over the window, approximate via HLL with typical error under 2%, null, or — for the creation-event counts, whose per-day values cannot overlap — a per-day sum that is itself exact; each field's own description says which). Use either `date` or `starting_date`, not both. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day) and may be revised by a few percent over the following days. No earlier than 2026-01-01.
formatdate
##### Returns
SkillUsage object{ data, next_page }
Response for GET /v1/organizations/analytics/skills.
Get Skill Usage
cURL
```python
curl https://api.anthropic.com/v1/organizations/analytics/skills \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY"
```
Response 200
```python
{
"data": [
{
"chat_metrics": {
"distinct_conversation_skill_used_count": 0
},
"claude_code_metrics": {
"distinct_session_skill_used_count": 0
},
"cowork_metrics": {
"distinct_session_skill_used_count": 0
},
"distinct_user_count": 0,
"office_metrics": {
"excel": {
"distinct_session_skill_used_count": 0
},
"outlook": {
"distinct_session_skill_used_count": 0
},
"powerpoint": {
"distinct_session_skill_used_count": 0
},
"word": {
"distinct_session_skill_used_count": 0
}
},
"skill_name": "skill_name",
"attributed_list_price": "attributed_list_price",
"currency": "USD",
"enable_count": 0,
"estimated_overage_spend": "estimated_overage_spend",
"invocation_count": 0,
"product": "product",
"rbac_group_id": "rbac_group_id",
"rbac_group_name": "rbac_group_name",
"share_status": "organization",
"skill_display_name": "skill_display_name",
"user_id": "user_id"
}
],
"next_page": "next_page"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"chat_metrics": {
"distinct_conversation_skill_used_count": 0
},
"claude_code_metrics": {
"distinct_session_skill_used_count": 0
},
"cowork_metrics": {
"distinct_session_skill_used_count": 0
},
"distinct_user_count": 0,
"office_metrics": {
"excel": {
"distinct_session_skill_used_count": 0
},
"outlook": {
"distinct_session_skill_used_count": 0
},
"powerpoint": {
"distinct_session_skill_used_count": 0
},
"word": {
"distinct_session_skill_used_count": 0
}
},
"skill_name": "skill_name",
"attributed_list_price": "attributed_list_price",
"currency": "USD",
"enable_count": 0,
"estimated_overage_spend": "estimated_overage_spend",
"invocation_count": 0,
"product": "product",
"rbac_group_id": "rbac_group_id",
"rbac_group_name": "rbac_group_name",
"share_status": "organization",
"skill_display_name": "skill_display_name",
---
## Skills - Claude API Reference
Source: https://platform.claude.com/docs/en/api/http/admin/analytics/skills
Path: 04-API-Reference/Admin/http-admin-analytics-skills.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fhttp%2Fadmin%2Fanalytics%2Fskills)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
API Keys
External Keys
Usage Report
Cost Report
Analytics
Get Activity Summaries
Usage
Cost
Users
Skills
Get Skill Usage
Connectors
Chat Projects
Plugins
Artifacts
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [Analytics](http-admin-analytics.md)
# Skills
##### [Get Skill Usage](http-admin-analytics-skills-list.md)
GET/v1/organizations/analytics/skills
##### Models
SkillUsage object{ data, next_page }
Response for GET /v1/organizations/analytics/skills.
---
## Get Per-User Token Usage - Claude API Reference
Source: https://platform.claude.com/docs/en/api/http/admin/analytics/usage/list_by_user
Path: 04-API-Reference/Admin/http-admin-analytics-usage-list-by-user.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fhttp%2Fadmin%2Fanalytics%2Fusage%2Flist_by_user)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
API Keys
External Keys
Usage Report
Cost Report
Analytics
Get Activity Summaries
Usage
Get Token Usage Over Time
Get Per-User Token Usage
Cost
Users
Skills
Connectors
Chat Projects
Plugins
Artifacts
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [Analytics](http-admin-analytics.md)
4. [Usage](http-admin-analytics-usage.md)
# Get Per-User Token Usage
GET/v1/organizations/analytics/user_usage_report
Get per-user token usage across a date range.
Returns one row per user, ranked by the chosen token metric. Use this to see which users consume the most tokens. Only usage attributable to a seat user is included; for organization-wide totals including direct API-key and automation traffic, use the bucketed `/v1/organizations/analytics/usage_report` endpoint. Available to organizations on a Claude Enterprise plan. Requires an API key with the `read:analytics` scope.
##### Query parameters
starting_at: string
Start of range, inclusive. RFC 3339 tz-aware. Must be within the last 365 days and no earlier than 2026-01-01T00:00:00Z.
formatdate-time
bucket_width: optional "1d" or "1h" or "1m"
Time-bucket granularity. When set, each row's `starting_at` and `ending_at` are populated and one actor may span several rows (one per time bucket with usage). The time bucket counts toward `limit`, so one page can return multiple rows for the same actor. `ending_at` is required when `bucket_width` is set, and with `bucket_width="1m"` the range may span at most 24 hours. When omitted, each row aggregates the full `[starting_at, ending_at)` range.
One of the following:
"1d"
"1h"
"1m"
claude_tag_categories: optional array of "dm" or "engaged" or "monitoring" or 2 more
Filter to Claude Tag (Claude in Slack) usage in specific spend categories. Usage with no category never matches. `dm` usage is reported under the user's product rather than `claude-tag`, so combining this filter with `products[]=claude-tag` excludes it. Use `group_by[]=claude_tag_category` to break out per-category values.
maxItems100
One of the following:
"dm"
"engaged"
"monitoring"
"proactive"
"scheduled"
claude_tag_user_ids: optional array of string
Filter to Claude Tag (Claude in Slack) usage attributed to specific Slack users, by Slack user ID (for example `U0123ABCDEF`), not claude.ai user ID. Usage that is not Claude Tag, and Claude Tag usage not attributed to a single user, never matches. Use `group_by[]=claude_tag_user_id` to break out per-user values.
maxItems100
context_windows: optional array of "0-200k" or "200k-1M"
Filter to specific context-window pricing tiers. Use `group_by[]=context_window` to break out per-tier values.
maxItems100
One of the following:
"0-200k"
"200k-1M"
ending_at: optional string
End of range, exclusive. When omitted, defaults to the earlier of now and `starting_at` + 31 days. The range may span at most 31 days.
formatdate-time
exclude_deleted_users: optional boolean
If true, omit rows for users who are deleted (`deleted: true`). A page may contain fewer than `limit` rows; use `has_more` and `next_page` to paginate as usual.
defaultfalse
group_by: optional array of "claude_tag_category" or "claude_tag_user_id" or "context_window" or 6 more
Break each actor's row out by the given dimensions. Accepts the same values as the bucketed `/usage_report` endpoint. `limit` bounds (actor × time bucket × dimension) rows — with dimensions or `bucket_width` present, one actor may span several rows.
maxItems100
One of the following:
"claude_tag_category"
"claude_tag_user_id"
"context_window"
"inference_geo"
"model"
"product"
"rbac_group_id"
"slack_channel_id"
"speed"
inference_geos: optional array of "global" or "not_available" or "us"
Filter to specific inference regions. `not_available` matches rows where the region is unset. Use `group_by[]=inference_geo` to break out per-region values.
maxItems100
One of the following:
"global"
"not_available"
"us"
limit: optional number
Number of rows per page (1-1000, default 20). One row per actor unless `group_by[]` or `bucket_width` splits an actor across rows; `cost_type`/`token_type` fan-out rows (cost endpoint only) are the exception — they do not count toward this limit, so `data` can exceed it.
default20
maximum1000
minimum1
models: optional array of string
Models to include. Defaults to all models. Use `group_by[]=model` to break out per-model values.
maxItems100
order: optional "asc" or "desc"
Sort direction. Defaults to `desc`.
defaultdesc
One of the following:
"asc"
"desc"
order_by: optional "output_tokens" or "requests" or "total_tokens" or "uncached_input_tokens"
Metric to rank actors by. Defaults to `total_tokens`.
defaulttotal_tokens
One of the following:
"output_tokens"
"requests"
"total_tokens"
"uncached_input_tokens"
page: optional string
Opaque cursor from a previous response's `next_page` field.
products: optional array of "chat" or "claude-tag" or "claude_code" or 4 more
Product surfaces to include. Defaults to all products.
maxItems100
One of the following:
"chat"
"claude-tag"
"claude_code"
"claude_design"
"claude_in_chrome"
"cowork"
"office_agent"
rbac_group_ids: optional array of string
Filter to usage attributed to specific RBAC groups. Accepts tagged RBAC group IDs (`rbac_group_...`) or bare group UUIDs. A row matches when the user belonged to any of the listed groups on the (UTC) day the usage occurred; usage with no group attribution never matches.
maxItems100
slack_channel_ids: optional array of string
Filter to usage originating from specific Slack channels. Use `group_by[]=slack_channel_id` to break out per-channel values.
maxItems100
speeds: optional array of "fast" or "standard"
Filter to fast or standard inference mode. Use `group_by[]=speed` to break out per-mode values.
maxItems100
One of the following:
"fast"
"standard"
user_ids: optional array of string
Filter to specific users by tagged user ID.
maxItems100
##### Returns
UserUsage object{ data, data_refreshed_at, has_more, 2 more }
Get Per-User Token Usage
cURL
```python
curl https://api.anthropic.com/v1/organizations/analytics/user_usage_report \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY"
```
Response 200
```python
{
"data": [
{
"actor": {
"deleted": true,
"email": "jane@example.com",
"name": "Jane Smith",
"type": "user_actor",
"user_id": "user_01AbCdEfGhIjKlMnOpQrSt"
},
"cache_creation": {
"ephemeral_1h_input_tokens": 1000,
"ephemeral_5m_input_tokens": 500
},
"cache_read_input_tokens": 3200000,
"claude_tag_category": "dm",
"claude_tag_user_id": "U0123ABCDEF",
"context_window": "0-200k",
"ending_at": "2019-12-27T18:11:19.117Z",
"inference_geo": "global",
"model": "claude-opus-5",
"output_tokens": 891000,
"product": "chat",
"rbac_group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"requests": 128,
"server_tool_use": {
"web_search_requests": 10
},
"slack_channel_id": "C0123ABCDEF",
"speed": "fast",
"starting_at": "2019-12-27T18:11:19.117Z",
"total_tokens": 5377000,
"uncached_input_tokens": 1284500
}
],
"data_refreshed_at": "2019-12-27T18:11:19.117Z",
"has_more": true,
"next_page": "next_page",
"organization_id": "org_013FP9SaFPBg7Kw7fetjn6cF"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"actor": {
"deleted": true,
"email": "jane@example.com",
"name": "Jane Smith",
"type": "user_actor",
"user_id": "user_01AbCdEfGhIjKlMnOpQrSt"
},
"cache_creation": {
"ephemeral_1h_input_tokens": 1000,
"ephemeral_5m_input_tokens": 500
},
"cache_read_input_tokens": 3200000,
"claude_tag_category": "dm",
"claude_tag_user_id": "U0123ABCDEF",
"context_window": "0-200k",
"ending_at": "2019-12-27T18:11:19.117Z",
"inference_geo": "global",
"model": "claude-opus-5",
"output_tokens": 891000,
"product": "chat",
"rbac_group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"requests": 128,
"server_tool_use": {
"web_search_requests": 10
},
"slack_channel_id": "C0123ABCDEF",
"speed": "fast",
"starting_at": "2019-12-27T18:11:19.117Z",
"total_tokens": 5377000,
"uncached_input_tokens": 1284500
}
],
"data_refreshed_at": "2019-12-27T18:11:19.117Z",
"has_more": true,
"next_page": "next_page",
"organization_id": "org_013FP9SaFPBg7Kw7fetjn6cF"
---
## Get Token Usage Over Time - Claude API Reference
Source: https://platform.claude.com/docs/en/api/http/admin/analytics/usage/list
Path: 04-API-Reference/Admin/http-admin-analytics-usage-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fhttp%2Fadmin%2Fanalytics%2Fusage%2Flist)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
API Keys
External Keys
Usage Report
Cost Report
Analytics
Get Activity Summaries
Usage
Get Token Usage Over Time
Get Per-User Token Usage
Cost
Users
Skills
Connectors
Chat Projects
Plugins
Artifacts
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [Analytics](http-admin-analytics.md)
4. [Usage](http-admin-analytics-usage.md)
# Get Token Usage Over Time
GET/v1/organizations/analytics/usage_report
Get token usage over time across a date range.
Returns token usage bucketed by minute, hour, or day, optionally broken down by product, model, context window, inference region, or speed. Available to organizations on a Claude Enterprise plan. Requires an API key with the `read:analytics` scope.
##### Query parameters
starting_at: string
Start of range, inclusive. RFC 3339 tz-aware. Must be within the last 365 days and no earlier than 2026-01-01T00:00:00Z.
formatdate-time
bucket_width: optional "1d" or "1h" or "1m"
Time bucket granularity.
default1d
One of the following:
"1d"
"1h"
"1m"
claude_tag_categories: optional array of "dm" or "engaged" or "monitoring" or 2 more
Filter to Claude Tag (Claude in Slack) usage in specific spend categories. Usage with no category never matches. `dm` usage is reported under the user's product rather than `claude-tag`, so combining this filter with `products[]=claude-tag` excludes it. Use `group_by[]=claude_tag_category` to break out per-category values.
maxItems100
One of the following:
"dm"
"engaged"
"monitoring"
"proactive"
"scheduled"
claude_tag_user_ids: optional array of string
Filter to Claude Tag (Claude in Slack) usage attributed to specific Slack users, by Slack user ID (for example `U0123ABCDEF`), not claude.ai user ID. Usage that is not Claude Tag, and Claude Tag usage not attributed to a single user, never matches. Use `group_by[]=claude_tag_user_id` to break out per-user values.
maxItems100
context_windows: optional array of "0-200k" or "200k-1M"
Filter to specific context-window pricing tiers. Use `group_by[]=context_window` to break out per-tier values.
maxItems100
One of the following:
"0-200k"
"200k-1M"
ending_at: optional string
End of range, exclusive. When omitted, defaults to the earlier of now and `starting_at` + 31 days. The range may span at most 31 days.
formatdate-time
group_by: optional array of "claude_tag_category" or "claude_tag_user_id" or "context_window" or 6 more
Dimensions to break each time bucket out by. Defaults to no grouping (one total per bucket). Each bucket reports at most its top 100 groups; a group beyond that cap has no row in that bucket (there is no remainder row), so grouped buckets are not exhaustive when a dimension has more than 100 distinct values.
maxItems100
One of the following:
"claude_tag_category"
"claude_tag_user_id"
"context_window"
"inference_geo"
"model"
"product"
"rbac_group_id"
"slack_channel_id"
"speed"
inference_geos: optional array of "global" or "not_available" or "us"
Filter to specific inference regions. `not_available` matches rows where the region is unset. Use `group_by[]=inference_geo` to break out per-region values.
maxItems100
One of the following:
"global"
"not_available"
"us"
limit: optional number
Maximum number of time buckets per page. Defaults and caps vary by `bucket_width` (`1d`: default 7, max 31; `1h`: default 24, max 168; `1m`: default 60, max 256).
minimum1
models: optional array of string
Models to include. Defaults to all models. Use `group_by[]=model` to break out per-model values.
maxItems100
page: optional string
Opaque cursor from a previous response's `next_page` field.
products: optional array of "chat" or "claude-tag" or "claude_code" or 4 more
Product surfaces to include. Defaults to all products. Use `group_by[]=product` to break out per-product values.
maxItems100
One of the following:
"chat"
"claude-tag"
"claude_code"
"claude_design"
"claude_in_chrome"
"cowork"
"office_agent"
rbac_group_ids: optional array of string
Filter to usage attributed to specific RBAC groups. Accepts tagged RBAC group IDs (`rbac_group_...`) or bare group UUIDs. A row matches when the user belonged to any of the listed groups on the (UTC) day the usage occurred; usage with no group attribution never matches.
maxItems100
slack_channel_ids: optional array of string
Filter to usage originating from specific Slack channels. Use `group_by[]=slack_channel_id` to break out per-channel values.
maxItems100
speeds: optional array of "fast" or "standard"
Filter to fast or standard inference mode. Use `group_by[]=speed` to break out per-mode values.
maxItems100
One of the following:
"fast"
"standard"
user_ids: optional array of string
Filter to specific users by tagged user ID.
maxItems100
##### Returns
UsageBucket object{ data, data_refreshed_at, has_more, 2 more }
Get Token Usage Over Time
cURL
```python
curl https://api.anthropic.com/v1/organizations/analytics/usage_report \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY"
```
Response 200
```python
{
"data": [
{
"ending_at": "2019-12-27T18:11:19.117Z",
"results": [
{
"cache_creation": {
"ephemeral_1h_input_tokens": 1000,
"ephemeral_5m_input_tokens": 500
},
"cache_read_input_tokens": 0,
"claude_tag_category": "dm",
"claude_tag_user_id": "U0123ABCDEF",
"context_window": "0-200k",
"inference_geo": "global",
"model": "claude-opus-5",
"output_tokens": 0,
"product": "chat",
"rbac_group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"requests": 0,
"server_tool_use": {
"web_search_requests": 10
},
"slack_channel_id": "C0123ABCDEF",
"speed": "fast",
"uncached_input_tokens": 0
}
],
"starting_at": "2019-12-27T18:11:19.117Z"
}
],
"data_refreshed_at": "2019-12-27T18:11:19.117Z",
"has_more": true,
"next_page": "next_page",
"organization_id": "org_013FP9SaFPBg7Kw7fetjn6cF"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"ending_at": "2019-12-27T18:11:19.117Z",
"results": [
{
"cache_creation": {
"ephemeral_1h_input_tokens": 1000,
"ephemeral_5m_input_tokens": 500
},
"cache_read_input_tokens": 0,
"claude_tag_category": "dm",
"claude_tag_user_id": "U0123ABCDEF",
"context_window": "0-200k",
"inference_geo": "global",
"model": "claude-opus-5",
"output_tokens": 0,
"product": "chat",
"rbac_group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"requests": 0,
"server_tool_use": {
"web_search_requests": 10
},
"slack_channel_id": "C0123ABCDEF",
"speed": "fast",
"uncached_input_tokens": 0
}
],
"starting_at": "2019-12-27T18:11:19.117Z"
}
],
"data_refreshed_at": "2019-12-27T18:11:19.117Z",
"has_more": true,
"next_page": "next_page",
"organization_id": "org_013FP9SaFPBg7Kw7fetjn6cF"
---
## Usage - Claude API Reference
Source: https://platform.claude.com/docs/en/api/http/admin/analytics/usage
Path: 04-API-Reference/Admin/http-admin-analytics-usage.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fhttp%2Fadmin%2Fanalytics%2Fusage)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
API Keys
External Keys
Usage Report
Cost Report
Analytics
Get Activity Summaries
Usage
Get Token Usage Over Time
Get Per-User Token Usage
Cost
Users
Skills
Connectors
Chat Projects
Plugins
Artifacts
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [Analytics](http-admin-analytics.md)
# Usage
##### [Get Token Usage Over Time](http-admin-analytics-usage-list.md)
GET/v1/organizations/analytics/usage_report
##### [Get Per-User Token Usage](http-admin-analytics-usage-list-by-user.md)
GET/v1/organizations/analytics/user_usage_report
##### Models
UsageBucket object{ data, data_refreshed_at, has_more, 2 more }
UserUsage object{ data, data_refreshed_at, has_more, 2 more }
---
## List User Activity - Claude API Reference
Source: https://platform.claude.com/docs/en/api/http/admin/analytics/users/list
Path: 04-API-Reference/Admin/http-admin-analytics-users-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fhttp%2Fadmin%2Fanalytics%2Fusers%2Flist)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
API Keys
External Keys
Usage Report
Cost Report
Analytics
Get Activity Summaries
Usage
Cost
Users
List User Activity
Skills
Connectors
Chat Projects
Plugins
Artifacts
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [Analytics](http-admin-analytics.md)
4. [Users](http-admin-analytics-users.md)
# List User Activity
GET/v1/organizations/analytics/users
Get per-user activity for a given day, with cursor-based pagination.
Returns activity metrics for each user in the organization, sorted by email address. Use `group_by[]` for per-RBAC-group aggregates, or `filter[]` to scope results to specific members, groups, or a chat project. Available to organizations on a Claude Enterprise plan. Requires an API key with the `read:analytics` scope.
##### Query parameters
date: optional string
UTC date in YYYY-MM-DD format. The day to get user activity for. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day) and may be revised by a few percent over the following days. No earlier than 2026-01-01.
formatdate
ending_date: optional string
UTC date in YYYY-MM-DD format. End of the date range (exclusive); only valid with `starting_date`. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day), so this can be at most today — which is also the default when omitted, resolved once when the first page is served and reused for the rest of the pagination sequence. At most 366 days after `starting_date`.
formatdate
filter: optional array of string
Filters as `dimension:value`, e.g. `filter[]=rbac_group_id:{id}`. Repeat the param for OR within a dimension and across dimensions for AND. Supported dimensions on this endpoint: `project_id`, `rbac_group_id`, `user_id`. Value forms: `project_id` takes a tagged project id (`claude_proj_...`) and scopes each member's row to their claude.ai chat activity within that project (it cannot be combined with `group_by[]` or an `rbac_group_id` filter); `rbac_group_id` takes the tagged id (`rbac_group_...`, as emitted in responses and by the spend-limits API) or a bare group UUID, and matches users who held the group at any point during each covered UTC day (time-of-usage attribution); `user_id` takes a tagged user id (`user_...`), as emitted in responses. An unsupported dimension returns 400. At most 100 entries.
maxItems100
group_by: optional array of "rbac_group_id"
Dimensions to break results out by (e.g. `group_by[]=rbac_group_id`). Supported on this endpoint: `rbac_group_id`. Rows are already per-member, so the one supported grouping aggregates them per RBAC group instead. Grouped rows carry the requested dimension values as additional fields and paginate like ungrouped responses via `next_page`; an unsupported dimension returns 400. `rbac_group_id` attributes a user to every group they held at any point during each covered UTC day, so grouped rows are not an exclusive partition and can sum above org-level totals. At most 100 entries.
maxItems100
limit: optional number
Number of results per page (1-1000, default 100).
minimum1
maximum1000
order: optional "asc" or "desc"
Sort direction: `asc` or `desc`. Defaults to `asc` for the endpoint's sort column and to `desc` when `order_by` names a metric (a top-N ranking). Applies to `order_by`, or to the endpoint's default sort field when `order_by` is omitted.
One of the following:
"asc"
"desc"
order_by: optional string
Sort field. Restricted to the endpoint's sort column plus its rankable metrics (metrics default to descending; a few metrics rank in date-range mode only, per the endpoint's documented orderable set).
page: optional string
Opaque cursor from a previous response's `next_page` field.
starting_date: optional string
UTC date in YYYY-MM-DD format. Start of a date range (inclusive). Enables rollup mode: one row per entity aggregated over the whole range — addable counters are summed across days, and a distinct count is never summed where summing could double-count (a field's range value is recomputed exactly over the window, approximate via HLL with typical error under 2%, null, or — for the creation-event counts, whose per-day values cannot overlap — a per-day sum that is itself exact; each field's own description says which). Use either `date` or `starting_date`, not both. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day) and may be revised by a few percent over the following days. No earlier than 2026-01-01.
formatdate
##### Returns
UserActivity object{ data, next_page }
Response for GET /v1/organizations/analytics/users.
List User Activity
cURL
```python
curl https://api.anthropic.com/v1/organizations/analytics/users \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY"
```
Response 200
```python
{
"data": [
{
"chat_metrics": {
"connectors_used_count": 0,
"distinct_artifacts_created_count": 0,
"distinct_connectors_used_count": 0,
"distinct_conversation_count": 0,
"distinct_files_uploaded_count": 0,
"distinct_projects_created_count": 0,
"distinct_projects_used_count": 0,
"distinct_shared_artifacts_viewed_count": 0,
"distinct_skills_used_count": 0,
"message_count": 0,
"shared_conversations_viewed_count": 0,
"thinking_message_count": 0
},
"claude_code_metrics": {
"core_metrics": {
"artifacts_created_count": 0,
"commit_count": 0,
"distinct_session_count": 0,
"lines_of_code": {
"added_count": 0,
"removed_count": 0
},
"pull_request_count": 0
},
"tool_actions": {
"edit_tool": {
"accepted_count": 0,
"rejected_count": 0
},
"multi_edit_tool": {
"accepted_count": 0,
"rejected_count": 0
},
"notebook_edit_tool": {
"accepted_count": 0,
"rejected_count": 0
},
"write_tool": {
"accepted_count": 0,
"rejected_count": 0
}
}
},
"cowork_metrics": {
"action_count": 0,
"artifacts_created_count": 0,
"connectors_used_count": 0,
"dispatch_turn_count": 0,
"distinct_connectors_used_count": 0,
"distinct_session_count": 0,
"distinct_skills_used_count": 0,
"message_count": 0,
"skills_used_count": 0,
"distinct_plugins_used_count": 0,
"edit_tool_count": 0,
"file_edit_count": 0,
"multi_edit_tool_count": 0,
"notebook_edit_tool_count": 0,
"plugins_used_count": 0,
"sessions_with_file_edits_count": 0,
"write_tool_count": 0
},
"design_metrics": {
"distinct_projects_created_count": 0,
"distinct_projects_used_count": 0,
"distinct_session_count": 0,
"message_count": 0
},
"office_metrics": {
"excel": {
"connectors_used_count": 0,
"distinct_connectors_used_count": 0,
"distinct_session_count": 0,
"distinct_skills_used_count": 0,
"message_count": 0,
"skills_used_count": 0
},
"outlook": {
"connectors_used_count": 0,
"distinct_connectors_used_count": 0,
"distinct_session_count": 0,
"distinct_skills_used_count": 0,
"message_count": 0,
"skills_used_count": 0
},
"powerpoint": {
"connectors_used_count": 0,
"distinct_connectors_used_count": 0,
"distinct_session_count": 0,
"distinct_skills_used_count": 0,
"message_count": 0,
"skills_used_count": 0
},
"word": {
"connectors_used_count": 0,
"distinct_connectors_used_count": 0,
"distinct_session_count": 0,
"distinct_skills_used_count": 0,
"message_count": 0,
"skills_used_count": 0
}
},
"science_metrics": {
"delegation_count": 0,
"distinct_session_count": 0,
"message_count": 0,
"remote_compute_job_count": 0,
"skills_used_count": 0
},
"web_search_count": 0,
"distinct_user_count": 0,
"last_activity_date": "2019-12-27",
"rbac_group_id": "rbac_group_id",
"rbac_group_name": "rbac_group_name",
"user": {
"id": "id",
"email_address": "email_address",
"type": "user"
}
}
],
"next_page": "next_page"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"chat_metrics": {
"connectors_used_count": 0,
"distinct_artifacts_created_count": 0,
"distinct_connectors_used_count": 0,
"distinct_conversation_count": 0,
"distinct_files_uploaded_count": 0,
"distinct_projects_created_count": 0,
"distinct_projects_used_count": 0,
"distinct_shared_artifacts_viewed_count": 0,
"distinct_skills_used_count": 0,
"message_count": 0,
"shared_conversations_viewed_count": 0,
"thinking_message_count": 0
},
"claude_code_metrics": {
"core_metrics": {
"artifacts_created_count": 0,
"commit_count": 0,
"distinct_session_count": 0,
"lines_of_code": {
"added_count": 0,
"removed_count": 0
},
"pull_request_count": 0
},
"tool_actions": {
"edit_tool": {
"accepted_count": 0,
"rejected_count": 0
},
"multi_edit_tool": {
"accepted_count": 0,
"rejected_count": 0
},
"notebook_edit_tool": {
"accepted_count": 0,
"rejected_count": 0
},
"write_tool": {
"accepted_count": 0,
"rejected_count": 0
}
}
},
"cowork_metrics": {
"action_count": 0,
"artifacts_created_count": 0,
"connectors_used_count": 0,
"dispatch_turn_count": 0,
"distinct_connectors_used_count": 0,
"distinct_session_count": 0,
"distinct_skills_used_count": 0,
"message_count": 0,
"skills_used_count": 0,
"distinct_plugins_used_count": 0,
"edit_tool_count": 0,
"file_edit_count": 0,
"multi_edit_tool_count": 0,
"notebook_edit_tool_count": 0,
"plugins_used_count": 0,
"sessions_with_file_edits_count": 0,
"write_tool_count": 0
},
"design_metrics": {
"distinct_projects_created_count": 0,
"distinct_projects_used_count": 0,
"distinct_session_count": 0,
"message_count": 0
},
"office_metrics": {
"excel": {
"connectors_used_count": 0,
"distinct_connectors_used_count": 0,
"distinct_session_count": 0,
"distinct_skills_used_count": 0,
"message_count": 0,
"skills_used_count": 0
},
"outlook": {
"connectors_used_count": 0,
"distinct_connectors_used_count": 0,
"distinct_session_count": 0,
"distinct_skills_used_count": 0,
"message_count": 0,
"skills_used_count": 0
},
"powerpoint": {
"connectors_used_count": 0,
"distinct_connectors_used_count": 0,
"distinct_session_count": 0,
"distinct_skills_used_count": 0,
"message_count": 0,
"skills_used_count": 0
},
"word": {
"connectors_used_count": 0,
"distinct_connectors_used_count": 0,
"distinct_session_count": 0,
"distinct_skills_used_count": 0,
"message_count": 0,
"skills_used_count": 0
}
},
"science_metrics": {
"delegation_count": 0,
"distinct_session_count": 0,
"message_count": 0,
"remote_compute_job_count": 0,
"skills_used_count": 0
},
"web_search_count": 0,
"distinct_user_count": 0,
"last_activity_date": "2019-12-27",
"rbac_group_id": "rbac_group_id",
"rbac_group_name": "rbac_group_name",
"user": {
"id": "id",
"email_address": "email_address",
---
## Users - Claude API Reference
Source: https://platform.claude.com/docs/en/api/http/admin/analytics/users
Path: 04-API-Reference/Admin/http-admin-analytics-users.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fhttp%2Fadmin%2Fanalytics%2Fusers)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
API Keys
External Keys
Usage Report
Cost Report
Analytics
Get Activity Summaries
Usage
Cost
Users
List User Activity
Skills
Connectors
Chat Projects
Plugins
Artifacts
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
3. [Analytics](http-admin-analytics.md)
# Users
##### [List User Activity](http-admin-analytics-users-list.md)
GET/v1/organizations/analytics/users
##### Models
UserActivity object{ data, next_page }
Response for GET /v1/organizations/analytics/users.
---
## Analytics - Claude API Reference
Source: https://platform.claude.com/docs/en/api/http/admin/analytics
Path: 04-API-Reference/Admin/http-admin-analytics.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fhttp%2Fadmin%2Fanalytics)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
API Keys
External Keys
Usage Report
Cost Report
Analytics
Get Activity Summaries
Usage
Cost
Users
Skills
Connectors
Chat Projects
Plugins
Artifacts
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
2. [Admin](http-admin.md)
# Analytics
##### [Get Activity Summaries](http-admin-analytics-retrieve-summaries.md)
GET/v1/organizations/analytics/summaries
##### Models
ActivitySummary object{ summaries }
Response for GET /v1/organizations/analytics/summaries.
AnalyticsUser object{ id, email_address, type }
A user in the organization, identified by tagged id and email address.
id: string
Tagged user identifier (e.g. `user_...`)
email_address: string
Email address of the user
type: "user"
Object type. Always `user`.
defaultuser
AnalyticsUserActor object{ deleted, email, name, 2 more }
deleted: boolean
True when the account has been deleted, or when the user is no longer a member of the organization or its associated organizations (for example, their membership was removed or they were deprovisioned via your identity provider). `email` stays populated for removed users and is null when the account has been deleted. `name` follows the rules described on that field. The `user_id` is still populated for reconciliation.
email: string or null
The user's email address, including for users who are no longer members of the organization or its associated organizations. Null when the account has been deleted (check `deleted`) and for system-minted service accounts, which have no person's mailbox behind them (check `name`).
name: string or null
The user's full name. Null when the user has not set a name. Returns `"Deleted User"` when the account itself has been deleted, or when the user is no longer a member of the organization or its associated organizations and the organization has chosen to hide the names of removed users. Otherwise, the name stays populated for removed users. Rows for system-minted service accounts render the service name (for example, `"Claude Security"` for usage by Anthropic's security-patching service) or null.
type: "user_actor"
Actor type. Always `"user_actor"`.
user_id: string
Tagged user ID.
ConnectorOfficeProductMetrics object{ distinct_session_connector_used_count }
Office Agent activity metrics for a single connector on a given day within one Office product.
distinct_session_connector_used_count: number or null
Number of distinct Office Agent sessions in which the connector was used. Approximate (HLL, typical error \<2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.
OfficeProductMetrics object{ connectors_used_count, distinct_connectors_used_count, distinct_session_count, 3 more }
Office Agent activity metrics for a single user on a given day within one Office product.
connectors_used_count: number
Number of MCP connector invocations
distinct_connectors_used_count: number or null
Number of distinct MCP connectors used. Approximate (HLL, typical error \<2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.
distinct_session_count: number or null
Number of distinct Office Agent sessions. Approximate (HLL, typical error \<2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.
distinct_skills_used_count: number or null
Number of distinct skills used. Approximate (HLL, typical error \<2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.
message_count: number
Number of messages sent
skills_used_count: number
Number of skill invocations
SkillOfficeProductMetrics object{ distinct_session_skill_used_count }
Office Agent activity metrics for a single skill on a given day within one Office product.
distinct_session_skill_used_count: number or null
Number of distinct Office Agent sessions in which the skill was used. A skill counts as used only when it is explicitly activated — the model (or the user, via the skill's slash command) invokes it, reading its instructions into context as part of that activation. Skills that are merely installed or listed as available, or whose content reaches the context without an activation (preloaded, hook-injected, or read as a plain file), are not counted. Approximate (HLL, typical error \<2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.
ToolActionCounts object{ accepted_count, rejected_count }
Accepted/rejected counts for a single Claude Code tool type.
accepted_count: number
Number of tool proposals accepted
rejected_count: number
Number of tool proposals rejected
#### Analytics[Usage](http-admin-analytics-usage.md)
##### [Get Token Usage Over Time](http-admin-analytics-usage-list.md)
GET/v1/organizations/analytics/usage_report
##### [Get Per-User Token Usage](http-admin-analytics-usage-list-by-user.md)
GET/v1/organizations/analytics/user_usage_report
#### Analytics[Cost](http-admin-analytics-cost.md)
##### [Get Cost Over Time](http-admin-analytics-cost-list.md)
GET/v1/organizations/analytics/cost_report
##### [Get Per-User Cost](http-admin-analytics-cost-list-by-user.md)
GET/v1/organizations/analytics/user_cost_report
#### Analytics[Users](http-admin-analytics-users.md)
##### [List User Activity](http-admin-analytics-users-list.md)
GET/v1/organizations/analytics/users
#### Analytics[Skills](http-admin-analytics-skills.md)
##### [Get Skill Usage](http-admin-analytics-skills-list.md)
GET/v1/organizations/analytics/skills
#### Analytics[Connectors](http-admin-analytics-connectors.md)
##### [Get Connector Usage](http-admin-analytics-connectors-list.md)
GET/v1/organizations/analytics/connectors
#### Analytics[Chat Projects](http-admin-analytics-chat-projects.md)
##### [Get Chat Project Usage](http-admin-analytics-chat-projects-list.md)
GET/v1/organizations/analytics/apps/chat/projects
#### Analytics[Plugins](http-admin-analytics-plugins.md)
##### [Get Plugin Usage](http-admin-analytics-plugins-list.md)
GET/v1/organizations/analytics/plugins
#### Analytics[Artifacts](http-admin-analytics-artifacts.md)
##### [Get Artifact Activity](http-admin-analytics-artifacts-list.md)
GET/v1/organizations/analytics/artifacts
---
## Admin - Claude API Reference
Source: https://platform.claude.com/docs/en/api/http/admin
Path: 04-API-Reference/Admin/http-admin.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fhttp%2Fadmin)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Webhooks
Unwrap
Parse Unverified
Admin
Organizations
Invites
Users
RBAC Groups
RBAC Roles
Workspaces
API Keys
External Keys
Usage Report
Cost Report
Analytics
Spend Limits
Rate Limits
Service Accounts
Federation Issuers
Federation Rules
MCP Tunnels
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
1. [API reference](../Endpoints/http.md)
# Admin
#### Admin[Organizations](https://platform.claude.com/docs/en/api/http/admin/organizations)
##### [Get Current Organization](https://platform.claude.com/docs/en/api/http/admin/organizations/me)
GET/v1/organizations/me
#### Admin[Invites](https://platform.claude.com/docs/en/api/http/admin/invites)
##### [Create Invite](https://platform.claude.com/docs/en/api/http/admin/invites/create)
POST/v1/organizations/invites
##### [Get Invite](https://platform.claude.com/docs/en/api/http/admin/invites/retrieve)
GET/v1/organizations/invites/{invite_id}
##### [List Invites](https://platform.claude.com/docs/en/api/http/admin/invites/list)
GET/v1/organizations/invites
##### [Delete Invite](https://platform.claude.com/docs/en/api/http/admin/invites/delete)
DELETE/v1/organizations/invites/{invite_id}
#### Admin[Users](https://platform.claude.com/docs/en/api/http/admin/users)
##### [Get User](https://platform.claude.com/docs/en/api/http/admin/users/retrieve)
GET/v1/organizations/users/{user_id}
##### [List Users](https://platform.claude.com/docs/en/api/http/admin/users/list)
GET/v1/organizations/users
##### [Update User](https://platform.claude.com/docs/en/api/http/admin/users/update)
POST/v1/organizations/users/{user_id}
##### [Remove User](https://platform.claude.com/docs/en/api/http/admin/users/delete)
DELETE/v1/organizations/users/{user_id}
#### Admin[RBAC Groups](https://platform.claude.com/docs/en/api/http/admin/rbac_groups)
##### [List RBAC Groups](https://platform.claude.com/docs/en/api/http/admin/rbac_groups/list)
GET/v1/organizations/rbac_groups
##### [Get RBAC Group](https://platform.claude.com/docs/en/api/http/admin/rbac_groups/retrieve)
GET/v1/organizations/rbac_groups/{group_id}
##### [Create RBAC Group](https://platform.claude.com/docs/en/api/http/admin/rbac_groups/create)
POST/v1/organizations/rbac_groups
##### [Update RBAC Group](https://platform.claude.com/docs/en/api/http/admin/rbac_groups/update)
POST/v1/organizations/rbac_groups/{group_id}
##### [Delete RBAC Group](https://platform.claude.com/docs/en/api/http/admin/rbac_groups/delete)
DELETE/v1/organizations/rbac_groups/{group_id}
#### AdminRBAC Groups[Members](https://platform.claude.com/docs/en/api/http/admin/rbac_groups/members)
##### [List RBAC Group Members](https://platform.claude.com/docs/en/api/http/admin/rbac_groups/members/list)
GET/v1/organizations/rbac_groups/{group_id}/members
##### [Add RBAC Group Member](https://platform.claude.com/docs/en/api/http/admin/rbac_groups/members/create)
POST/v1/organizations/rbac_groups/{group_id}/members
##### [Remove RBAC Group Member](https://platform.claude.com/docs/en/api/http/admin/rbac_groups/members/delete)
DELETE/v1/organizations/rbac_groups/{group_id}/members/{user_id}
#### Admin[RBAC Roles](https://platform.claude.com/docs/en/api/http/admin/rbac_roles)
##### [List RBAC Roles](https://platform.claude.com/docs/en/api/http/admin/rbac_roles/list)
GET/v1/organizations/rbac_roles
##### [Get RBAC Role](https://platform.claude.com/docs/en/api/http/admin/rbac_roles/retrieve)
GET/v1/organizations/rbac_roles/{role_id}
#### AdminRBAC Roles[Permissions](https://platform.claude.com/docs/en/api/http/admin/rbac_roles/permissions)
##### [List RBAC Role Permissions](https://platform.claude.com/docs/en/api/http/admin/rbac_roles/permissions/list)
GET/v1/organizations/rbac_roles/{role_id}/permissions
#### Admin[Workspaces](https://platform.claude.com/docs/en/api/http/admin/workspaces)
##### [Create Workspace](https://platform.claude.com/docs/en/api/http/admin/workspaces/create)
POST/v1/organizations/workspaces
##### [Get Workspace](https://platform.claude.com/docs/en/api/http/admin/workspaces/retrieve)
GET/v1/organizations/workspaces/{workspace_id}
##### [List Workspaces](https://platform.claude.com/docs/en/api/http/admin/workspaces/list)
GET/v1/organizations/workspaces
##### [Update Workspace](https://platform.claude.com/docs/en/api/http/admin/workspaces/update)
POST/v1/organizations/workspaces/{workspace_id}
##### [Archive Workspace](https://platform.claude.com/docs/en/api/http/admin/workspaces/archive)
POST/v1/organizations/workspaces/{workspace_id}/archive
#### AdminWorkspaces[Members](https://platform.claude.com/docs/en/api/http/admin/workspaces/members)
##### [Create Workspace Member](https://platform.claude.com/docs/en/api/http/admin/workspaces/members/create)
POST/v1/organizations/workspaces/{workspace_id}/members
##### [Get Workspace Member](https://platform.claude.com/docs/en/api/http/admin/workspaces/members/retrieve)
GET/v1/organizations/workspaces/{workspace_id}/members/{user_id}
##### [List Workspace Members](https://platform.claude.com/docs/en/api/http/admin/workspaces/members/list)
GET/v1/organizations/workspaces/{workspace_id}/members
##### [Update Workspace Member](https://platform.claude.com/docs/en/api/http/admin/workspaces/members/update)
POST/v1/organizations/workspaces/{workspace_id}/members/{user_id}
##### [Delete Workspace Member](https://platform.claude.com/docs/en/api/http/admin/workspaces/members/delete)
DELETE/v1/organizations/workspaces/{workspace_id}/members/{user_id}
#### AdminWorkspaces[Rate Limits](https://platform.claude.com/docs/en/api/http/admin/workspaces/rate_limits)
##### [List Workspace Rate Limits](https://platform.claude.com/docs/en/api/http/admin/workspaces/rate_limits/list)
GET/v1/organizations/workspaces/{workspace_id}/rate_limits
#### AdminWorkspaces[Service Accounts](https://platform.claude.com/docs/en/api/http/admin/workspaces/service_accounts)
##### [Create Service Account Workspace Member](https://platform.claude.com/docs/en/api/http/admin/workspaces/service_accounts/create)
POST/v1/organizations/workspaces/{workspace_id}/service_accounts
##### [Get Service Account Workspace Member](https://platform.claude.com/docs/en/api/http/admin/workspaces/service_accounts/retrieve)
GET/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}
##### [List Service Account Workspace Members](https://platform.claude.com/docs/en/api/http/admin/workspaces/service_accounts/list)
GET/v1/organizations/workspaces/{workspace_id}/service_accounts
##### [Update Service Account Workspace Member](https://platform.claude.com/docs/en/api/http/admin/workspaces/service_accounts/update)
POST/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}
##### [Delete Service Account Workspace Member](https://platform.claude.com/docs/en/api/http/admin/workspaces/service_accounts/delete)
DELETE/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}
#### Admin[API Keys](https://platform.claude.com/docs/en/api/http/admin/api_keys)
##### [Retrieve API Key (Admin API)](https://platform.claude.com/docs/en/api/http/admin/api_keys/retrieve)
GET/v1/organizations/api_keys/{api_key_id}
##### [List API Keys](https://platform.claude.com/docs/en/api/http/admin/api_keys/list)
GET/v1/organizations/api_keys
##### [Update API Key](https://platform.claude.com/docs/en/api/http/admin/api_keys/update)
POST/v1/organizations/api_keys/{api_key_id}
#### Admin[External Keys](https://platform.claude.com/docs/en/api/http/admin/external_keys)
##### [Create External Key](https://platform.claude.com/docs/en/api/http/admin/external_keys/create)
POST/v1/organizations/external_keys
##### [List External Keys](https://platform.claude.com/docs/en/api/http/admin/external_keys/list)
GET/v1/organizations/external_keys
##### [Get External Key](https://platform.claude.com/docs/en/api/http/admin/external_keys/retrieve)
GET/v1/organizations/external_keys/{external_key_id}
##### [Update External Key](https://platform.claude.com/docs/en/api/http/admin/external_keys/update)
POST/v1/organizations/external_keys/{external_key_id}
##### [Delete External Key](https://platform.claude.com/docs/en/api/http/admin/external_keys/delete)
DELETE/v1/organizations/external_keys/{external_key_id}
##### [Validate External Key](https://platform.claude.com/docs/en/api/http/admin/external_keys/validate)
POST/v1/organizations/external_keys/{external_key_id}/validate
#### Admin[Usage Report](https://platform.claude.com/docs/en/api/http/admin/usage_report)
##### [Get Messages Usage Report](https://platform.claude.com/docs/en/api/http/admin/usage_report/retrieve_messages)
GET/v1/organizations/usage_report/messages
##### [Get Claude Code Usage Report](https://platform.claude.com/docs/en/api/http/admin/usage_report/retrieve_claude_code)
GET/v1/organizations/usage_report/claude_code
#### Admin[Cost Report](https://platform.claude.com/docs/en/api/http/admin/cost_report)
##### [Get Cost Report](https://platform.claude.com/docs/en/api/http/admin/cost_report/retrieve)
GET/v1/organizations/cost_report
#### Admin[Analytics](http-admin-analytics.md)
##### [Get Activity Summaries](http-admin-analytics-retrieve-summaries.md)
GET/v1/organizations/analytics/summaries
#### AdminAnalytics[Usage](http-admin-analytics-usage.md)
##### [Get Token Usage Over Time](http-admin-analytics-usage-list.md)
GET/v1/organizations/analytics/usage_report
##### [Get Per-User Token Usage](http-admin-analytics-usage-list-by-user.md)
GET/v1/organizations/analytics/user_usage_report
#### AdminAnalytics[Cost](http-admin-analytics-cost.md)
##### [Get Cost Over Time](http-admin-analytics-cost-list.md)
GET/v1/organizations/analytics/cost_report
##### [Get Per-User Cost](http-admin-analytics-cost-list-by-user.md)
GET/v1/organizations/analytics/user_cost_report
#### AdminAnalytics[Users](http-admin-analytics-users.md)
##### [List User Activity](http-admin-analytics-users-list.md)
GET/v1/organizations/analytics/users
#### AdminAnalytics[Skills](http-admin-analytics-skills.md)
##### [Get Skill Usage](http-admin-analytics-skills-list.md)
GET/v1/organizations/analytics/skills
#### AdminAnalytics[Connectors](http-admin-analytics-connectors.md)
##### [Get Connector Usage](http-admin-analytics-connectors-list.md)
GET/v1/organizations/analytics/connectors
#### AdminAnalytics[Chat Projects](http-admin-analytics-chat-projects.md)
##### [Get Chat Project Usage](http-admin-analytics-chat-projects-list.md)
GET/v1/organizations/analytics/apps/chat/projects
#### AdminAnalytics[Plugins](http-admin-analytics-plugins.md)
##### [Get Plugin Usage](http-admin-analytics-plugins-list.md)
GET/v1/organizations/analytics/plugins
#### AdminAnalytics[Artifacts](http-admin-analytics-artifacts.md)
##### [Get Artifact Activity](http-admin-analytics-artifacts-list.md)
GET/v1/organizations/analytics/artifacts
#### Admin[Spend Limits](https://platform.claude.com/docs/en/api/http/admin/spend_limits)
##### [Set Spend Limit](https://platform.claude.com/docs/en/api/http/admin/spend_limits/create)
POST/v1/organizations/spend_limits
##### [Get Spend Limit](https://platform.claude.com/docs/en/api/http/admin/spend_limits/retrieve)
GET/v1/organizations/spend_limits/{spend_limit_id}
##### [Delete Spend Limit](https://platform.claude.com/docs/en/api/http/admin/spend_limits/delete)
DELETE/v1/organizations/spend_limits/{spend_limit_id}
##### [List Effective Spend Limits](https://platform.claude.com/docs/en/api/http/admin/spend_limits/list_effective)
GET/v1/organizations/spend_limits/effective
#### AdminSpend Limits[Increase Requests](https://platform.claude.com/docs/en/api/http/admin/spend_limits/increase_requests)
##### [List Spend Limit Increase Requests](https://platform.claude.com/docs/en/api/http/admin/spend_limits/increase_requests/list)
GET/v1/organizations/spend_limit_increase_requests
##### [Get Spend Limit Increase Request](https://platform.claude.com/docs/en/api/http/admin/spend_limits/increase_requests/retrieve)
GET/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}
##### [Approve Spend Limit Increase Request](https://platform.claude.com/docs/en/api/http/admin/spend_limits/increase_requests/approve)
POST/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}/approve
##### [Deny Spend Limit Increase Request](https://platform.claude.com/docs/en/api/http/admin/spend_limits/increase_requests/deny)
POST/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}/deny
#### Admin[Rate Limits](https://platform.claude.com/docs/en/api/http/admin/rate_limits)
##### [List Organization Rate Limits](https://platform.claude.com/docs/en/api/http/admin/rate_limits/list)
GET/v1/organizations/rate_limits
#### Admin[Service Accounts](https://platform.claude.com/docs/en/api/http/admin/service_accounts)
##### [Create Service Account](https://platform.claude.com/docs/en/api/http/admin/service_accounts/create)
POST/v1/organizations/service_accounts
##### [Get Service Account](https://platform.claude.com/docs/en/api/http/admin/service_accounts/retrieve)
GET/v1/organizations/service_accounts/{service_account_id}
##### [List Service Accounts](https://platform.claude.com/docs/en/api/http/admin/service_accounts/list)
GET/v1/organizations/service_accounts
##### [Update Service Account](https://platform.claude.com/docs/en/api/http/admin/service_accounts/update)
POST/v1/organizations/service_accounts/{service_account_id}
##### [Archive Service Account](https://platform.claude.com/docs/en/api/http/admin/service_accounts/archive)
POST/v1/organizations/service_accounts/{service_account_id}/archive
#### AdminService Accounts[Workspaces](https://platform.claude.com/docs/en/api/http/admin/service_accounts/workspaces)
##### [Add Workspace To Service Account](https://platform.claude.com/docs/en/api/http/admin/service_accounts/workspaces/create)
POST/v1/organizations/service_accounts/{service_account_id}/workspaces
##### [List Workspaces For Service Account](https://platform.claude.com/docs/en/api/http/admin/service_accounts/workspaces/list)
GET/v1/organizations/service_accounts/{service_account_id}/workspaces
##### [Remove Workspace From Service Account](https://platform.claude.com/docs/en/api/http/admin/service_accounts/workspaces/delete)
DELETE/v1/organizations/service_accounts/{service_account_id}/workspaces/{workspace_id}
#### Admin[Federation Issuers](https://platform.claude.com/docs/en/api/http/admin/federation_issuers)
##### [Create Federation Issuer](https://platform.claude.com/docs/en/api/http/admin/federation_issuers/create)
POST/v1/organizations/federation_issuers
##### [Get Federation Issuer](https://platform.claude.com/docs/en/api/http/admin/federation_issuers/retrieve)
GET/v1/organizations/federation_issuers/{federation_issuer_id}
##### [List Federation Issuers](https://platform.claude.com/docs/en/api/http/admin/federation_issuers/list)
GET/v1/organizations/federation_issuers
##### [Update Federation Issuer](https://platform.claude.com/docs/en/api/http/admin/federation_issuers/update)
POST/v1/organizations/federation_issuers/{federation_issuer_id}
##### [Archive Federation Issuer](https://platform.claude.com/docs/en/api/http/admin/federation_issuers/archive)
POST/v1/organizations/federation_issuers/{federation_issuer_id}/archive
#### Admin[Federation Rules](https://platform.claude.com/docs/en/api/http/admin/federation_rules)
##### [Create Federation Rule](https://platform.claude.com/docs/en/api/http/admin/federation_rules/create)
POST/v1/organizations/federation_rules
##### [Get Federation Rule](https://platform.claude.com/docs/en/api/http/admin/federation_rules/retrieve)
GET/v1/organizations/federation_rules/{federation_rule_id}
##### [List Federation Rules](https://platform.claude.com/docs/en/api/http/admin/federation_rules/list)
GET/v1/organizations/federation_rules
##### [Update Federation Rule](https://platform.claude.com/docs/en/api/http/admin/federation_rules/update)
POST/v1/organizations/federation_rules/{federation_rule_id}
##### [Archive Federation Rule](https://platform.claude.com/docs/en/api/http/admin/federation_rules/archive)
POST/v1/organizations/federation_rules/{federation_rule_id}/archive
#### AdminFederation Rules[Workspaces](https://platform.claude.com/docs/en/api/http/admin/federation_rules/workspaces)
##### [List Federation Rule Workspaces](https://platform.claude.com/docs/en/api/http/admin/federation_rules/workspaces/list)
GET/v1/organizations/federation_rules/{federation_rule_id}/workspaces
##### [Add Federation Rule Workspace](https://platform.claude.com/docs/en/api/http/admin/federation_rules/workspaces/create)
POST/v1/organizations/federation_rules/{federation_rule_id}/workspaces
##### [Remove Federation Rule Workspace](https://platform.claude.com/docs/en/api/http/admin/federation_rules/workspaces/delete)
DELETE/v1/organizations/federation_rules/{federation_rule_id}/workspaces/{workspace_id}
#### Admin[MCP Tunnels](https://platform.claude.com/docs/en/api/http/admin/mcp_tunnels)
##### [Get Tunnel](https://platform.claude.com/docs/en/api/http/admin/mcp_tunnels/retrieve)
Deprecated
GET/v1/organizations/tunnels/{tunnel_id}
##### [List Tunnels](https://platform.claude.com/docs/en/api/http/admin/mcp_tunnels/list)
Deprecated
GET/v1/organizations/tunnels
##### [Reveal Tunnel Token](https://platform.claude.com/docs/en/api/http/admin/mcp_tunnels/reveal_token)
Deprecated
POST/v1/organizations/tunnels/{tunnel_id}/reveal_token
##### [Rotate Tunnel Token](https://platform.claude.com/docs/en/api/http/admin/mcp_tunnels/rotate_token)
Deprecated
POST/v1/organizations/tunnels/{tunnel_id}/rotate_token
##### [Archive Tunnel](https://platform.claude.com/docs/en/api/http/admin/mcp_tunnels/archive)
Deprecated
POST/v1/organizations/tunnels/{tunnel_id}/archive
#### AdminMCP Tunnels[Tunnel Certificates](https://platform.claude.com/docs/en/api/http/admin/mcp_tunnels/tunnel_certificates)
##### [Create Tunnel Certificate](https://platform.claude.com/docs/en/api/http/admin/mcp_tunnels/tunnel_certificates/create)
Deprecated
POST/v1/organizations/tunnels/{tunnel_id}/certificates
##### [Get Tunnel Certificate](https://platform.claude.com/docs/en/api/http/admin/mcp_tunnels/tunnel_certificates/retrieve)
Deprecated
GET/v1/organizations/tunnels/{tunnel_id}/certificates/{certificate_id}
##### [List Tunnel Certificates](https://platform.claude.com/docs/en/api/http/admin/mcp_tunnels/tunnel_certificates/list)
Deprecated
GET/v1/organizations/tunnels/{tunnel_id}/certificates
##### [Archive Tunnel Certificate](https://platform.claude.com/docs/en/api/http/admin/mcp_tunnels/tunnel_certificates/archive)
Deprecated
POST/v1/organizations/tunnels/{tunnel_id}/certificates/{certificate_id}/archive
---
## Get Chat Project Usage - Claude API Reference
Source: https://platform.claude.com/docs/en/api/http/beta/organization/analytics/apps/chat/projects/list
Path: 04-API-Reference/Admin/http-beta-organization-analytics-apps-chat-projects-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fhttp%2Fbeta%2Forganization%2Fanalytics%2Fapps%2Fchat%2Fprojects%2Flist)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Summaries
Users
Apps
Chat
Projects
Get Chat Project Usage
Connectors
Plugins
Skills
Artifacts
Usage Report
User Usage Report
Cost Report
User Cost Report
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Analytics](platform-claude-com-http-beta-organization-analytics.md)
5. [Apps](https://platform.claude.com/docs/en/api/http/beta/organization/analytics/apps)
6. [Chat](https://platform.claude.com/docs/en/api/http/beta/organization/analytics/apps/chat)
7. [Projects](http-beta-organization-analytics-apps-chat-projects.md)
# Get Chat Project Usage
GET/v1/organizations/analytics/apps/chat/projects
Get per-project activity for a given day, with cursor-based pagination.
Returns activity metrics for each project in the organization, sorted by project ID. Use `group_by[]` to break projects out per member or per RBAC group, and `filter[]` to scope results; the parameter descriptions list the supported dimensions. Available to organizations on a Claude Enterprise plan. Requires an API key with the `read:analytics` scope.
##### Query parameters
date: optional string
UTC date in YYYY-MM-DD format. The day to get project activity for. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day) and may be revised by a few percent over the following days. No earlier than 2026-01-01.
formatdate
ending_date: optional string
UTC date in YYYY-MM-DD format. End of the date range (exclusive); only valid with `starting_date`. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day), so this can be at most today — which is also the default when omitted, resolved once when the first page is served and reused for the rest of the pagination sequence. At most 366 days after `starting_date`.
formatdate
filter: optional array of string
Filters as `dimension:value`, e.g. `filter[]=rbac_group_id:{id}`. Repeat the param for OR within a dimension and across dimensions for AND. Supported dimensions on this endpoint: `project_id`, `rbac_group_id`, `user_id`. Value forms: `project_id` takes a tagged project id (`claude_proj_...`); `rbac_group_id` takes the tagged id (`rbac_group_...`, as emitted in responses and by the spend-limits API) or a bare group UUID, and matches users who held the group at any point during each covered UTC day (time-of-usage attribution); `user_id` takes a tagged user id (`user_...`), as emitted in responses. An unsupported dimension returns 400. At most 100 entries.
maxItems100
group_by: optional array of "rbac_group_id" or "user_id"
Dimensions to break results out by (e.g. `group_by[]=user_id`). Supported on this endpoint: `rbac_group_id`, `user_id`. Grouped rows carry the requested dimension values as additional fields and paginate like ungrouped responses via `next_page`; an unsupported dimension returns 400. `rbac_group_id` attributes a user to every group they held at any point during each covered UTC day, so grouped rows are not an exclusive partition and can sum above org-level totals. At most 100 entries.
maxItems100
One of the following:
"rbac_group_id"
"user_id"
limit: optional number
Number of results per page (1-1000, default 100).
minimum1
maximum1000
order: optional "asc" or "desc"
Sort direction: `asc` or `desc`. Defaults to `asc` for the endpoint's sort column and to `desc` when `order_by` names a metric (a top-N ranking). Applies to `order_by`, or to the endpoint's default sort field when `order_by` is omitted.
One of the following:
"asc"
"desc"
order_by: optional string
Sort field. Restricted to the endpoint's sort column plus its rankable metrics (metrics default to descending; a few metrics rank in date-range mode only, per the endpoint's documented orderable set).
page: optional string
Opaque cursor from a previous response's `next_page` field.
starting_date: optional string
UTC date in YYYY-MM-DD format. Start of a date range (inclusive). Enables rollup mode: one row per entity aggregated over the whole range — addable counters are summed across days, and a distinct count is never summed where summing could double-count (a field's range value is recomputed exactly over the window, approximate via HLL with typical error under 2%, null, or — for the creation-event counts, whose per-day values cannot overlap — a per-day sum that is itself exact; each field's own description says which). Use either `date` or `starting_date`, not both. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day) and may be revised by a few percent over the following days. No earlier than 2026-01-01.
formatdate
##### Returns
data: array of [BetaAnalyticsProjectActivity](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_project_activity) { distinct_user_count, message_count, project_id, 8 more }
distinct_user_count: number
Number of distinct users who used the project on the requested day, or, in date-range mode, over the requested window — recomputed as an exact distinct count over the window's per-member daily rows, never a sum of per-day values.
message_count: number
Number of messages sent in the project on the requested day
project_id: string
Tagged project identifier (e.g. `claude_proj_...`)
project_name: string
Name of the project
created_at: optional string or null
Project creation timestamp in RFC 3339 format. Null if the project was deleted before attribution was recorded.
formatdate-time
created_by: optional [BetaAnalyticsUser](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_user) { type: "user", id, email_address } or null
User who created the project. Null if the project was deleted before attribution was recorded, or if the creator's account no longer exists.
type: "user"
Object type. Always `user`.
defaultuser
id: string
Tagged user identifier (e.g. `user_...`)
email_address: string
Email address of the user
distinct_conversation_count: optional number or null
Number of distinct conversations in the project. Null on aggregated rows where a distinct count cannot be computed.
product: optional string or null
Product that produced this row's activity: one of `chat`, `claude_code`, `cowork`, or `office_agent` (the canonical Cost & Usage product naming; an `office_agent` row's per-surface breakdown is in its `office_metrics`). On `/plugins` only `cowork` and `claude_code` occur (the only surfaces with plugin attribution); on `/artifacts` only `chat`, `claude_code`, and `cowork` occur (the surfaces that create artifacts); `/apps/chat/projects` does not support the product dimension (a `product` entry in `group_by[]` or `filter[]` there is rejected). Present only when the request grouped by `product`.
rbac_group_id: optional string or null
Tagged RBAC group identifier (`rbac_group_...`), matching the spend-limits API spelling. Present only when the request grouped by `rbac_group_id`.
rbac_group_name: optional string or null
Resolved RBAC group display name, alongside `rbac_group_id` when name resolution is available. Null if the group has been deleted or its name could not be resolved; `rbac_group_id` remains the stable key.
user_id: optional string or null
Tagged user identifier (e.g. `user_...`). Present only when the request grouped by `user_id`.
next_page: string or null
Opaque cursor for the next page, or null if no more results
Get Chat Project Usage
cURL
```python
curl https://api.anthropic.com/v1/organizations/analytics/apps/chat/projects \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"data": [
{
"distinct_user_count": 0,
"message_count": 0,
"project_id": "project_id",
"project_name": "project_name",
"created_at": "2019-12-27T18:11:19.117Z",
"created_by": {
"id": "id",
"email_address": "email_address",
"type": "user"
},
"distinct_conversation_count": 0,
"product": "product",
"rbac_group_id": "rbac_group_id",
"rbac_group_name": "rbac_group_name",
"user_id": "user_id"
}
],
"next_page": "next_page"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"distinct_user_count": 0,
"message_count": 0,
"project_id": "project_id",
"project_name": "project_name",
"created_at": "2019-12-27T18:11:19.117Z",
"created_by": {
"id": "id",
"email_address": "email_address",
"type": "user"
},
"distinct_conversation_count": 0,
"product": "product",
"rbac_group_id": "rbac_group_id",
"rbac_group_name": "rbac_group_name",
---
## Projects - Claude API Reference
Source: https://platform.claude.com/docs/en/api/http/beta/organization/analytics/apps/chat/projects
Path: 04-API-Reference/Admin/http-beta-organization-analytics-apps-chat-projects.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fhttp%2Fbeta%2Forganization%2Fanalytics%2Fapps%2Fchat%2Fprojects)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Summaries
Users
Apps
Chat
Projects
Get Chat Project Usage
Connectors
Plugins
Skills
Artifacts
Usage Report
User Usage Report
Cost Report
User Cost Report
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Analytics](platform-claude-com-http-beta-organization-analytics.md)
5. [Apps](https://platform.claude.com/docs/en/api/http/beta/organization/analytics/apps)
6. [Chat](https://platform.claude.com/docs/en/api/http/beta/organization/analytics/apps/chat)
# Projects
##### [Get Chat Project Usage](http-beta-organization-analytics-apps-chat-projects-list.md)
GET/v1/organizations/analytics/apps/chat/projects
Get per-project activity for a given day, with cursor-based pagination.
---
## Get Artifact Activity - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/analytics/artifacts/list
Path: 04-API-Reference/Admin/http-beta-organization-analytics-artifacts-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fanalytics%2Fartifacts%2Flist)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Summaries
Users
Apps
Connectors
Plugins
Skills
Artifacts
Get Artifact Activity
Usage Report
User Usage Report
Cost Report
User Cost Report
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Analytics](platform-claude-com-http-beta-organization-analytics.md)
5. [Artifacts](http-beta-organization-analytics-artifacts.md)
# Get Artifact Activity
Copy page
cURL
GET/v1/organizations/analytics/artifacts
Get artifact-creation activity for a given day, broken out by MIME type.
Returns the full (`artifact_type`, `is_shared`) cube for the organization; `next_page` is null except for grouped queries, which paginate. The cube can be broken out per product, per member, or per RBAC group via `group_by[]`, and scoped via `filter[]`. Requires an API key with the `read:analytics` scope.
##### Query parameters
date: string
UTC date in YYYY-MM-DD format. The day to get artifact activity for. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day) and may be revised by a few percent over the following days. No earlier than 2026-01-01.
formatdate
filter: optional array of string
Filters as `dimension:value`, e.g. `filter[]=rbac_group_id:{id}`. Repeat the param for OR within a dimension and across dimensions for AND. Supported dimensions on this endpoint: `artifact_type`, `is_shared`, `product`, `rbac_group_id`, `user_id`. Value forms: `artifact_type` is a canonical artifact MIME type (e.g. `text/markdown`) or `other`; `is_shared` is `true` or `false`; `product` is `chat_cowork_unified`, `chat`, `claude_code`, or `cowork` (the surfaces that create artifacts); `rbac_group_id` takes the tagged id (`rbac_group_...`, as emitted in responses and by the spend-limits API) or a bare group UUID, and matches users who held the group at any point during each covered UTC day (time-of-usage attribution); `user_id` takes a tagged user id (`user_...`), as emitted in responses. An unsupported dimension returns 400. At most 100 entries. `chat_cowork_unified` is accepted as a `product` value only on deployments that offer Chat and Cowork unified.
maxItems100
group_by: optional array of "product" or "rbac_group_id" or "user_id"
Dimensions to break results out by: `product`, `user_id` and/or `rbac_group_id`. The ungrouped artifact-type cube is finite and returned in full; grouped queries multiply the cube and paginate via `next_page`. `product` takes the values `chat_cowork_unified`, `chat`, `claude_code`, or `cowork` (the surfaces that create artifacts). `rbac_group_id` attributes a user to every group they held at any point during the requested UTC day, so grouped rows are not an exclusive partition. At most 100 entries.
maxItems100
One of the following:
"product"
"rbac_group_id"
"user_id"
limit: optional number
Maximum rows to return (1-1000, default 100). The ungrouped artifact-type cube is finite and returned in full; `limit` is the page size only when `group_by[]` multiplies the cube.
minimum1
maximum1000
page: optional string
Opaque cursor from a previous response's `next_page` field. Only valid with `group_by[]` — the ungrouped cube is never paginated.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
##### Returns
data: array of [BetaAnalyticsArtifactActivity](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_artifact_activity) { artifact_type, artifacts_created_count, distinct_user_count, 6 more }
artifact_type: string
Canonical artifact MIME type (e.g. `text/markdown`, `application/vnd.ant.react`, `image/svg+xml`), or `other`. Claude Code and Cowork artifacts report as `text/html`.
artifacts_created_count: number
Number of artifacts created in this bucket on the requested day
distinct_user_count: number
Number of distinct users who created artifacts in this bucket on the requested day
is_shared: boolean
Whether the artifacts in this bucket have ever been shared (a Claude Code / Cowork artifact is shared once anyone beyond its creator may open it: named members, the whole organization, or anyone with the link).
published_artifacts_created_count: number
Number of those artifacts that have been published (for Claude Code / Cowork artifacts: open to anyone with the link); never exceeds `artifacts_created_count`
product: optional string or null
Product that produced this row's activity: one of `chat`, `claude_code`, `cowork`, `office_agent`, or `chat_cowork_unified` (Chat and Cowork unified). These are the canonical Cost & Usage product names; an `office_agent` row's per-surface breakdown is in its `office_metrics`. On `/plugins` only `cowork`, `claude_code` and `chat_cowork_unified` occur (the only surfaces with plugin attribution); on `/artifacts` only `chat`, `claude_code`, `cowork` and `chat_cowork_unified` occur (the surfaces that create artifacts); `/apps/chat/projects` does not support the product dimension (a `product` entry in `group_by[]` or `filter[]` there is rejected). Present only when the request grouped by `product`.
rbac_group_id: optional string or null
Tagged RBAC group identifier (`rbac_group_...`), matching the spend-limits API spelling. Present only when the request grouped by `rbac_group_id`.
rbac_group_name: optional string or null
Resolved RBAC group display name, alongside `rbac_group_id` when name resolution is available. Null if the group has been deleted or its name could not be resolved; `rbac_group_id` remains the stable key.
user_id: optional string or null
Tagged user identifier (e.g. `user_...`). Present only when the request grouped by `user_id`.
next_page: string or null
Cursor for the next page of a grouped query; always null for the ungrouped artifact-type cube, which is returned in full.
Get Artifact Activity
cURL
```python
curl https://api.anthropic.com/v1/organizations/analytics/artifacts \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"data": [
{
"artifact_type": "artifact_type",
"artifacts_created_count": 0,
"distinct_user_count": 0,
"is_shared": true,
"published_artifacts_created_count": 0,
"product": "product",
"rbac_group_id": "rbac_group_id",
"rbac_group_name": "rbac_group_name",
"user_id": "user_id"
}
],
"next_page": "next_page"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"artifact_type": "artifact_type",
"artifacts_created_count": 0,
"distinct_user_count": 0,
"is_shared": true,
"published_artifacts_created_count": 0,
"product": "product",
"rbac_group_id": "rbac_group_id",
"rbac_group_name": "rbac_group_name",
---
## Artifacts - Claude API Reference
Source: https://platform.claude.com/docs/en/api/http/beta/organization/analytics/artifacts
Path: 04-API-Reference/Admin/http-beta-organization-analytics-artifacts.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fhttp%2Fbeta%2Forganization%2Fanalytics%2Fartifacts)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Summaries
Users
Apps
Connectors
Plugins
Skills
Artifacts
Get Artifact Activity
Usage Report
User Usage Report
Cost Report
User Cost Report
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Analytics](platform-claude-com-http-beta-organization-analytics.md)
# Artifacts
##### [Get Artifact Activity](platform-claude-com-http-beta-organization-analytics-artifacts-list.md)
GET/v1/organizations/analytics/artifacts
Get artifact-creation activity for a given day, broken out by MIME type.
---
## Get Chat Project Usage - Claude API Reference
Source: https://platform.claude.com/docs/en/api/http/beta/organization/analytics/chat_projects/list
Path: 04-API-Reference/Admin/http-beta-organization-analytics-chat-projects-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fhttp%2Fbeta%2Forganization%2Fanalytics%2Fchat_projects%2Flist)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Get Activity Summaries
Usage
Cost
Users
Skills
Connectors
Chat Projects
Get Chat Project Usage
Plugins
Artifacts
Spend Limits
RBAC Groups
RBAC Roles
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Analytics](platform-claude-com-http-beta-organization-analytics.md)
5. [Chat Projects](http-beta-organization-analytics-chat-projects.md)
# Get Chat Project Usage
GET/v1/organizations/analytics/apps/chat/projects
Get per-project activity for a given day, with cursor-based pagination.
Returns activity metrics for each project in the organization, sorted by project ID. Use `group_by[]` to break projects out per member or per RBAC group, and `filter[]` to scope results; the parameter descriptions list the supported dimensions. Available to organizations on a Claude Enterprise plan. Requires an API key with the `read:analytics` scope.
##### Query parameters
date: optional string
UTC date in YYYY-MM-DD format. The day to get project activity for. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day) and may be revised by a few percent over the following days. No earlier than 2026-01-01.
formatdate
ending_date: optional string
UTC date in YYYY-MM-DD format. End of the date range (exclusive); only valid with `starting_date`. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day), so this can be at most today — which is also the default when omitted, resolved once when the first page is served and reused for the rest of the pagination sequence. At most 366 days after `starting_date`.
formatdate
filter: optional array of string
Filters as `dimension:value`, e.g. `filter[]=rbac_group_id:{id}`. Repeat the param for OR within a dimension and across dimensions for AND. Supported dimensions on this endpoint: `project_id`, `rbac_group_id`, `user_id`. Value forms: `project_id` takes a tagged project id (`claude_proj_...`); `rbac_group_id` takes the tagged id (`rbac_group_...`, as emitted in responses and by the spend-limits API) or a bare group UUID, and matches users who held the group at any point during each covered UTC day (time-of-usage attribution); `user_id` takes a tagged user id (`user_...`), as emitted in responses. An unsupported dimension returns 400. At most 100 entries.
maxItems100
group_by: optional array of "rbac_group_id" or "user_id"
Dimensions to break results out by (e.g. `group_by[]=user_id`). Supported on this endpoint: `rbac_group_id`, `user_id`. Grouped rows carry the requested dimension values as additional fields and paginate like ungrouped responses via `next_page`; an unsupported dimension returns 400. `rbac_group_id` attributes a user to every group they held at any point during each covered UTC day, so grouped rows are not an exclusive partition and can sum above org-level totals. At most 100 entries.
maxItems100
One of the following:
"rbac_group_id"
"user_id"
limit: optional number
Number of results per page (1-1000, default 100).
minimum1
maximum1000
order: optional "asc" or "desc"
Sort direction: `asc` or `desc`. Defaults to `asc` for the endpoint's sort column and to `desc` when `order_by` names a metric (a top-N ranking). Applies to `order_by`, or to the endpoint's default sort field when `order_by` is omitted.
One of the following:
"asc"
"desc"
order_by: optional string
Sort field. Restricted to the endpoint's sort column plus its rankable metrics (metrics default to descending; a few metrics rank in date-range mode only, per the endpoint's documented orderable set).
page: optional string
Opaque cursor from a previous response's `next_page` field.
starting_date: optional string
UTC date in YYYY-MM-DD format. Start of a date range (inclusive). Enables rollup mode: one row per entity aggregated over the whole range — addable counters are summed across days, and a distinct count is never summed where summing could double-count (a field's range value is recomputed exactly over the window, approximate via HLL with typical error under 2%, null, or — for the creation-event counts, whose per-day values cannot overlap — a per-day sum that is itself exact; each field's own description says which). Use either `date` or `starting_date`, not both. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day) and may be revised by a few percent over the following days. No earlier than 2026-01-01.
formatdate
##### Returns
BetaChatProjectUsage object{ data, next_page }
Response for GET /v1/organizations/analytics/apps/chat/projects.
Get Chat Project Usage
cURL
```python
curl https://api.anthropic.com/v1/organizations/analytics/apps/chat/projects \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"data": [
{
"distinct_user_count": 0,
"message_count": 0,
"project_id": "project_id",
"project_name": "project_name",
"created_at": "2019-12-27T18:11:19.117Z",
"created_by": {
"id": "id",
"email_address": "email_address",
"type": "user"
},
"distinct_conversation_count": 0,
"product": "product",
"rbac_group_id": "rbac_group_id",
"rbac_group_name": "rbac_group_name",
"user_id": "user_id"
}
],
"next_page": "next_page"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"distinct_user_count": 0,
"message_count": 0,
"project_id": "project_id",
"project_name": "project_name",
"created_at": "2019-12-27T18:11:19.117Z",
"created_by": {
"id": "id",
"email_address": "email_address",
"type": "user"
},
"distinct_conversation_count": 0,
"product": "product",
"rbac_group_id": "rbac_group_id",
"rbac_group_name": "rbac_group_name",
---
## Chat Projects - Claude API Reference
Source: https://platform.claude.com/docs/en/api/http/beta/organization/analytics/chat_projects
Path: 04-API-Reference/Admin/http-beta-organization-analytics-chat-projects.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fhttp%2Fbeta%2Forganization%2Fanalytics%2Fchat_projects)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Get Activity Summaries
Usage
Cost
Users
Skills
Connectors
Chat Projects
Get Chat Project Usage
Plugins
Artifacts
Spend Limits
RBAC Groups
RBAC Roles
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Analytics](platform-claude-com-http-beta-organization-analytics.md)
# Chat Projects
##### [Get Chat Project Usage](http-beta-organization-analytics-chat-projects-list.md)
GET/v1/organizations/analytics/apps/chat/projects
Get per-project activity for a given day, with cursor-based pagination.
##### Models
BetaChatProjectUsage object{ data, next_page }
Response for GET /v1/organizations/analytics/apps/chat/projects.
---
## Get Connector Usage - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/analytics/connectors/list
Path: 04-API-Reference/Admin/http-beta-organization-analytics-connectors-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fanalytics%2Fconnectors%2Flist)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Summaries
Users
Apps
Connectors
Get Connector Usage
Plugins
Skills
Artifacts
Usage Report
User Usage Report
Cost Report
User Cost Report
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Analytics](platform-claude-com-http-beta-organization-analytics.md)
5. [Connectors](http-beta-organization-analytics-connectors.md)
# Get Connector Usage
Copy page
cURL
GET/v1/organizations/analytics/connectors
Get per-connector usage for a given day, with cursor-based pagination.
Returns connector usage metrics for the organization, sorted by connector name. Connector names are normalized from their various sources — for example, "Atlassian MCP server" and "mcp-atlassian" both appear as "atlassian". Use `group_by[]` to break usage out per member, per RBAC group, or per product surface, and `filter[]` to scope results; the parameter descriptions list the supported dimensions. Available to organizations on a Claude Enterprise plan. Requires an API key with the `read:analytics` scope.
##### Query parameters
date: optional string
UTC date in YYYY-MM-DD format. The day to get connector usage for. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day) and may be revised by a few percent over the following days. No earlier than 2026-01-01.
formatdate
ending_date: optional string
UTC date in YYYY-MM-DD format. End of the date range (exclusive); only valid with `starting_date`. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day), so this can be at most today — which is also the default when omitted, resolved once when the first page is served and reused for the rest of the pagination sequence. At most 366 days after `starting_date`.
formatdate
filter: optional array of string
Filters as `dimension:value`, e.g. `filter[]=rbac_group_id:{id}`. Repeat the param for OR within a dimension and across dimensions for AND. Supported dimensions on this endpoint: `connector_name`, `product`, `rbac_group_id`, `user_id`. Value forms: `connector_name` matches case-insensitively, a display name such as 'GitHub MCP' also matches its normalized stored form ('github'), and for rows whose `connector_name` is an opaque connector id the connector's display name (`connector_display_name`) also matches; `product` is one of `chat_cowork_unified`, `chat`, `claude_code`, `cowork`, or `office_agent`; `rbac_group_id` takes the tagged id (`rbac_group_...`, as emitted in responses and by the spend-limits API) or a bare group UUID, and matches users who held the group at any point during each covered UTC day (time-of-usage attribution); `user_id` takes a tagged user id (`user_...`), as emitted in responses. An unsupported dimension returns 400. At most 100 entries. `chat_cowork_unified` is accepted as a `product` value only on deployments that offer Chat and Cowork unified.
maxItems100
group_by: optional array of "product" or "rbac_group_id" or "user_id"
Dimensions to break results out by (e.g. `group_by[]=user_id`). Supported on this endpoint: `product`, `rbac_group_id`, `user_id`. Grouped rows carry the requested dimension values as additional fields and paginate like ungrouped responses via `next_page`; an unsupported dimension returns 400. `rbac_group_id` attributes a user to every group they held at any point during each covered UTC day, so grouped rows are not an exclusive partition and can sum above org-level totals. At most 100 entries.
maxItems100
One of the following:
"product"
"rbac_group_id"
"user_id"
limit: optional number
Number of results per page (1-1000, default 100).
minimum1
maximum1000
order: optional "asc" or "desc"
Sort direction: `asc` or `desc`. Defaults to `asc` for the endpoint's sort column and to `desc` when `order_by` names a metric (a top-N ranking). Applies to `order_by`, or to the endpoint's default sort field when `order_by` is omitted.
One of the following:
"asc"
"desc"
order_by: optional string
Sort field. Restricted to the endpoint's sort column plus its rankable metrics (metrics default to descending; a few metrics rank in date-range mode only, per the endpoint's documented orderable set).
page: optional string
Opaque cursor from a previous response's `next_page` field.
starting_date: optional string
UTC date in YYYY-MM-DD format. Start of a date range (inclusive). Enables rollup mode: one row per entity aggregated over the whole range — addable counters are summed across days, and a distinct count is never summed where summing could double-count (a field's range value is recomputed exactly over the window, approximate via HLL with typical error under 2%, null, or — for the creation-event counts, whose per-day values cannot overlap — a per-day sum that is itself exact; each field's own description says which). Use either `date` or `starting_date`, not both. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day) and may be revised by a few percent over the following days. No earlier than 2026-01-01.
formatdate
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
##### Returns
data: array of [BetaAnalyticsConnectorActivity](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_connector_activity) { chat_metrics, claude_code_metrics, connector_name, 14 more }
chat_metrics: [BetaAnalyticsConnectorChatMetrics](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_connector_chat_metrics) { distinct_conversation_connector_used_count }
Claude.ai activity metrics for a single connector on a given day.
distinct_conversation_connector_used_count: number or null
Number of distinct conversations in which the connector was used. Approximate (HLL, typical error \<2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.
claude_code_metrics: [BetaAnalyticsConnectorClaudeCodeMetrics](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_connector_claude_code_metrics) { distinct_session_connector_used_count }
Claude Code activity metrics for a single connector on a given day.
distinct_session_connector_used_count: number or null
Number of distinct Claude Code sessions in which the connector was used. Approximate (HLL, typical error \<2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.
connector_name: string
Name of the connector. Some rows carry an opaque connector id here instead of a readable name; `connector_display_name` holds the resolved name for those rows.
cowork_metrics: [BetaAnalyticsConnectorCoworkMetrics](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_connector_cowork_metrics) { distinct_session_connector_used_count }
Cowork activity metrics for a single connector on a given day.
distinct_session_connector_used_count: number or null
Number of distinct Cowork sessions in which the connector was used. Approximate (HLL, typical error \<2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.
distinct_user_count: number
Number of distinct users who used the connector on the requested day, or, in date-range mode, over the requested window — recomputed as an exact distinct count over the window's per-member daily rows, never a sum of per-day values.
office_metrics: [BetaAnalyticsConnectorOfficeMetrics](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_connector_office_metrics) { excel, outlook, powerpoint, word }
Office Agent activity metrics for a single connector on a given day, broken out by Office product.
chat_cowork_unified_metrics: optional object{ chat, sessions } or null
Connector use recorded while members had Chat and Cowork unified (Cowork's features inside claude.ai chat) turned on, split into chat conversations and Cowork sessions. A count is null in date-range mode where it cannot be computed. Omitted from the response on deployments that do not offer Chat and Cowork unified.
chat: [BetaAnalyticsConnectorChatCoworkUnifiedChatMetrics](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_connector_chat_cowork_unified_chat_metrics) { distinct_conversation_connector_used_count }
A connector's use in chat conversations recorded while members had Chat and Cowork unified turned on.
distinct_conversation_connector_used_count: number or null
Same measure as `chat_metrics.distinct_conversation_connector_used_count`, for activity recorded while members had Chat and Cowork unified turned on. Approximate (HLL, typical error \<2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.
sessions: [BetaAnalyticsConnectorChatCoworkUnifiedSessionsMetrics](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_connector_chat_cowork_unified_sessions_metrics) { distinct_session_connector_used_count }
A connector's use in Cowork sessions recorded while members had Chat and Cowork unified turned on.
distinct_session_connector_used_count: number or null
Same measure as `cowork_metrics.distinct_session_connector_used_count`, for activity recorded while members had Chat and Cowork unified turned on. Approximate (HLL, typical error \<2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.
connector_display_name: optional string or null
Human-readable display name for rows whose `connector_name` is an opaque connector id rather than a readable name, resolved at request time from the organization's connectors (including connectors that have since been removed). `connector_name` remains the row's stable key for sorting and pagination, and `filter[]=connector_name:{value}` also matches these rows by display name. Display names are not unique, and the same connector's claude.ai usage can appear under a separate row with a readable `connector_name`. Null when `connector_name` is already a readable name, when the id cannot be resolved to one of the organization's connectors, or when display-name resolution is not enabled for this organization.
individual_auth_distinct_user_count: optional number or null
Number of distinct users whose use of this connector on the requested day ran on their own individual credential, connected through their own consent flow. Companion bucket to `managed_auth_distinct_user_count`, which carries the measurement, attribution, and null rules. Users whose requests used no stored credential count in neither bucket.
managed_auth_distinct_user_count: optional number or null
Number of distinct users whose use of this connector on the requested day ran on Enterprise Managed Auth (an organization-managed credential provisioned through the organization's identity provider), read from the token record each request used. Null, never 0, when managed-auth reporting is not enabled for the organization, the value cannot be attributed to the row, no credentialed requests and no managed-token mint events (a managed credential being provisioned for a user's use of the connector) were observed that day, or the day predates 2026-07-01, the first day the backing data exists (forward-only data, no backfill). When credentialed requests or mint events were observed and attributed, both managed-auth fields populate, reporting 0 for a bucket with no users; the two counts are independent, not a partition — a user whose requests that day used both kinds of credential counts in both. Mint events carry user but not surface attribution, so they count as observed auth activity on `user_id` and `rbac_group_id` cuts — attributed to the user the credential was provisioned for — but never on a cut that references `product` (group or filter). Date-range rollup mode (`starting_date`/`ending_date`) computes both fields exactly over the window — distinct users with at least one qualifying day — when the whole window starts on or after 2026-07-01, with the null-versus-0 and mint-event rules applying with the window in place of the day; a range starting earlier reports every managed-auth field as null, never a partial-window value.
product: optional string or null
Product that produced this row's activity: one of `chat`, `claude_code`, `cowork`, `office_agent`, or `chat_cowork_unified` (Chat and Cowork unified). These are the canonical Cost & Usage product names; an `office_agent` row's per-surface breakdown is in its `office_metrics`. On `/plugins` only `cowork`, `claude_code` and `chat_cowork_unified` occur (the only surfaces with plugin attribution); on `/artifacts` only `chat`, `claude_code`, `cowork` and `chat_cowork_unified` occur (the surfaces that create artifacts); `/apps/chat/projects` does not support the product dimension (a `product` entry in `group_by[]` or `filter[]` there is rejected). Present only when the request grouped by `product`.
rbac_group_id: optional string or null
Tagged RBAC group identifier (`rbac_group_...`), matching the spend-limits API spelling. Present only when the request grouped by `rbac_group_id`.
rbac_group_name: optional string or null
Resolved RBAC group display name, alongside `rbac_group_id` when name resolution is available. Null if the group has been deleted or its name could not be resolved; `rbac_group_id` remains the stable key.
read_call_count: optional number or null
Number of connector tool calls on the requested day whose trusted read-only annotation marked them read-only. Call count, not distinct users. Every call recorded on a classified surface lands in exactly one of `read_call_count`, `write_call_count`, or `unclassified_call_count`, so the three sum to the day's classified calls. Classification is forward-only per surface: claude.ai from 2026-06-01, Claude Code from 2026-05-30, Claude in Office from 2026-05-29, Cowork from 2026-06-02 (Cowork clients predating annotation forwarding land in `unclassified_call_count`). Null, never 0, when the value cannot be stated: the read/write split is not enabled for this organization, or the day predates 2026-05-29. For a date-range total, sum the per-day values, but treat a window that extends before 2026-05-29 as null rather than summing only its covered days — date-range rollup mode (`starting_date`/`ending_date`) applies both rules server-side.
unclassified_call_count: optional number or null
Number of connector tool calls on the requested day with no trusted read-only annotation — the annotation is optional in the MCP spec and is discarded when connector access controls are active, so unclassified calls are common. This field shows how much of the day's classified activity the read/write split actually covers. Call count, not distinct users. One of the three call-classification buckets; see `read_call_count` for the per-surface data-start dates, null conditions, and date-range guidance.
user_id: optional string or null
Tagged user identifier (e.g. `user_...`). Present only when the request grouped by `user_id`.
write_call_count: optional number or null
Number of connector tool calls on the requested day whose trusted read-only annotation marked them not read-only. Call count, not distinct users. One of the three call-classification buckets; see `read_call_count` for the per-surface data-start dates, null conditions, and date-range guidance.
next_page: string or null
Opaque cursor for the next page, or null if no more results
Get Connector Usage
cURL
```python
curl https://api.anthropic.com/v1/organizations/analytics/connectors \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"data": [
{
"chat_metrics": {
"distinct_conversation_connector_used_count": 0
},
"claude_code_metrics": {
"distinct_session_connector_used_count": 0
},
"connector_name": "connector_name",
"cowork_metrics": {
"distinct_session_connector_used_count": 0
},
"distinct_user_count": 0,
"office_metrics": {
"excel": {
"distinct_session_connector_used_count": 0
},
"outlook": {
"distinct_session_connector_used_count": 0
},
"powerpoint": {
"distinct_session_connector_used_count": 0
},
"word": {
"distinct_session_connector_used_count": 0
}
},
"chat_cowork_unified_metrics": {
"chat": {
"distinct_conversation_connector_used_count": 0
},
"sessions": {
"distinct_session_connector_used_count": 0
}
},
"connector_display_name": "connector_display_name",
"individual_auth_distinct_user_count": 0,
"managed_auth_distinct_user_count": 0,
"product": "product",
"rbac_group_id": "rbac_group_id",
"rbac_group_name": "rbac_group_name",
"read_call_count": 0,
"unclassified_call_count": 0,
"user_id": "user_id",
"write_call_count": 0
}
],
"next_page": "next_page"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"chat_metrics": {
"distinct_conversation_connector_used_count": 0
},
"claude_code_metrics": {
"distinct_session_connector_used_count": 0
},
"connector_name": "connector_name",
"cowork_metrics": {
"distinct_session_connector_used_count": 0
},
"distinct_user_count": 0,
"office_metrics": {
"excel": {
"distinct_session_connector_used_count": 0
},
"outlook": {
"distinct_session_connector_used_count": 0
},
"powerpoint": {
"distinct_session_connector_used_count": 0
},
"word": {
"distinct_session_connector_used_count": 0
}
},
"chat_cowork_unified_metrics": {
"chat": {
"distinct_conversation_connector_used_count": 0
},
"sessions": {
"distinct_session_connector_used_count": 0
}
},
"connector_display_name": "connector_display_name",
"individual_auth_distinct_user_count": 0,
"managed_auth_distinct_user_count": 0,
"product": "product",
"rbac_group_id": "rbac_group_id",
"rbac_group_name": "rbac_group_name",
---
## Connectors - Claude API Reference
Source: https://platform.claude.com/docs/en/api/http/beta/organization/analytics/connectors
Path: 04-API-Reference/Admin/http-beta-organization-analytics-connectors.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fhttp%2Fbeta%2Forganization%2Fanalytics%2Fconnectors)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Summaries
Users
Apps
Connectors
Get Connector Usage
Plugins
Skills
Artifacts
Usage Report
User Usage Report
Cost Report
User Cost Report
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Analytics](platform-claude-com-http-beta-organization-analytics.md)
# Connectors
##### [Get Connector Usage](platform-claude-com-http-beta-organization-analytics-connectors-list.md)
GET/v1/organizations/analytics/connectors
Get per-connector usage for a given day, with cursor-based pagination.
---
## Get Cost Over Time - Claude API Reference
Source: https://platform.claude.com/docs/en/api/http/beta/organization/analytics/cost/list
Path: 04-API-Reference/Admin/http-beta-organization-analytics-cost-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fhttp%2Fbeta%2Forganization%2Fanalytics%2Fcost%2Flist)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Get Activity Summaries
Usage
Cost
Get Cost Over Time
Get Per-User Cost
Users
Skills
Connectors
Chat Projects
Plugins
Artifacts
Spend Limits
RBAC Groups
RBAC Roles
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Analytics](platform-claude-com-http-beta-organization-analytics.md)
5. [Cost](http-beta-organization-analytics-cost.md)
# Get Cost Over Time
GET/v1/organizations/analytics/cost_report
Get cost in USD over time across a date range.
Returns cost bucketed by minute, hour, or day, optionally broken down by product, model, context window, inference region, speed, cost type, or token type. Available to organizations on a Claude Enterprise plan. Requires an API key with the `read:analytics` scope.
##### Query parameters
starting_at: string
Start of range, inclusive. RFC 3339 tz-aware. Must be within the last 365 days and no earlier than 2026-01-01T00:00:00Z.
formatdate-time
bucket_width: optional "1d" or "1h" or "1m"
Time bucket granularity.
default1d
One of the following:
"1d"
"1h"
"1m"
claude_tag_categories: optional array of "dm" or "engaged" or "monitoring" or 2 more
Filter to Claude Tag (Claude in Slack) usage in specific spend categories. Usage with no category never matches. `dm` usage is reported under the user's product rather than `claude-tag`, so combining this filter with `products[]=claude-tag` excludes it. Use `group_by[]=claude_tag_category` to break out per-category values.
maxItems100
One of the following:
"dm"
"engaged"
"monitoring"
"proactive"
"scheduled"
claude_tag_user_ids: optional array of string
Filter to Claude Tag (Claude in Slack) usage attributed to specific Slack users, by Slack user ID (for example `U0123ABCDEF`), not claude.ai user ID. Usage that is not Claude Tag, and Claude Tag usage not attributed to a single user, never matches. Use `group_by[]=claude_tag_user_id` to break out per-user values.
maxItems100
context_windows: optional array of "0-200k" or "200k-1M"
Filter to specific context-window pricing tiers. Use `group_by[]=context_window` to break out per-tier values.
maxItems100
One of the following:
"0-200k"
"200k-1M"
ending_at: optional string
End of range, exclusive. When omitted, defaults to the earlier of now and `starting_at` + 31 days. The range may span at most 31 days.
formatdate-time
group_by: optional array of "claude_tag_category" or "claude_tag_user_id" or "context_window" or 8 more
Dimensions to break each time bucket out by. Defaults to no grouping (one total per bucket). Each bucket reports at most its top 100 groups; a group beyond that cap has no row in that bucket (there is no remainder row), so grouped buckets are not exhaustive when a dimension has more than 100 distinct values.
maxItems100
One of the following:
"claude_tag_category"
"claude_tag_user_id"
"context_window"
"cost_type"
"inference_geo"
"model"
"product"
"rbac_group_id"
"slack_channel_id"
"speed"
"token_type"
inference_geos: optional array of "global" or "not_available" or "us"
Filter to specific inference regions. `not_available` matches rows where the region is unset. Use `group_by[]=inference_geo` to break out per-region values.
maxItems100
One of the following:
"global"
"not_available"
"us"
limit: optional number
Maximum number of time buckets per page. Defaults and caps vary by `bucket_width` (`1d`: default 7, max 31; `1h`: default 24, max 168; `1m`: default 60, max 256).
minimum1
models: optional array of string
Models to include. Defaults to all models. Use `group_by[]=model` to break out per-model values.
maxItems100
page: optional string
Opaque cursor from a previous response's `next_page` field.
products: optional array of "chat" or "claude-tag" or "claude_code" or 4 more
Product surfaces to include. Defaults to all products. Use `group_by[]=product` to break out per-product values.
maxItems100
One of the following:
"chat"
"claude-tag"
"claude_code"
"claude_design"
"claude_in_chrome"
"cowork"
"office_agent"
rbac_group_ids: optional array of string
Filter to usage attributed to specific RBAC groups. Accepts tagged RBAC group IDs (`rbac_group_...`) or bare group UUIDs. A row matches when the user belonged to any of the listed groups on the (UTC) day the usage occurred; usage with no group attribution never matches.
maxItems100
slack_channel_ids: optional array of string
Filter to usage originating from specific Slack channels. Use `group_by[]=slack_channel_id` to break out per-channel values.
maxItems100
speeds: optional array of "fast" or "standard"
Filter to fast or standard inference mode. Use `group_by[]=speed` to break out per-mode values.
maxItems100
One of the following:
"fast"
"standard"
user_ids: optional array of string
Filter to specific users by tagged user ID.
maxItems100
##### Returns
BetaCostBucket object{ data, data_refreshed_at, has_more, 2 more }
Get Cost Over Time
cURL
```python
curl https://api.anthropic.com/v1/organizations/analytics/cost_report \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"data": [
{
"ending_at": "2019-12-27T18:11:19.117Z",
"results": [
{
"amount": "amount",
"claude_tag_category": "dm",
"claude_tag_user_id": "U0123ABCDEF",
"context_window": "0-200k",
"cost_type": "code_execution",
"currency": "USD",
"inference_geo": "global",
"list_amount": "list_amount",
"model": "claude-opus-5",
"product": "chat",
"rbac_group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"requests": 0,
"slack_channel_id": "C0123ABCDEF",
"speed": "fast",
"token_type": "cache_creation.ephemeral_1h_input_tokens"
}
],
"starting_at": "2019-12-27T18:11:19.117Z"
}
],
"data_refreshed_at": "2019-12-27T18:11:19.117Z",
"has_more": true,
"next_page": "next_page",
"organization_id": "org_013FP9SaFPBg7Kw7fetjn6cF"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"ending_at": "2019-12-27T18:11:19.117Z",
"results": [
{
"amount": "amount",
"claude_tag_category": "dm",
"claude_tag_user_id": "U0123ABCDEF",
"context_window": "0-200k",
"cost_type": "code_execution",
"currency": "USD",
"inference_geo": "global",
"list_amount": "list_amount",
"model": "claude-opus-5",
"product": "chat",
"rbac_group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"requests": 0,
"slack_channel_id": "C0123ABCDEF",
"speed": "fast",
"token_type": "cache_creation.ephemeral_1h_input_tokens"
}
],
"starting_at": "2019-12-27T18:11:19.117Z"
}
],
"data_refreshed_at": "2019-12-27T18:11:19.117Z",
"has_more": true,
"next_page": "next_page",
"organization_id": "org_013FP9SaFPBg7Kw7fetjn6cF"
---
## Get Cost Over Time - Claude API Reference
Source: https://platform.claude.com/docs/en/api/http/beta/organization/analytics/cost_report/list
Path: 04-API-Reference/Admin/http-beta-organization-analytics-cost-report-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fhttp%2Fbeta%2Forganization%2Fanalytics%2Fcost_report%2Flist)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Summaries
Users
Apps
Connectors
Plugins
Skills
Artifacts
Usage Report
User Usage Report
Cost Report
Get Cost Over Time
User Cost Report
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Analytics](platform-claude-com-http-beta-organization-analytics.md)
5. [Cost Report](http-beta-organization-analytics-cost-report.md)
# Get Cost Over Time
GET/v1/organizations/analytics/cost_report
Get cost in USD over time across a date range.
Returns cost bucketed by minute, hour, or day, optionally broken down by product, model, context window, inference region, speed, cost type, or token type. Available to organizations on a Claude Enterprise plan. Requires an API key with the `read:analytics` scope.
##### Query parameters
starting_at: string
Start of range, inclusive. RFC 3339 tz-aware. Must be within the last 365 days and no earlier than 2026-01-01T00:00:00Z.
formatdate-time
bucket_width: optional "1d" or "1h" or "1m"
Time bucket granularity.
default1d
One of the following:
"1d"
"1h"
"1m"
claude_tag_categories: optional array of [BetaAnalyticsClaudeTagCategory](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_claude_tag_category)
Filter to Claude Tag (Claude in Slack) usage in specific spend categories. Usage with no category never matches. `dm` usage is reported under the user's product rather than `claude-tag`, so combining this filter with `products[]=claude-tag` excludes it. Use `group_by[]=claude_tag_category` to break out per-category values.
maxItems100
One of the following:
"dm"
"engaged"
"monitoring"
"proactive"
"scheduled"
claude_tag_user_ids: optional array of string
Filter to Claude Tag (Claude in Slack) usage attributed to specific Slack users, by Slack user ID (for example `U0123ABCDEF`), not claude.ai user ID. Usage that is not Claude Tag, and Claude Tag usage not attributed to a single user, never matches. Use `group_by[]=claude_tag_user_id` to break out per-user values.
maxItems100
context_windows: optional array of [BetaAnalyticsContextWindow](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_context_window)
Filter to specific context-window pricing tiers. Use `group_by[]=context_window` to break out per-tier values.
maxItems100
One of the following:
"0-200k"
"200k-1M"
ending_at: optional string
End of range, exclusive. When omitted, defaults to the earlier of now and `starting_at` + 31 days. The range may span at most 31 days.
formatdate-time
group_by: optional array of "claude_tag_category" or "claude_tag_user_id" or "context_window" or 8 more
Dimensions to break each time bucket out by. Defaults to no grouping (one total per bucket). Each bucket reports at most its top 100 groups; a group beyond that cap has no row in that bucket (there is no remainder row), so grouped buckets are not exhaustive when a dimension has more than 100 distinct values.
maxItems100
One of the following:
"claude_tag_category"
"claude_tag_user_id"
"context_window"
"cost_type"
"inference_geo"
"model"
"product"
"rbac_group_id"
"slack_channel_id"
"speed"
"token_type"
inference_geos: optional array of [BetaAnalyticsInferenceGeoFilter](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_inference_geo_filter)
Filter to specific inference regions. `not_available` matches rows where the region is unset. Use `group_by[]=inference_geo` to break out per-region values.
maxItems100
One of the following:
"global"
"not_available"
"us"
limit: optional number
Maximum number of time buckets per page. Defaults and caps vary by `bucket_width` (`1d`: default 7, max 31; `1h`: default 24, max 168; `1m`: default 60, max 256).
minimum1
models: optional array of string
Models to include. Defaults to all models. Use `group_by[]=model` to break out per-model values.
maxItems100
page: optional string
Opaque cursor from a previous response's `next_page` field.
products: optional array of [BetaAnalyticsProductFilter](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_product_filter)
Product surfaces to include. Defaults to all products. Use `group_by[]=product` to break out per-product values.
maxItems100
One of the following:
"chat"
"claude-tag"
"claude_code"
"claude_design"
"claude_in_chrome"
"cowork"
"office_agent"
rbac_group_ids: optional array of string
Filter to usage attributed to specific RBAC groups. Accepts tagged RBAC group IDs (`rbac_group_...`) or bare group UUIDs. A row matches when the user belonged to any of the listed groups on the (UTC) day the usage occurred; usage with no group attribution never matches.
maxItems100
slack_channel_ids: optional array of string
Filter to usage originating from specific Slack channels. Use `group_by[]=slack_channel_id` to break out per-channel values.
maxItems100
speeds: optional array of "fast" or "standard"
Filter to fast or standard inference mode. Use `group_by[]=speed` to break out per-mode values.
maxItems100
One of the following:
"fast"
"standard"
user_ids: optional array of string
Filter to specific users by tagged user ID.
maxItems100
##### Returns
data: array of [BetaAnalyticsCostReportTimeBucket](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_cost_report_time_bucket) { ending_at, results, starting_at }
Time buckets for this page, oldest first: one per `bucket_width` interval, including intervals with no data (their `results` list is empty). A page holds at most `limit` buckets.
ending_at: string
End of the time bucket (exclusive) in RFC 3339 format.
formatdate-time
results: array of [BetaAnalyticsCostBucketedResult](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_cost_bucketed_result) { amount, claude_tag_category, claude_tag_user_id, 12 more }
Rows for this time bucket. Empty when the bucket has no data; otherwise a single combined row when `group_by[]` is omitted, or one row per group (subject to the per-bucket group cap described on the `group_by[]` parameter).
amount: string
Amount (post-discount, pre-credit) in fractional cents.
claude_tag_category: [BetaAnalyticsClaudeTagCategory](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_claude_tag_category) or null
Claude Tag (Claude in Slack) spend category: `engaged` (a person addressed Claude in a channel or thread), `proactive` (Claude responded without being addressed), `scheduled` (a scheduled routine ran), `monitoring` (Claude watching a channel it was asked to monitor), or `dm` (direct messages with Claude). Populated only when `claude_tag_category` is in `group_by[]`; null for usage that is not Claude Tag. Direct-message usage is billed to the individual user and is reported under that user's product, not under `claude-tag`. New categories may be added over time.
One of the following:
"dm"
"engaged"
"monitoring"
"proactive"
"scheduled"
claude_tag_user_id: string or null
Slack user ID (for example `U0123ABCDEF`) of the member the Claude Tag (Claude in Slack) usage is attributed to, not a claude.ai user ID. Populated only when `claude_tag_user_id` is in `group_by[]`; null for usage that is not Claude Tag and for Claude Tag usage that is not attributed to a single user (for example `monitoring`, and `proactive` usage Claude initiated), so per-user rows can sum to less than the Claude Tag total. Cannot be combined with `group_by[]=rbac_group_id` or the `rbac_group_ids[]` filter.
context_window: [BetaAnalyticsContextWindow](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_context_window) or null
Context-window pricing tier of the usage or cost. Null unless `context_window` is in `group_by[]`; it can also be null on grouped rows with no context-window tier, such as code execution.
One of the following:
"0-200k"
"200k-1M"
cost_type: [BetaAnalyticsCostType](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_cost_type) or null
Cost component when `group_by[]=cost_type`; null otherwise (amount is the combined total).
One of the following:
"code_execution"
"tokens"
"web_search"
currency: string
Currency code for the cost amount. Currently always `"USD"`.
defaultUSD
inference_geo: "global" or "us" or null
Inference region of the usage or cost. Null unless `inference_geo` is in `group_by[]`; it can also be null on grouped rows where the region is not set (the rows that `inference_geos[]=not_available` matches).
One of the following:
"global"
"us"
list_amount: string
List-price amount (pre-discount) in fractional cents.
model: string or null
Model that produced the usage or cost, as a model name in the form the `models[]` filter accepts (for example, `claude-opus-5`). Null unless `model` is in `group_by[]`; it can also be null on grouped rows whose usage or cost is not attributed to a specific model, such as code execution.
product: string or null
Product surface that produced the usage or cost. Null unless product is in `group_by[]`; it can also be null on grouped rows whose usage cannot be attributed to a known surface. Values include `chat`, `claude_code`, `cowork`, `office_agent`, `claude_in_chrome`, `claude_design`, and `claude-tag`. `claude-tag` is Claude Tag, the Claude product in Slack. Some unattributed usage is reported as "other".
rbac_group_id: string or null
RBAC group (team) the usage is attributed to, in the public tagged `rbac_group_...` spelling — the same spelling the activity resources use for this key, so the same team has one id across resources and it round-trips as an `rbac_group_ids[]` filter value. Populated only when `rbac_group_id` is in `group_by[]`. Any-membership semantics: a user in several groups contributes their full usage to each of those groups' rows, so the named-group rows overlap and their sum can exceed the org total. A null value is the single unassigned row: users in no group on that (UTC) day. For the true org total, run the same query without `group_by[]`.
requests: number or null
Number of API requests in this row's scope. Null when `group_by` includes `cost_type` or `token_type` (the count has no per-component attribution; read it from the ungrouped response). For sandbox / code-execution events, this counts execution spans rather than HTTP requests (these rows surface with `product: null`).
slack_channel_id: string or null
Slack channel the usage originated from. Populated only when `slack_channel_id` is in `group_by[]`; null for usage outside Slack (and for rows recorded before channel attribution was enabled).
speed: "fast" or "standard" or null
Inference speed mode of the usage or cost: `fast` or `standard`. Null unless `speed` is in `group_by[]`.
One of the following:
"fast"
"standard"
token_type: [BetaAnalyticsTokenType](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_token_type) or null
Token type when `group_by[]=token_type` and `cost_type=tokens`; null otherwise.
One of the following:
"cache_creation.ephemeral_1h_input_tokens"
"cache_creation.ephemeral_5m_input_tokens"
"cache_read_input_tokens"
"output_tokens"
"uncached_input_tokens"
starting_at: string
Start of the time bucket (inclusive) in RFC 3339 format.
formatdate-time
data_refreshed_at: string or null
RFC 3339 timestamp of the export this response was served from. Null when no export yet covers any part of the requested range, in which case every bucket's `results` list is empty. Buckets beyond this watermark are incomplete; for stable results, set `ending_at` to this value or earlier. Data is typically refreshed every 4 hours but not final until about 30 days after the usage date (late-arriving events, reconciliation adjustments).
formatdate-time
has_more: boolean
Whether another page is available. When true, pass `next_page` as the `page` parameter to fetch it.
next_page: string or null
Opaque cursor for the next page, or null when `has_more` is false. Pass it as the `page` parameter, keeping the other parameters unchanged. A cursor can expire after the underlying data refreshes; the request then returns HTTP 410 and pagination must restart from the first page.
organization_id: string
ID of the Organization.
Get Cost Over Time
cURL
```python
curl https://api.anthropic.com/v1/organizations/analytics/cost_report \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"data": [
{
"ending_at": "2019-12-27T18:11:19.117Z",
"results": [
{
"amount": "amount",
"claude_tag_category": "dm",
"claude_tag_user_id": "U0123ABCDEF",
"context_window": "0-200k",
"cost_type": "code_execution",
"currency": "USD",
"inference_geo": "global",
"list_amount": "list_amount",
"model": "claude-opus-5",
"product": "chat",
"rbac_group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"requests": 0,
"slack_channel_id": "C0123ABCDEF",
"speed": "fast",
"token_type": "cache_creation.ephemeral_1h_input_tokens"
}
],
"starting_at": "2019-12-27T18:11:19.117Z"
}
],
"data_refreshed_at": "2019-12-27T18:11:19.117Z",
"has_more": true,
"next_page": "next_page",
"organization_id": "org_013FP9SaFPBg7Kw7fetjn6cF"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"ending_at": "2019-12-27T18:11:19.117Z",
"results": [
{
"amount": "amount",
"claude_tag_category": "dm",
"claude_tag_user_id": "U0123ABCDEF",
"context_window": "0-200k",
"cost_type": "code_execution",
"currency": "USD",
"inference_geo": "global",
"list_amount": "list_amount",
"model": "claude-opus-5",
"product": "chat",
"rbac_group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"requests": 0,
"slack_channel_id": "C0123ABCDEF",
"speed": "fast",
"token_type": "cache_creation.ephemeral_1h_input_tokens"
}
],
"starting_at": "2019-12-27T18:11:19.117Z"
}
],
"data_refreshed_at": "2019-12-27T18:11:19.117Z",
"has_more": true,
"next_page": "next_page",
"organization_id": "org_013FP9SaFPBg7Kw7fetjn6cF"
---
## Cost Report - Claude API Reference
Source: https://platform.claude.com/docs/en/api/http/beta/organization/analytics/cost_report
Path: 04-API-Reference/Admin/http-beta-organization-analytics-cost-report.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fhttp%2Fbeta%2Forganization%2Fanalytics%2Fcost_report)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Summaries
Users
Apps
Connectors
Plugins
Skills
Artifacts
Usage Report
User Usage Report
Cost Report
Get Cost Over Time
User Cost Report
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Analytics](platform-claude-com-http-beta-organization-analytics.md)
# Cost Report
##### [Get Cost Over Time](http-beta-organization-analytics-cost-report-list.md)
GET/v1/organizations/analytics/cost_report
Get cost in USD over time across a date range.
---
## Cost - Claude API Reference
Source: https://platform.claude.com/docs/en/api/http/beta/organization/analytics/cost
Path: 04-API-Reference/Admin/http-beta-organization-analytics-cost.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fhttp%2Fbeta%2Forganization%2Fanalytics%2Fcost)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Get Activity Summaries
Usage
Cost
Get Cost Over Time
Get Per-User Cost
Users
Skills
Connectors
Chat Projects
Plugins
Artifacts
Spend Limits
RBAC Groups
RBAC Roles
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Analytics](platform-claude-com-http-beta-organization-analytics.md)
# Cost
##### [Get Cost Over Time](http-beta-organization-analytics-cost-list.md)
GET/v1/organizations/analytics/cost_report
Get cost in USD over time across a date range.
##### [Get Per-User Cost](beta-organization-analytics-cost-list-by-user.md)
GET/v1/organizations/analytics/user_cost_report
Get per-user cost in USD across a date range.
##### Models
BetaCostBucket object{ data, data_refreshed_at, has_more, 2 more }
BetaUserCost object{ data, data_refreshed_at, has_more, 2 more }
---
## Get Plugin Usage - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/analytics/plugins/list
Path: 04-API-Reference/Admin/http-beta-organization-analytics-plugins-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fanalytics%2Fplugins%2Flist)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Summaries
Users
Apps
Connectors
Plugins
Get Plugin Usage
Skills
Artifacts
Usage Report
User Usage Report
Cost Report
User Cost Report
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Analytics](platform-claude-com-http-beta-organization-analytics.md)
5. [Plugins](platform-claude-com-http-beta-organization-analytics-plugins.md)
# Get Plugin Usage
Copy page
cURL
GET/v1/organizations/analytics/plugins
Get per-plugin install + invocation usage for a given day, with pagination.
Returns plugin usage metrics for the organization across Cowork and Claude Code, sorted by plugin name. The `plugin_name` value `third-party` is an aggregate bucket, not a plugin: it collects plugin activity, from either surface, for which the reporting client did not provide a plugin name — so an organization's own plugins can contribute both to their own named rows and to this bucket. Use `group_by[]` to break usage out per member, per RBAC group, or per product surface (Cowork / Claude Code), and `filter[]` to scope results; the parameter descriptions list the supported dimensions. Requires an API key with the `read:analytics` scope. `starting_date` / `ending_date` select range-rollup mode like `/skills`.
##### Query parameters
date: optional string
UTC date in YYYY-MM-DD format. The day to get plugin usage for. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day) and may be revised by a few percent over the following days. No earlier than 2026-01-01.
formatdate
ending_date: optional string
UTC date in YYYY-MM-DD format. End of the date range (exclusive); only valid with `starting_date`. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day), so this can be at most today — which is also the default when omitted, resolved once when the first page is served and reused for the rest of the pagination sequence. At most 366 days after `starting_date`.
formatdate
filter: optional array of string
Filters as `dimension:value`, e.g. `filter[]=rbac_group_id:{id}`. Repeat the param for OR within a dimension and across dimensions for AND. Supported dimensions on this endpoint: `plugin_name`, `product`, `rbac_group_id`, `user_id`. Value forms: `plugin_name` matches case-insensitively; `product` is `chat_cowork_unified`, `claude_code`, or `cowork` (the only surfaces with plugin attribution); `rbac_group_id` takes the tagged id (`rbac_group_...`, as emitted in responses and by the spend-limits API) or a bare group UUID, and matches users who held the group at any point during each covered UTC day (time-of-usage attribution); `user_id` takes a tagged user id (`user_...`), as emitted in responses. An unsupported dimension returns 400. At most 100 entries. `chat_cowork_unified` is accepted as a `product` value only on deployments that offer Chat and Cowork unified.
maxItems100
group_by: optional array of "product" or "rbac_group_id" or "user_id"
Dimensions to break results out by (e.g. `group_by[]=user_id`). Supported on this endpoint: `product`, `rbac_group_id`, `user_id`. On this endpoint `product` takes the values `chat_cowork_unified`, `claude_code`, or `cowork` only (the surfaces with plugin attribution). Grouped rows carry the requested dimension values as additional fields and paginate like ungrouped responses via `next_page`; an unsupported dimension returns 400. `rbac_group_id` attributes a user to every group they held at any point during each covered UTC day, so grouped rows are not an exclusive partition and can sum above org-level totals. At most 100 entries.
maxItems100
One of the following:
"product"
"rbac_group_id"
"user_id"
limit: optional number
Number of results per page (1-1000, default 100).
minimum1
maximum1000
order: optional "asc" or "desc"
Sort direction: `asc` or `desc`. Defaults to `asc` for the endpoint's sort column and to `desc` when `order_by` names a metric (a top-N ranking). Applies to `order_by`, or to the endpoint's default sort field when `order_by` is omitted.
One of the following:
"asc"
"desc"
order_by: optional string
Sort field. Restricted to the endpoint's sort column plus its rankable metrics (metrics default to descending; a few metrics rank in date-range mode only, per the endpoint's documented orderable set).
page: optional string
Opaque cursor from a previous response's `next_page` field.
starting_date: optional string
UTC date in YYYY-MM-DD format. Start of a date range (inclusive). Enables rollup mode: one row per entity aggregated over the whole range — addable counters are summed across days, and a distinct count is never summed where summing could double-count (a field's range value is recomputed exactly over the window, approximate via HLL with typical error under 2%, null, or — for the creation-event counts, whose per-day values cannot overlap — a per-day sum that is itself exact; each field's own description says which). Use either `date` or `starting_date`, not both. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day) and may be revised by a few percent over the following days. No earlier than 2026-01-01.
formatdate
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
##### Returns
data: array of [BetaAnalyticsPluginActivity](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_plugin_activity) { claude_code_metrics, cowork_metrics, distinct_user_count, 9 more }
claude_code_metrics: [BetaAnalyticsPluginClaudeCodeMetrics](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_plugin_claude_code_metrics) { distinct_session_plugin_used_count }
Claude Code activity metrics for a single plugin on a given day.
distinct_session_plugin_used_count: number or null
Number of distinct Claude Code sessions in which the plugin was invoked. Null on aggregated rows where a distinct count cannot be computed.
cowork_metrics: [BetaAnalyticsPluginCoworkMetrics](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_plugin_cowork_metrics) { distinct_session_plugin_used_count }
Cowork activity metrics for a single plugin on a given day.
distinct_session_plugin_used_count: number or null
Number of distinct Cowork sessions in which the plugin was invoked. Null on aggregated rows where a distinct count cannot be computed.
distinct_user_count: number
Number of distinct users with recorded install or invocation activity for the plugin on the requested day (install-only users count), or, in date-range mode, over the requested window — recomputed as an exact distinct count over the window's per-member daily rows, never a sum of per-day values.
install_count: number or null
Number of distinct users who installed the plugin on the requested day, or, in date-range mode, over the requested window — recomputed as an exact distinct count over the window's per-member daily rows, never a sum of per-day values.
invocation_count: number
Number of plugin invocations on the requested day
plugin_name: string
Name of the plugin
chat_cowork_unified_metrics: optional object{ distinct_session_plugin_used_count } or null
Plugin use recorded while members had Chat and Cowork unified (Cowork's features inside claude.ai chat) turned on. A count is null in date-range mode where it cannot be computed. Omitted from the response on deployments that do not offer Chat and Cowork unified.
distinct_session_plugin_used_count: number or null
Same measure as `cowork_metrics.distinct_session_plugin_used_count`, for activity recorded while members had Chat and Cowork unified turned on. Null on aggregated rows where a distinct count cannot be computed.
plugin_id: optional string or null
Stable plugin identifier when available (e.g. `serena@claude-plugins-official`). Null for third-party Claude Code plugins (redacted at the source) and Cowork slash commands that carry only a hashed id.
product: optional string or null
Product that produced this row's activity: one of `chat`, `claude_code`, `cowork`, `office_agent`, or `chat_cowork_unified` (Chat and Cowork unified). These are the canonical Cost & Usage product names; an `office_agent` row's per-surface breakdown is in its `office_metrics`. On `/plugins` only `cowork`, `claude_code` and `chat_cowork_unified` occur (the only surfaces with plugin attribution); on `/artifacts` only `chat`, `claude_code`, `cowork` and `chat_cowork_unified` occur (the surfaces that create artifacts); `/apps/chat/projects` does not support the product dimension (a `product` entry in `group_by[]` or `filter[]` there is rejected). Present only when the request grouped by `product`.
rbac_group_id: optional string or null
Tagged RBAC group identifier (`rbac_group_...`), matching the spend-limits API spelling. Present only when the request grouped by `rbac_group_id`.
rbac_group_name: optional string or null
Resolved RBAC group display name, alongside `rbac_group_id` when name resolution is available. Null if the group has been deleted or its name could not be resolved; `rbac_group_id` remains the stable key.
user_id: optional string or null
Tagged user identifier (e.g. `user_...`). Present only when the request grouped by `user_id`.
next_page: string or null
Opaque cursor for the next page, or null if no more results
Get Plugin Usage
cURL
```python
curl https://api.anthropic.com/v1/organizations/analytics/plugins \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"data": [
{
"claude_code_metrics": {
"distinct_session_plugin_used_count": 0
},
"cowork_metrics": {
"distinct_session_plugin_used_count": 0
},
"distinct_user_count": 0,
"install_count": 0,
"invocation_count": 0,
"plugin_name": "plugin_name",
"chat_cowork_unified_metrics": {
"distinct_session_plugin_used_count": 0
},
"plugin_id": "plugin_id",
"product": "product",
"rbac_group_id": "rbac_group_id",
"rbac_group_name": "rbac_group_name",
"user_id": "user_id"
}
],
"next_page": "next_page"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"claude_code_metrics": {
"distinct_session_plugin_used_count": 0
},
"cowork_metrics": {
"distinct_session_plugin_used_count": 0
},
"distinct_user_count": 0,
"install_count": 0,
"invocation_count": 0,
"plugin_name": "plugin_name",
"chat_cowork_unified_metrics": {
"distinct_session_plugin_used_count": 0
},
"plugin_id": "plugin_id",
"product": "product",
"rbac_group_id": "rbac_group_id",
"rbac_group_name": "rbac_group_name",
---
## Plugins - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/analytics/plugins
Path: 04-API-Reference/Admin/http-beta-organization-analytics-plugins.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fanalytics%2Fplugins)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Summaries
Users
Apps
Connectors
Plugins
Get Plugin Usage
Skills
Artifacts
Usage Report
User Usage Report
Cost Report
User Cost Report
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Analytics](platform-claude-com-http-beta-organization-analytics.md)
# Plugins
Copy page
cURL
##### [Get Plugin Usage](platform-claude-com-http-beta-organization-analytics-plugins-list.md)
GET/v1/organizations/analytics/plugins
Get per-plugin install + invocation usage for a given day, with pagination.
---
## Get Activity Summaries - Claude API Reference
Source: https://platform.claude.com/docs/en/api/http/beta/organization/analytics/retrieve_summaries
Path: 04-API-Reference/Admin/http-beta-organization-analytics-retrieve-summaries.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fhttp%2Fbeta%2Forganization%2Fanalytics%2Fretrieve_summaries)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Get Activity Summaries
Usage
Cost
Users
Skills
Connectors
Chat Projects
Plugins
Artifacts
Spend Limits
RBAC Groups
RBAC Roles
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Analytics](platform-claude-com-http-beta-organization-analytics.md)
# Get Activity Summaries
GET/v1/organizations/analytics/summaries
Get organization-wide activity summaries for a date range.
Returns one entry per day from `starting_date` (inclusive) to `ending_date` (exclusive). Data is typically available with a 1-day lag and may be revised by a few percent over the following days: when `ending_date` is omitted it defaults to the most recent available day + 1, so the last entry covers the most recent available day. The series can be scoped to an RBAC group via `filter[]=rbac_group_id:{id}`. Available to organizations on a Claude Enterprise plan. Requires an API key with the `read:analytics` scope.
##### Query parameters
starting_date: string
UTC date in YYYY-MM-DD format. Start of the date range (inclusive). Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day) and may be revised by a few percent over the following days. No earlier than 2026-01-01.
formatdate
ending_date: optional string
UTC date in YYYY-MM-DD format. End of the date range (exclusive). Data is typically available with a 1-day lag, so this can be at most today — which is also the default when omitted, making the last entry cover the most recent available day. Data may be revised by a few percent over the following days. The range may span at most 366 days.
formatdate
filter: optional array of string
Filters as `dimension:value`. Only `rbac_group_id` is supported (e.g. `filter[]=rbac_group_id:{id}`); repeat the param to OR across groups. Scopes the whole day series to members of the matching group(s), re-aggregated from member-level activity — org-wide seat/invite fields and the adoption rates derived from them are null on scoped rows. `rbac_group_id` accepts the tagged id (`rbac_group_...`, as emitted in responses and by the spend-limits API) or a bare group UUID, and matches users who held the group at any point during each UTC day (time-of-usage attribution). At most 100 entries.
maxItems100
##### Returns
BetaActivitySummary object{ summaries }
Response for GET /v1/organizations/analytics/summaries.
Get Activity Summaries
cURL
```python
curl https://api.anthropic.com/v1/organizations/analytics/summaries \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"summaries": [
{
"assigned_seat_count": 0,
"cowork_daily_active_user_count": 0,
"cowork_monthly_active_user_count": 0,
"cowork_weekly_active_user_count": 0,
"daily_active_user_count": 0,
"daily_adoption_rate": 0,
"ending_at": "2019-12-27T18:11:19.117Z",
"monthly_active_user_count": 0,
"monthly_adoption_rate": 0,
"pending_invite_count": 0,
"starting_at": "2019-12-27T18:11:19.117Z",
"weekly_active_user_count": 0,
"weekly_adoption_rate": 0,
"chat_daily_active_user_count": 0,
"chat_monthly_active_user_count": 0,
"chat_weekly_active_user_count": 0,
"claude_code_daily_active_user_count": 0,
"claude_code_monthly_active_user_count": 0,
"claude_code_weekly_active_user_count": 0,
"claude_design_daily_active_user_count": 0,
"claude_design_monthly_active_user_count": 0,
"claude_design_weekly_active_user_count": 0,
"office_agent_daily_active_user_count": 0,
"office_agent_monthly_active_user_count": 0,
"office_agent_weekly_active_user_count": 0,
"science_daily_active_user_count": 0,
"science_entitled_user_count": 0,
"science_monthly_active_user_count": 0,
"science_weekly_active_user_count": 0
}
]
}
```
##### Returns Examples
Response 200
```python
{
"summaries": [
{
"assigned_seat_count": 0,
"cowork_daily_active_user_count": 0,
"cowork_monthly_active_user_count": 0,
"cowork_weekly_active_user_count": 0,
"daily_active_user_count": 0,
"daily_adoption_rate": 0,
"ending_at": "2019-12-27T18:11:19.117Z",
"monthly_active_user_count": 0,
"monthly_adoption_rate": 0,
"pending_invite_count": 0,
"starting_at": "2019-12-27T18:11:19.117Z",
"weekly_active_user_count": 0,
"weekly_adoption_rate": 0,
"chat_daily_active_user_count": 0,
"chat_monthly_active_user_count": 0,
"chat_weekly_active_user_count": 0,
"claude_code_daily_active_user_count": 0,
"claude_code_monthly_active_user_count": 0,
"claude_code_weekly_active_user_count": 0,
"claude_design_daily_active_user_count": 0,
"claude_design_monthly_active_user_count": 0,
"claude_design_weekly_active_user_count": 0,
"office_agent_daily_active_user_count": 0,
"office_agent_monthly_active_user_count": 0,
"office_agent_weekly_active_user_count": 0,
"science_daily_active_user_count": 0,
"science_entitled_user_count": 0,
"science_monthly_active_user_count": 0,
"science_weekly_active_user_count": 0
---
## Get Skill Usage - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/analytics/skills/list
Path: 04-API-Reference/Admin/http-beta-organization-analytics-skills-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fanalytics%2Fskills%2Flist)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Summaries
Users
Apps
Connectors
Plugins
Skills
Get Skill Usage
Artifacts
Usage Report
User Usage Report
Cost Report
User Cost Report
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Analytics](platform-claude-com-http-beta-organization-analytics.md)
5. [Skills](http-beta-organization-analytics-skills.md)
# Get Skill Usage
Copy page
cURL
GET/v1/organizations/analytics/skills
Get per-skill usage for a given day, with cursor-based pagination.
Returns skill usage metrics for the organization, sorted by skill name. Use `group_by[]` to break usage out per member, per RBAC group, or per product surface, and `filter[]` to scope results; the parameter descriptions list the supported dimensions. Available to organizations on a Claude Enterprise plan. Requires an API key with the `read:analytics` scope.
##### Query parameters
date: optional string
UTC date in YYYY-MM-DD format. The day to get skill usage for. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day) and may be revised by a few percent over the following days. No earlier than 2026-01-01.
formatdate
ending_date: optional string
UTC date in YYYY-MM-DD format. End of the date range (exclusive); only valid with `starting_date`. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day), so this can be at most today — which is also the default when omitted, resolved once when the first page is served and reused for the rest of the pagination sequence. At most 366 days after `starting_date`.
formatdate
filter: optional array of string
Filters as `dimension:value`, e.g. `filter[]=rbac_group_id:{id}`. Repeat the param for OR within a dimension and across dimensions for AND. Supported dimensions on this endpoint: `product`, `rbac_group_id`, `share_status`, `skill_name`, `user_id`. Value forms: `product` is one of `chat_cowork_unified`, `chat`, `claude_code`, `cowork`, or `office_agent`; `rbac_group_id` takes the tagged id (`rbac_group_...`, as emitted in responses and by the spend-limits API) or a bare group UUID, and matches users who held the group at any point during each covered UTC day (time-of-usage attribution); `share_status` is one of `organization`, `private`, or `public`; `skill_name` matches case-insensitively; `user_id` takes a tagged user id (`user_...`), as emitted in responses. An unsupported dimension returns 400. At most 100 entries. `chat_cowork_unified` is accepted as a `product` value only on deployments that offer Chat and Cowork unified.
maxItems100
group_by: optional array of "product" or "rbac_group_id" or "user_id"
Dimensions to break results out by (e.g. `group_by[]=user_id`). Supported on this endpoint: `product`, `rbac_group_id`, `user_id`. Grouped rows carry the requested dimension values as additional fields and paginate like ungrouped responses via `next_page`; an unsupported dimension returns 400. `rbac_group_id` attributes a user to every group they held at any point during each covered UTC day, so grouped rows are not an exclusive partition and can sum above org-level totals. At most 100 entries.
maxItems100
One of the following:
"product"
"rbac_group_id"
"user_id"
limit: optional number
Number of results per page (1-1000, default 100).
minimum1
maximum1000
order: optional "asc" or "desc"
Sort direction: `asc` or `desc`. Defaults to `asc` for the endpoint's sort column and to `desc` when `order_by` names a metric (a top-N ranking). Applies to `order_by`, or to the endpoint's default sort field when `order_by` is omitted.
One of the following:
"asc"
"desc"
order_by: optional string
Sort field. Restricted to the endpoint's sort column plus its rankable metrics (metrics default to descending; a few metrics rank in date-range mode only, per the endpoint's documented orderable set).
page: optional string
Opaque cursor from a previous response's `next_page` field.
starting_date: optional string
UTC date in YYYY-MM-DD format. Start of a date range (inclusive). Enables rollup mode: one row per entity aggregated over the whole range — addable counters are summed across days, and a distinct count is never summed where summing could double-count (a field's range value is recomputed exactly over the window, approximate via HLL with typical error under 2%, null, or — for the creation-event counts, whose per-day values cannot overlap — a per-day sum that is itself exact; each field's own description says which). Use either `date` or `starting_date`, not both. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day) and may be revised by a few percent over the following days. No earlier than 2026-01-01.
formatdate
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
##### Returns
data: array of [BetaAnalyticsSkillActivity](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_skill_activity) { chat_metrics, claude_code_metrics, cowork_metrics, 15 more }
chat_metrics: [BetaAnalyticsSkillChatMetrics](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_skill_chat_metrics) { distinct_conversation_skill_used_count }
Claude.ai activity metrics for a single skill on a given day.
distinct_conversation_skill_used_count: number or null
Number of distinct conversations in which the skill was used. A skill counts as used only when it is explicitly activated — the model (or the user, via the skill's slash command) invokes it, reading its instructions into context as part of that activation. Skills that are merely installed or listed as available, or whose content reaches the context without an activation (preloaded, hook-injected, or read as a plain file), are not counted. Approximate (HLL, typical error \<2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.
claude_code_metrics: [BetaAnalyticsSkillClaudeCodeMetrics](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_skill_claude_code_metrics) { distinct_session_skill_used_count }
Claude Code activity metrics for a single skill on a given day.
distinct_session_skill_used_count: number or null
Number of distinct Claude Code sessions in which the skill was used. A skill counts as used only when it is explicitly activated — the model (or the user, via the skill's slash command) invokes it, reading its instructions into context as part of that activation. Skills that are merely installed or listed as available, or whose content reaches the context without an activation (preloaded, hook-injected, or read as a plain file), are not counted. Approximate (HLL, typical error \<2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.
cowork_metrics: [BetaAnalyticsSkillCoworkMetrics](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_skill_cowork_metrics) { distinct_session_skill_used_count }
Cowork activity metrics for a single skill on a given day.
distinct_session_skill_used_count: number or null
Number of distinct Cowork sessions in which the skill was used. A skill counts as used only when it is explicitly activated — the model (or the user, via the skill's slash command) invokes it, reading its instructions into context as part of that activation. Skills that are merely installed or listed as available, or whose content reaches the context without an activation (preloaded, hook-injected, or read as a plain file), are not counted. Approximate (HLL, typical error \<2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.
distinct_user_count: number
Number of distinct users who used the skill on the requested day, or, in date-range mode, over the requested window — recomputed as an exact distinct count over the window's per-member daily rows, never a sum of per-day values. A skill counts as used only when it is explicitly activated — the model (or the user, via the skill's slash command) invokes it, reading its instructions into context as part of that activation. Skills that are merely installed or listed as available, or whose content reaches the context without an activation (preloaded, hook-injected, or read as a plain file), are not counted.
office_metrics: [BetaAnalyticsSkillOfficeMetrics](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_skill_office_metrics) { excel, outlook, powerpoint, word }
Office Agent activity metrics for a single skill on a given day, broken out by Office product.
skill_name: string
Name of the skill
attributed_list_price: optional string or null
List-price (rate-card) value of the member requests attributed to this skill, as a decimal string in the minor unit of `currency` (cents for USD), from Claude Code, Cowork, and Office Agent request-level attribution — the value of requests that involved the skill, not the skill's incremental cost. Unlike `estimated_overage_spend` this reflects usage value regardless of how it was funded — seat-covered usage counts — but it is undiscounted and does not tie to billed spend or the organization's spend reporting. claude.ai chat usage carries no request-level attribution and contributes nothing: the field is null on `chat` product rows and on `office_agent` product cuts dated before 2026-06-18 (the Office Agent attribution data-start), and on ungrouped rows it covers the Claude Code + Cowork + Office Agent share only (null when no attributable usage exists). Also null under the same conditions as `estimated_overage_spend` (spend reporting not enabled for this organization, `office_agent` product cuts before the 2026-06-18 data-start). "0" means attributable usage existed but none was attributed to this skill. Addable across days: date-range rollup mode returns the window's sum. On `group_by[]` and `filter[]` shapes both amounts can total below the ungrouped value for the same skill over the same date or range: spend attributed to a member–skill pair with no counted usage on that day is excluded from those cuts.
chat_cowork_unified_metrics: optional object{ chat, sessions } or null
Skill use recorded while members had Chat and Cowork unified (Cowork's features inside claude.ai chat) turned on, split into chat conversations and Cowork sessions. A count is null in date-range mode where it cannot be computed. Omitted from the response on deployments that do not offer Chat and Cowork unified.
chat: [BetaAnalyticsSkillChatCoworkUnifiedChatMetrics](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_skill_chat_cowork_unified_chat_metrics) { distinct_conversation_skill_used_count }
A skill's use in chat conversations recorded while members had Chat and Cowork unified turned on.
distinct_conversation_skill_used_count: number or null
Same measure as `chat_metrics.distinct_conversation_skill_used_count`, for activity recorded while members had Chat and Cowork unified turned on. Approximate (HLL, typical error \<2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.
sessions: [BetaAnalyticsSkillChatCoworkUnifiedSessionsMetrics](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_skill_chat_cowork_unified_sessions_metrics) { distinct_session_skill_used_count }
A skill's use in Cowork sessions recorded while members had Chat and Cowork unified turned on.
distinct_session_skill_used_count: number or null
Same measure as `cowork_metrics.distinct_session_skill_used_count`, for activity recorded while members had Chat and Cowork unified turned on. Approximate (HLL, typical error \<2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.
currency: optional string or null
Currency for this row's monetary fields (`estimated_overage_spend` and `attributed_list_price`), as an uppercase ISO-4217 code. Always "USD" when either amount is populated; null whenever both amounts are null.
enable_count: optional number or null
Distinct accounts that enabled this skill on the requested day (claude.ai only — the skill analog of plugin `install_count`). The count is org-wide: null when enable reporting is not enabled for this organization, or when the request scopes to `user_id` / `rbac_group_id` / `product` via `group_by[]` or `filter[]` (an org-wide count would be misleading on per-cut rows). A distinct count, not an event count: summing across days double-counts members who enable the skill on more than one day, so it is also null in date-range rollup mode (`starting_date`/`ending_date`).
estimated_overage_spend: optional string or null
Estimated overage spend attributed to this skill, as a decimal string in the minor unit of `currency` (cents for USD; "1250" is \$12.50, fractional cents possible) — an allocation of each member's daily post-discount, pre-credit metered overage spend (the same cost basis as the organization's spend reporting and the Cost & Usage API, so per-skill figures are directly comparable; spend with no skill attribution — including any member-day without skill invocations — is not represented, so skill rows sum to at most those totals) across the skills the member used. Overage only: usage covered by included seat allowances bills nothing and allocates \$0 here — see `attributed_list_price` for the funding-independent usage-value companion. Claude Code, Cowork, and Office Agent spend use request-level skill attribution; claude.ai chat spend is approximated proportionally to skill-invoking messages. An estimate, not a billing number — and the cost of the requests/messages that involved the skill, not the skill's incremental cost (the same request would still have cost something without the skill active). "0" means no overage spend was attributed; null when spend reporting is not enabled for this organization, on `office_agent` product cuts dated before 2026-06-18 (the Office Agent attribution data-start). Addable across days: date-range rollup mode (`starting_date`/`ending_date`) returns the window's sum. With `group_by[]=user_id` each row carries the user's own attributed spend. On `group_by[]` and `filter[]` shapes both amounts can total below the ungrouped value for the same skill over the same date or range: spend attributed to a member–skill pair with no counted usage on that day is excluded from those cuts.
invocation_count: optional number or null
Total number of times this skill was invoked on the requested day (the skill analog of plugin `invocation_count`). Unlike `distinct_user_count` — which answers '# of users' — this is the true '# of uses'. A skill counts as used only when it is explicitly activated — the model (or the user, via the skill's slash command) invokes it, reading its instructions into context as part of that activation. Skills that are merely installed or listed as available, or whose content reaches the context without an activation (preloaded, hook-injected, or read as a plain file), are not counted. Null when invocation reporting is not enabled for this organization. Sum across a date range for total uses in the window — date-range rollup mode (`starting_date`/`ending_date`) returns this sum directly.
product: optional string or null
Product that produced this row's activity: one of `chat`, `claude_code`, `cowork`, `office_agent`, or `chat_cowork_unified` (Chat and Cowork unified). These are the canonical Cost & Usage product names; an `office_agent` row's per-surface breakdown is in its `office_metrics`. On `/plugins` only `cowork`, `claude_code` and `chat_cowork_unified` occur (the only surfaces with plugin attribution); on `/artifacts` only `chat`, `claude_code`, `cowork` and `chat_cowork_unified` occur (the surfaces that create artifacts); `/apps/chat/projects` does not support the product dimension (a `product` entry in `group_by[]` or `filter[]` there is rejected). Present only when the request grouped by `product`.
rbac_group_id: optional string or null
Tagged RBAC group identifier (`rbac_group_...`), matching the spend-limits API spelling. Present only when the request grouped by `rbac_group_id`.
rbac_group_name: optional string or null
Resolved RBAC group display name, alongside `rbac_group_id` when name resolution is available. Null if the group has been deleted or its name could not be resolved; `rbac_group_id` remains the stable key.
share_status: optional "organization" or "private" or "public" or null
Skill share status (claude.ai only): one of `private`, `organization`, or `public`. Null for skills used only in Claude Code or Office (no per-skill share-status concept) and when share-status reporting is not yet available for the organization. Filterable via `filter[]=share_status:{value}`.
One of the following:
"organization"
"private"
"public"
skill_display_name: optional string or null
Human-readable display name for rows whose `skill_name` is an opaque skill id (user/organization skill types and plugin-delivered skills, whose user-defined names usage reports generally withhold). Organization-shared skills and skills delivered by the organization's own plugins (its plugin marketplaces and its library) resolve; plugin skill names are shown without their 'plugin:' prefix. The literal 'unknown' bucket row gets a fixed 'Unknown skill' label. For a member's own skill (private or personal-plugin) it is null, except when the skill's owner used it from Claude Code or Cowork in the requested period: then it shows the name that client reported at the time. Apart from that, the names of members' own skills are not disclosed to analytics-key holders. Also null for Anthropic-provided plugin skills (not resolved), for an organization skill or plugin whose name can no longer be found (for example, one since deleted), when `skill_name` is already a display name, or when display-name resolution is not enabled for this organization.
user_id: optional string or null
Tagged user identifier (e.g. `user_...`). Present only when the request grouped by `user_id`.
next_page: string or null
Opaque cursor for the next page, or null if no more results
Get Skill Usage
cURL
```python
curl https://api.anthropic.com/v1/organizations/analytics/skills \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"data": [
{
"chat_metrics": {
"distinct_conversation_skill_used_count": 0
},
"claude_code_metrics": {
"distinct_session_skill_used_count": 0
},
"cowork_metrics": {
"distinct_session_skill_used_count": 0
},
"distinct_user_count": 0,
"office_metrics": {
"excel": {
"distinct_session_skill_used_count": 0
},
"outlook": {
"distinct_session_skill_used_count": 0
},
"powerpoint": {
"distinct_session_skill_used_count": 0
},
"word": {
"distinct_session_skill_used_count": 0
}
},
"skill_name": "skill_name",
"attributed_list_price": "attributed_list_price",
"chat_cowork_unified_metrics": {
"chat": {
"distinct_conversation_skill_used_count": 0
},
"sessions": {
"distinct_session_skill_used_count": 0
}
},
"currency": "currency",
"enable_count": 0,
"estimated_overage_spend": "estimated_overage_spend",
"invocation_count": 0,
"product": "product",
"rbac_group_id": "rbac_group_id",
"rbac_group_name": "rbac_group_name",
"share_status": "organization",
"skill_display_name": "skill_display_name",
"user_id": "user_id"
}
],
"next_page": "next_page"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"chat_metrics": {
"distinct_conversation_skill_used_count": 0
},
"claude_code_metrics": {
"distinct_session_skill_used_count": 0
},
"cowork_metrics": {
"distinct_session_skill_used_count": 0
},
"distinct_user_count": 0,
"office_metrics": {
"excel": {
"distinct_session_skill_used_count": 0
},
"outlook": {
"distinct_session_skill_used_count": 0
},
"powerpoint": {
"distinct_session_skill_used_count": 0
},
"word": {
"distinct_session_skill_used_count": 0
}
},
"skill_name": "skill_name",
"attributed_list_price": "attributed_list_price",
"chat_cowork_unified_metrics": {
"chat": {
"distinct_conversation_skill_used_count": 0
},
"sessions": {
"distinct_session_skill_used_count": 0
}
},
"currency": "currency",
"enable_count": 0,
"estimated_overage_spend": "estimated_overage_spend",
"invocation_count": 0,
"product": "product",
"rbac_group_id": "rbac_group_id",
"rbac_group_name": "rbac_group_name",
"share_status": "organization",
"skill_display_name": "skill_display_name",
---
## Skills - Claude API Reference
Source: https://platform.claude.com/docs/en/api/http/beta/organization/analytics/skills
Path: 04-API-Reference/Admin/http-beta-organization-analytics-skills.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fhttp%2Fbeta%2Forganization%2Fanalytics%2Fskills)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Summaries
Users
Apps
Connectors
Plugins
Skills
Get Skill Usage
Artifacts
Usage Report
User Usage Report
Cost Report
User Cost Report
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Analytics](platform-claude-com-http-beta-organization-analytics.md)
# Skills
##### [Get Skill Usage](platform-claude-com-http-beta-organization-analytics-skills-list.md)
GET/v1/organizations/analytics/skills
Get per-skill usage for a given day, with cursor-based pagination.
---
## Get Activity Summaries - Claude API Reference
Source: https://platform.claude.com/docs/en/api/http/beta/organization/analytics/summaries/list
Path: 04-API-Reference/Admin/http-beta-organization-analytics-summaries-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fhttp%2Fbeta%2Forganization%2Fanalytics%2Fsummaries%2Flist)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Summaries
Get Activity Summaries
Users
Apps
Connectors
Plugins
Skills
Artifacts
Usage Report
User Usage Report
Cost Report
User Cost Report
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Analytics](platform-claude-com-http-beta-organization-analytics.md)
5. [Summaries](http-beta-organization-analytics-summaries.md)
# Get Activity Summaries
GET/v1/organizations/analytics/summaries
Get organization-wide activity summaries for a date range.
Returns one entry per day from `starting_date` (inclusive) to `ending_date` (exclusive) in `data`, the same `data` / `next_page` envelope as the other analytics list endpoints; the series is currently returned in full, so `next_page` is always null (`summaries` is a deprecated alias of `data`). Data is typically available with a 1-day lag and may be revised by a few percent over the following days: when `ending_date` is omitted it defaults to the most recent available day + 1, so the last entry covers the most recent available day. The series can be scoped to an RBAC group via `filter[]=rbac_group_id:{id}`. Available to organizations on a Claude Enterprise plan. Requires an API key with the `read:analytics` scope.
##### Query parameters
starting_date: string
UTC date in YYYY-MM-DD format. Start of the date range (inclusive). Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day) and may be revised by a few percent over the following days. No earlier than 2026-01-01.
formatdate
ending_date: optional string
UTC date in YYYY-MM-DD format. End of the date range (exclusive). Data is typically available with a 1-day lag, so this can be at most today — which is also the default when omitted, making the last entry cover the most recent available day. Data may be revised by a few percent over the following days. The range may span at most 366 days.
formatdate
filter: optional array of string
Filters as `dimension:value`. Only `rbac_group_id` is supported (e.g. `filter[]=rbac_group_id:{id}`); repeat the param to OR across groups. Scopes the whole day series to members of the matching group(s), re-aggregated from member-level activity — org-wide seat/invite fields and the adoption rates derived from them are null on scoped rows. `rbac_group_id` accepts the tagged id (`rbac_group_...`, as emitted in responses and by the spend-limits API) or a bare group UUID, and matches users who held the group at any point during each UTC day (time-of-usage attribution). At most 100 entries.
maxItems100
limit: optional number
Number of results per page (1-1000, default 100). The day series (at most 366 entries) is currently returned in full in a single page, so `limit` does not yet shorten it.
minimum1
maximum1000
page: optional string
Opaque cursor from a previous response's `next_page` field. `next_page` is currently always null, so there is never a cursor to send.
##### Returns
data: array of [BetaAnalyticsSingleDayActivitySummary](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_single_day_activity_summary) { assigned_seat_count, cowork_daily_active_user_count, cowork_monthly_active_user_count, 26 more }
One entry per day in the requested range, ascending by date.
assigned_seat_count: number or null
Number of seats currently assigned to members. Null when the response is scoped to an RBAC group — seat assignment is org-wide and has no per-group analogue.
cowork_daily_active_user_count: number
Number of users with Cowork activity on the requested day
cowork_monthly_active_user_count: number
Number of users with Cowork activity in the 30-day rolling window
cowork_weekly_active_user_count: number
Number of users with Cowork activity in the 7-day rolling window
daily_active_user_count: number
Number of users with token consumption on the requested day
daily_adoption_rate: number or null
Percentage of assigned seats with activity on the requested day (`DAU / assigned_seat_count * 100`). Null when the response is scoped to an RBAC group.
ending_at: string
End of the aggregation period (exclusive), UTC midnight in RFC 3339 format (e.g. `2026-01-16T00:00:00Z`).
formatdate-time
monthly_active_user_count: number
Number of users with token consumption in the 30-day rolling window
monthly_adoption_rate: number or null
Percentage of assigned seats with activity in the 30-day rolling window (`MAU / assigned_seat_count * 100`). Null when the response is scoped to an RBAC group.
pending_invite_count: number or null
Number of pending invitations to join the organization. Null when the response is scoped to an RBAC group.
starting_at: string
Start of the aggregation period (inclusive), UTC midnight in RFC 3339 format (e.g. `2026-01-15T00:00:00Z`).
formatdate-time
weekly_active_user_count: number
Number of users with token consumption in the 7-day rolling window
weekly_adoption_rate: number or null
Percentage of assigned seats with activity in the 7-day rolling window (`WAU / assigned_seat_count * 100`). Null when the response is scoped to an RBAC group.
chat_daily_active_user_count: optional number or null
Number of users with claude.ai (chat) activity on the requested day. Omitted from the response while the per-product breakdown is not enabled for this organization.
chat_monthly_active_user_count: optional number or null
Number of users with claude.ai (chat) activity in the 30-day rolling window. Omitted from the response while the per-product breakdown is not enabled for this organization.
chat_weekly_active_user_count: optional number or null
Number of users with claude.ai (chat) activity in the 7-day rolling window. Omitted from the response while the per-product breakdown is not enabled for this organization.
claude_code_daily_active_user_count: optional number or null
Number of users with Claude Code activity on the requested day. Omitted from the response while the per-product breakdown is not enabled for this organization.
claude_code_monthly_active_user_count: optional number or null
Number of users with Claude Code activity in the 30-day rolling window. Omitted from the response while the per-product breakdown is not enabled for this organization.
claude_code_weekly_active_user_count: optional number or null
Number of users with Claude Code activity in the 7-day rolling window. Omitted from the response while the per-product breakdown is not enabled for this organization.
claude_design_daily_active_user_count: optional number or null
Number of users with Claude Design activity on the requested day. Omitted from the response while the per-product breakdown is not enabled for this organization.
claude_design_monthly_active_user_count: optional number or null
Number of users with Claude Design activity in the 30-day rolling window. Omitted from the response while the per-product breakdown is not enabled for this organization.
claude_design_weekly_active_user_count: optional number or null
Number of users with Claude Design activity in the 7-day rolling window. Omitted from the response while the per-product breakdown is not enabled for this organization.
office_agent_daily_active_user_count: optional number or null
Number of users with Claude in Office activity on the requested day. Omitted from the response while the per-product breakdown is not enabled for this organization.
office_agent_monthly_active_user_count: optional number or null
Number of users with Claude in Office activity in the 30-day rolling window. Omitted from the response while the per-product breakdown is not enabled for this organization.
office_agent_weekly_active_user_count: optional number or null
Number of users with Claude in Office activity in the 7-day rolling window. Omitted from the response while the per-product breakdown is not enabled for this organization.
science_daily_active_user_count: optional number or null
Number of users with Claude Science activity on the requested day. Omitted from the response while the per-product breakdown is not enabled for this organization.
science_entitled_user_count: optional number or null
Number of users with a Claude Science seat entitlement (per-seat RBAC) at the time of the daily snapshot. The funnel top; independent of the org-level Claude Science toggle. Null when the response is scoped to an RBAC group — entitlement is org-wide and has no per-group analogue. Omitted from the response while the per-product breakdown is not enabled for this organization.
science_monthly_active_user_count: optional number or null
Number of users with Claude Science activity in the 30-day rolling window. Omitted from the response while the per-product breakdown is not enabled for this organization.
science_weekly_active_user_count: optional number or null
Number of users with Claude Science activity in the 7-day rolling window. Omitted from the response while the per-product breakdown is not enabled for this organization.
next_page: string or null
Opaque cursor for the next page, or null if no more results. Currently always null: the day series is returned in full.
summaries: array of [BetaAnalyticsSingleDayActivitySummary](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_single_day_activity_summary) { assigned_seat_count, cowork_daily_active_user_count, cowork_monthly_active_user_count, 26 more }Deprecated
Deprecated: use `data`, which carries the same entries.
assigned_seat_count: number or null
Number of seats currently assigned to members. Null when the response is scoped to an RBAC group — seat assignment is org-wide and has no per-group analogue.
cowork_daily_active_user_count: number
Number of users with Cowork activity on the requested day
cowork_monthly_active_user_count: number
Number of users with Cowork activity in the 30-day rolling window
cowork_weekly_active_user_count: number
Number of users with Cowork activity in the 7-day rolling window
daily_active_user_count: number
Number of users with token consumption on the requested day
daily_adoption_rate: number or null
Percentage of assigned seats with activity on the requested day (`DAU / assigned_seat_count * 100`). Null when the response is scoped to an RBAC group.
ending_at: string
End of the aggregation period (exclusive), UTC midnight in RFC 3339 format (e.g. `2026-01-16T00:00:00Z`).
formatdate-time
monthly_active_user_count: number
Number of users with token consumption in the 30-day rolling window
monthly_adoption_rate: number or null
Percentage of assigned seats with activity in the 30-day rolling window (`MAU / assigned_seat_count * 100`). Null when the response is scoped to an RBAC group.
pending_invite_count: number or null
Number of pending invitations to join the organization. Null when the response is scoped to an RBAC group.
starting_at: string
Start of the aggregation period (inclusive), UTC midnight in RFC 3339 format (e.g. `2026-01-15T00:00:00Z`).
formatdate-time
weekly_active_user_count: number
Number of users with token consumption in the 7-day rolling window
weekly_adoption_rate: number or null
Percentage of assigned seats with activity in the 7-day rolling window (`WAU / assigned_seat_count * 100`). Null when the response is scoped to an RBAC group.
chat_daily_active_user_count: optional number or null
Number of users with claude.ai (chat) activity on the requested day. Omitted from the response while the per-product breakdown is not enabled for this organization.
chat_monthly_active_user_count: optional number or null
Number of users with claude.ai (chat) activity in the 30-day rolling window. Omitted from the response while the per-product breakdown is not enabled for this organization.
chat_weekly_active_user_count: optional number or null
Number of users with claude.ai (chat) activity in the 7-day rolling window. Omitted from the response while the per-product breakdown is not enabled for this organization.
claude_code_daily_active_user_count: optional number or null
Number of users with Claude Code activity on the requested day. Omitted from the response while the per-product breakdown is not enabled for this organization.
claude_code_monthly_active_user_count: optional number or null
Number of users with Claude Code activity in the 30-day rolling window. Omitted from the response while the per-product breakdown is not enabled for this organization.
claude_code_weekly_active_user_count: optional number or null
Number of users with Claude Code activity in the 7-day rolling window. Omitted from the response while the per-product breakdown is not enabled for this organization.
claude_design_daily_active_user_count: optional number or null
Number of users with Claude Design activity on the requested day. Omitted from the response while the per-product breakdown is not enabled for this organization.
claude_design_monthly_active_user_count: optional number or null
Number of users with Claude Design activity in the 30-day rolling window. Omitted from the response while the per-product breakdown is not enabled for this organization.
claude_design_weekly_active_user_count: optional number or null
Number of users with Claude Design activity in the 7-day rolling window. Omitted from the response while the per-product breakdown is not enabled for this organization.
office_agent_daily_active_user_count: optional number or null
Number of users with Claude in Office activity on the requested day. Omitted from the response while the per-product breakdown is not enabled for this organization.
office_agent_monthly_active_user_count: optional number or null
Number of users with Claude in Office activity in the 30-day rolling window. Omitted from the response while the per-product breakdown is not enabled for this organization.
office_agent_weekly_active_user_count: optional number or null
Number of users with Claude in Office activity in the 7-day rolling window. Omitted from the response while the per-product breakdown is not enabled for this organization.
science_daily_active_user_count: optional number or null
Number of users with Claude Science activity on the requested day. Omitted from the response while the per-product breakdown is not enabled for this organization.
science_entitled_user_count: optional number or null
Number of users with a Claude Science seat entitlement (per-seat RBAC) at the time of the daily snapshot. The funnel top; independent of the org-level Claude Science toggle. Null when the response is scoped to an RBAC group — entitlement is org-wide and has no per-group analogue. Omitted from the response while the per-product breakdown is not enabled for this organization.
science_monthly_active_user_count: optional number or null
Number of users with Claude Science activity in the 30-day rolling window. Omitted from the response while the per-product breakdown is not enabled for this organization.
science_weekly_active_user_count: optional number or null
Number of users with Claude Science activity in the 7-day rolling window. Omitted from the response while the per-product breakdown is not enabled for this organization.
Get Activity Summaries
cURL
```python
curl https://api.anthropic.com/v1/organizations/analytics/summaries \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"data": [
{
"assigned_seat_count": 0,
"cowork_daily_active_user_count": 0,
"cowork_monthly_active_user_count": 0,
"cowork_weekly_active_user_count": 0,
"daily_active_user_count": 0,
"daily_adoption_rate": 0,
"ending_at": "2019-12-27T18:11:19.117Z",
"monthly_active_user_count": 0,
"monthly_adoption_rate": 0,
"pending_invite_count": 0,
"starting_at": "2019-12-27T18:11:19.117Z",
"weekly_active_user_count": 0,
"weekly_adoption_rate": 0,
"chat_daily_active_user_count": 0,
"chat_monthly_active_user_count": 0,
"chat_weekly_active_user_count": 0,
"claude_code_daily_active_user_count": 0,
"claude_code_monthly_active_user_count": 0,
"claude_code_weekly_active_user_count": 0,
"claude_design_daily_active_user_count": 0,
"claude_design_monthly_active_user_count": 0,
"claude_design_weekly_active_user_count": 0,
"office_agent_daily_active_user_count": 0,
"office_agent_monthly_active_user_count": 0,
"office_agent_weekly_active_user_count": 0,
"science_daily_active_user_count": 0,
"science_entitled_user_count": 0,
"science_monthly_active_user_count": 0,
"science_weekly_active_user_count": 0
}
],
"next_page": "next_page",
"summaries": [
{
"assigned_seat_count": 0,
"cowork_daily_active_user_count": 0,
"cowork_monthly_active_user_count": 0,
"cowork_weekly_active_user_count": 0,
"daily_active_user_count": 0,
"daily_adoption_rate": 0,
"ending_at": "2019-12-27T18:11:19.117Z",
"monthly_active_user_count": 0,
"monthly_adoption_rate": 0,
"pending_invite_count": 0,
"starting_at": "2019-12-27T18:11:19.117Z",
"weekly_active_user_count": 0,
"weekly_adoption_rate": 0,
"chat_daily_active_user_count": 0,
"chat_monthly_active_user_count": 0,
"chat_weekly_active_user_count": 0,
"claude_code_daily_active_user_count": 0,
"claude_code_monthly_active_user_count": 0,
"claude_code_weekly_active_user_count": 0,
"claude_design_daily_active_user_count": 0,
"claude_design_monthly_active_user_count": 0,
"claude_design_weekly_active_user_count": 0,
"office_agent_daily_active_user_count": 0,
"office_agent_monthly_active_user_count": 0,
"office_agent_weekly_active_user_count": 0,
"science_daily_active_user_count": 0,
"science_entitled_user_count": 0,
"science_monthly_active_user_count": 0,
"science_weekly_active_user_count": 0
}
]
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"assigned_seat_count": 0,
"cowork_daily_active_user_count": 0,
"cowork_monthly_active_user_count": 0,
"cowork_weekly_active_user_count": 0,
"daily_active_user_count": 0,
"daily_adoption_rate": 0,
"ending_at": "2019-12-27T18:11:19.117Z",
"monthly_active_user_count": 0,
"monthly_adoption_rate": 0,
"pending_invite_count": 0,
"starting_at": "2019-12-27T18:11:19.117Z",
"weekly_active_user_count": 0,
"weekly_adoption_rate": 0,
"chat_daily_active_user_count": 0,
"chat_monthly_active_user_count": 0,
"chat_weekly_active_user_count": 0,
"claude_code_daily_active_user_count": 0,
"claude_code_monthly_active_user_count": 0,
"claude_code_weekly_active_user_count": 0,
"claude_design_daily_active_user_count": 0,
"claude_design_monthly_active_user_count": 0,
"claude_design_weekly_active_user_count": 0,
"office_agent_daily_active_user_count": 0,
"office_agent_monthly_active_user_count": 0,
"office_agent_weekly_active_user_count": 0,
"science_daily_active_user_count": 0,
"science_entitled_user_count": 0,
"science_monthly_active_user_count": 0,
"science_weekly_active_user_count": 0
}
],
"next_page": "next_page",
"summaries": [
{
"assigned_seat_count": 0,
"cowork_daily_active_user_count": 0,
"cowork_monthly_active_user_count": 0,
"cowork_weekly_active_user_count": 0,
"daily_active_user_count": 0,
"daily_adoption_rate": 0,
"ending_at": "2019-12-27T18:11:19.117Z",
"monthly_active_user_count": 0,
"monthly_adoption_rate": 0,
"pending_invite_count": 0,
"starting_at": "2019-12-27T18:11:19.117Z",
"weekly_active_user_count": 0,
"weekly_adoption_rate": 0,
"chat_daily_active_user_count": 0,
"chat_monthly_active_user_count": 0,
"chat_weekly_active_user_count": 0,
"claude_code_daily_active_user_count": 0,
"claude_code_monthly_active_user_count": 0,
"claude_code_weekly_active_user_count": 0,
"claude_design_daily_active_user_count": 0,
"claude_design_monthly_active_user_count": 0,
"claude_design_weekly_active_user_count": 0,
"office_agent_daily_active_user_count": 0,
"office_agent_monthly_active_user_count": 0,
"office_agent_weekly_active_user_count": 0,
"science_daily_active_user_count": 0,
"science_entitled_user_count": 0,
"science_monthly_active_user_count": 0,
"science_weekly_active_user_count": 0
---
## Summaries - Claude API Reference
Source: https://platform.claude.com/docs/en/api/http/beta/organization/analytics/summaries
Path: 04-API-Reference/Admin/http-beta-organization-analytics-summaries.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fhttp%2Fbeta%2Forganization%2Fanalytics%2Fsummaries)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Summaries
Get Activity Summaries
Users
Apps
Connectors
Plugins
Skills
Artifacts
Usage Report
User Usage Report
Cost Report
User Cost Report
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Analytics](platform-claude-com-http-beta-organization-analytics.md)
# Summaries
##### [Get Activity Summaries](http-beta-organization-analytics-summaries-list.md)
GET/v1/organizations/analytics/summaries
Get organization-wide activity summaries for a date range.
---
## Get Token Usage Over Time - Claude API Reference
Source: https://platform.claude.com/docs/en/api/http/beta/organization/analytics/usage/list
Path: 04-API-Reference/Admin/http-beta-organization-analytics-usage-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fhttp%2Fbeta%2Forganization%2Fanalytics%2Fusage%2Flist)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Get Activity Summaries
Usage
Get Token Usage Over Time
Get Per-User Token Usage
Cost
Users
Skills
Connectors
Chat Projects
Plugins
Artifacts
Spend Limits
RBAC Groups
RBAC Roles
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Analytics](platform-claude-com-http-beta-organization-analytics.md)
5. [Usage](http-beta-organization-analytics-usage.md)
# Get Token Usage Over Time
GET/v1/organizations/analytics/usage_report
Get token usage over time across a date range.
Returns token usage bucketed by minute, hour, or day, optionally broken down by product, model, context window, inference region, or speed. Available to organizations on a Claude Enterprise plan. Requires an API key with the `read:analytics` scope.
##### Query parameters
starting_at: string
Start of range, inclusive. RFC 3339 tz-aware. Must be within the last 365 days and no earlier than 2026-01-01T00:00:00Z.
formatdate-time
bucket_width: optional "1d" or "1h" or "1m"
Time bucket granularity.
default1d
One of the following:
"1d"
"1h"
"1m"
claude_tag_categories: optional array of "dm" or "engaged" or "monitoring" or 2 more
Filter to Claude Tag (Claude in Slack) usage in specific spend categories. Usage with no category never matches. `dm` usage is reported under the user's product rather than `claude-tag`, so combining this filter with `products[]=claude-tag` excludes it. Use `group_by[]=claude_tag_category` to break out per-category values.
maxItems100
One of the following:
"dm"
"engaged"
"monitoring"
"proactive"
"scheduled"
claude_tag_user_ids: optional array of string
Filter to Claude Tag (Claude in Slack) usage attributed to specific Slack users, by Slack user ID (for example `U0123ABCDEF`), not claude.ai user ID. Usage that is not Claude Tag, and Claude Tag usage not attributed to a single user, never matches. Use `group_by[]=claude_tag_user_id` to break out per-user values.
maxItems100
context_windows: optional array of "0-200k" or "200k-1M"
Filter to specific context-window pricing tiers. Use `group_by[]=context_window` to break out per-tier values.
maxItems100
One of the following:
"0-200k"
"200k-1M"
ending_at: optional string
End of range, exclusive. When omitted, defaults to the earlier of now and `starting_at` + 31 days. The range may span at most 31 days.
formatdate-time
group_by: optional array of "claude_tag_category" or "claude_tag_user_id" or "context_window" or 6 more
Dimensions to break each time bucket out by. Defaults to no grouping (one total per bucket). Each bucket reports at most its top 100 groups; a group beyond that cap has no row in that bucket (there is no remainder row), so grouped buckets are not exhaustive when a dimension has more than 100 distinct values.
maxItems100
One of the following:
"claude_tag_category"
"claude_tag_user_id"
"context_window"
"inference_geo"
"model"
"product"
"rbac_group_id"
"slack_channel_id"
"speed"
inference_geos: optional array of "global" or "not_available" or "us"
Filter to specific inference regions. `not_available` matches rows where the region is unset. Use `group_by[]=inference_geo` to break out per-region values.
maxItems100
One of the following:
"global"
"not_available"
"us"
limit: optional number
Maximum number of time buckets per page. Defaults and caps vary by `bucket_width` (`1d`: default 7, max 31; `1h`: default 24, max 168; `1m`: default 60, max 256).
minimum1
models: optional array of string
Models to include. Defaults to all models. Use `group_by[]=model` to break out per-model values.
maxItems100
page: optional string
Opaque cursor from a previous response's `next_page` field.
products: optional array of "chat" or "claude-tag" or "claude_code" or 4 more
Product surfaces to include. Defaults to all products. Use `group_by[]=product` to break out per-product values.
maxItems100
One of the following:
"chat"
"claude-tag"
"claude_code"
"claude_design"
"claude_in_chrome"
"cowork"
"office_agent"
rbac_group_ids: optional array of string
Filter to usage attributed to specific RBAC groups. Accepts tagged RBAC group IDs (`rbac_group_...`) or bare group UUIDs. A row matches when the user belonged to any of the listed groups on the (UTC) day the usage occurred; usage with no group attribution never matches.
maxItems100
slack_channel_ids: optional array of string
Filter to usage originating from specific Slack channels. Use `group_by[]=slack_channel_id` to break out per-channel values.
maxItems100
speeds: optional array of "fast" or "standard"
Filter to fast or standard inference mode. Use `group_by[]=speed` to break out per-mode values.
maxItems100
One of the following:
"fast"
"standard"
user_ids: optional array of string
Filter to specific users by tagged user ID.
maxItems100
##### Returns
BetaUsageBucket object{ data, data_refreshed_at, has_more, 2 more }
Get Token Usage Over Time
cURL
```python
curl https://api.anthropic.com/v1/organizations/analytics/usage_report \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"data": [
{
"ending_at": "2019-12-27T18:11:19.117Z",
"results": [
{
"cache_creation": {
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 0
},
"cache_read_input_tokens": 0,
"claude_tag_category": "dm",
"claude_tag_user_id": "U0123ABCDEF",
"context_window": "0-200k",
"inference_geo": "global",
"model": "claude-opus-5",
"output_tokens": 0,
"product": "chat",
"rbac_group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"requests": 0,
"server_tool_use": {
"web_search_requests": 10
},
"slack_channel_id": "C0123ABCDEF",
"speed": "fast",
"uncached_input_tokens": 0
}
],
"starting_at": "2019-12-27T18:11:19.117Z"
}
],
"data_refreshed_at": "2019-12-27T18:11:19.117Z",
"has_more": true,
"next_page": "next_page",
"organization_id": "org_013FP9SaFPBg7Kw7fetjn6cF"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"ending_at": "2019-12-27T18:11:19.117Z",
"results": [
{
"cache_creation": {
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 0
},
"cache_read_input_tokens": 0,
"claude_tag_category": "dm",
"claude_tag_user_id": "U0123ABCDEF",
"context_window": "0-200k",
"inference_geo": "global",
"model": "claude-opus-5",
"output_tokens": 0,
"product": "chat",
"rbac_group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"requests": 0,
"server_tool_use": {
"web_search_requests": 10
},
"slack_channel_id": "C0123ABCDEF",
"speed": "fast",
"uncached_input_tokens": 0
}
],
"starting_at": "2019-12-27T18:11:19.117Z"
}
],
"data_refreshed_at": "2019-12-27T18:11:19.117Z",
"has_more": true,
"next_page": "next_page",
"organization_id": "org_013FP9SaFPBg7Kw7fetjn6cF"
---
## Get Token Usage Over Time - Claude API Reference
Source: https://platform.claude.com/docs/en/api/http/beta/organization/analytics/usage_report/list
Path: 04-API-Reference/Admin/http-beta-organization-analytics-usage-report-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fhttp%2Fbeta%2Forganization%2Fanalytics%2Fusage_report%2Flist)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Summaries
Users
Apps
Connectors
Plugins
Skills
Artifacts
Usage Report
Get Token Usage Over Time
User Usage Report
Cost Report
User Cost Report
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Analytics](platform-claude-com-http-beta-organization-analytics.md)
5. [Usage Report](http-beta-organization-analytics-usage-report.md)
# Get Token Usage Over Time
GET/v1/organizations/analytics/usage_report
Get token usage over time across a date range.
Returns token usage bucketed by minute, hour, or day, optionally broken down by product, model, context window, inference region, or speed. Available to organizations on a Claude Enterprise plan. Requires an API key with the `read:analytics` scope.
##### Query parameters
starting_at: string
Start of range, inclusive. RFC 3339 tz-aware. Must be within the last 365 days and no earlier than 2026-01-01T00:00:00Z.
formatdate-time
bucket_width: optional "1d" or "1h" or "1m"
Time bucket granularity.
default1d
One of the following:
"1d"
"1h"
"1m"
claude_tag_categories: optional array of [BetaAnalyticsClaudeTagCategory](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_claude_tag_category)
Filter to Claude Tag (Claude in Slack) usage in specific spend categories. Usage with no category never matches. `dm` usage is reported under the user's product rather than `claude-tag`, so combining this filter with `products[]=claude-tag` excludes it. Use `group_by[]=claude_tag_category` to break out per-category values.
maxItems100
One of the following:
"dm"
"engaged"
"monitoring"
"proactive"
"scheduled"
claude_tag_user_ids: optional array of string
Filter to Claude Tag (Claude in Slack) usage attributed to specific Slack users, by Slack user ID (for example `U0123ABCDEF`), not claude.ai user ID. Usage that is not Claude Tag, and Claude Tag usage not attributed to a single user, never matches. Use `group_by[]=claude_tag_user_id` to break out per-user values.
maxItems100
context_windows: optional array of [BetaAnalyticsContextWindow](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_context_window)
Filter to specific context-window pricing tiers. Use `group_by[]=context_window` to break out per-tier values.
maxItems100
One of the following:
"0-200k"
"200k-1M"
ending_at: optional string
End of range, exclusive. When omitted, defaults to the earlier of now and `starting_at` + 31 days. The range may span at most 31 days.
formatdate-time
group_by: optional array of "claude_tag_category" or "claude_tag_user_id" or "context_window" or 6 more
Dimensions to break each time bucket out by. Defaults to no grouping (one total per bucket). Each bucket reports at most its top 100 groups; a group beyond that cap has no row in that bucket (there is no remainder row), so grouped buckets are not exhaustive when a dimension has more than 100 distinct values.
maxItems100
One of the following:
"claude_tag_category"
"claude_tag_user_id"
"context_window"
"inference_geo"
"model"
"product"
"rbac_group_id"
"slack_channel_id"
"speed"
inference_geos: optional array of [BetaAnalyticsInferenceGeoFilter](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_inference_geo_filter)
Filter to specific inference regions. `not_available` matches rows where the region is unset. Use `group_by[]=inference_geo` to break out per-region values.
maxItems100
One of the following:
"global"
"not_available"
"us"
limit: optional number
Maximum number of time buckets per page. Defaults and caps vary by `bucket_width` (`1d`: default 7, max 31; `1h`: default 24, max 168; `1m`: default 60, max 256).
minimum1
models: optional array of string
Models to include. Defaults to all models. Use `group_by[]=model` to break out per-model values.
maxItems100
page: optional string
Opaque cursor from a previous response's `next_page` field.
products: optional array of [BetaAnalyticsProductFilter](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_product_filter)
Product surfaces to include. Defaults to all products. Use `group_by[]=product` to break out per-product values.
maxItems100
One of the following:
"chat"
"claude-tag"
"claude_code"
"claude_design"
"claude_in_chrome"
"cowork"
"office_agent"
rbac_group_ids: optional array of string
Filter to usage attributed to specific RBAC groups. Accepts tagged RBAC group IDs (`rbac_group_...`) or bare group UUIDs. A row matches when the user belonged to any of the listed groups on the (UTC) day the usage occurred; usage with no group attribution never matches.
maxItems100
slack_channel_ids: optional array of string
Filter to usage originating from specific Slack channels. Use `group_by[]=slack_channel_id` to break out per-channel values.
maxItems100
speeds: optional array of "fast" or "standard"
Filter to fast or standard inference mode. Use `group_by[]=speed` to break out per-mode values.
maxItems100
One of the following:
"fast"
"standard"
user_ids: optional array of string
Filter to specific users by tagged user ID.
maxItems100
##### Returns
data: array of [BetaAnalyticsUsageReportTimeBucket](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_usage_report_time_bucket) { ending_at, results, starting_at }
Time buckets for this page, oldest first: one per `bucket_width` interval, including intervals with no data (their `results` list is empty). A page holds at most `limit` buckets.
ending_at: string
End of the time bucket (exclusive) in RFC 3339 format.
formatdate-time
results: array of [BetaAnalyticsUsageBucketedResult](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_usage_bucketed_result) { cache_creation, cache_read_input_tokens, claude_tag_category, 12 more }
Rows for this time bucket. Empty when the bucket has no data; otherwise a single combined row when `group_by[]` is omitted, or one row per group (subject to the per-bucket group cap described on the `group_by[]` parameter).
cache_creation: [BetaCacheCreation](../Endpoints/platform-claude-com-http-beta-messages.md#beta_cache_creation) { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens }
The number of input tokens for cache creation.
ephemeral_1h_input_tokens: number
The number of input tokens used to create the 1 hour cache entry.
default0
minimum0
ephemeral_5m_input_tokens: number
The number of input tokens used to create the 5 minute cache entry.
default0
minimum0
cache_read_input_tokens: number
The number of input tokens read from the cache.
claude_tag_category: [BetaAnalyticsClaudeTagCategory](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_claude_tag_category) or null
Claude Tag (Claude in Slack) spend category: `engaged` (a person addressed Claude in a channel or thread), `proactive` (Claude responded without being addressed), `scheduled` (a scheduled routine ran), `monitoring` (Claude watching a channel it was asked to monitor), or `dm` (direct messages with Claude). Populated only when `claude_tag_category` is in `group_by[]`; null for usage that is not Claude Tag. Direct-message usage is billed to the individual user and is reported under that user's product, not under `claude-tag`. New categories may be added over time.
One of the following:
"dm"
"engaged"
"monitoring"
"proactive"
"scheduled"
claude_tag_user_id: string or null
Slack user ID (for example `U0123ABCDEF`) of the member the Claude Tag (Claude in Slack) usage is attributed to, not a claude.ai user ID. Populated only when `claude_tag_user_id` is in `group_by[]`; null for usage that is not Claude Tag and for Claude Tag usage that is not attributed to a single user (for example `monitoring`, and `proactive` usage Claude initiated), so per-user rows can sum to less than the Claude Tag total. Cannot be combined with `group_by[]=rbac_group_id` or the `rbac_group_ids[]` filter.
context_window: [BetaAnalyticsContextWindow](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_context_window) or null
Context-window pricing tier of the usage or cost. Null unless `context_window` is in `group_by[]`; it can also be null on grouped rows with no context-window tier, such as code execution.
One of the following:
"0-200k"
"200k-1M"
inference_geo: "global" or "us" or null
Inference region of the usage or cost. Null unless `inference_geo` is in `group_by[]`; it can also be null on grouped rows where the region is not set (the rows that `inference_geos[]=not_available` matches).
One of the following:
"global"
"us"
model: string or null
Model that produced the usage or cost, as a model name in the form the `models[]` filter accepts (for example, `claude-opus-5`). Null unless `model` is in `group_by[]`; it can also be null on grouped rows whose usage or cost is not attributed to a specific model, such as code execution.
output_tokens: number
The number of output tokens generated.
product: string or null
Product surface that produced the usage or cost. Null unless product is in `group_by[]`; it can also be null on grouped rows whose usage cannot be attributed to a known surface. Values include `chat`, `claude_code`, `cowork`, `office_agent`, `claude_in_chrome`, `claude_design`, and `claude-tag`. `claude-tag` is Claude Tag, the Claude product in Slack. Some unattributed usage is reported as "other".
rbac_group_id: string or null
RBAC group (team) the usage is attributed to, in the public tagged `rbac_group_...` spelling — the same spelling the activity resources use for this key, so the same team has one id across resources and it round-trips as an `rbac_group_ids[]` filter value. Populated only when `rbac_group_id` is in `group_by[]`. Any-membership semantics: a user in several groups contributes their full usage to each of those groups' rows, so the named-group rows overlap and their sum can exceed the org total. A null value is the single unassigned row: users in no group on that (UTC) day. For the true org total, run the same query without `group_by[]`.
requests: number or null
Number of API requests in this row's scope. For sandbox / code-execution events, this counts execution spans rather than HTTP requests (these rows surface with `product: null`).
server_tool_use: [BetaAnalyticsServerToolUse](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_server_tool_use) { web_search_requests }
Server-side tool usage metrics.
web_search_requests: number
The number of web search requests made.
slack_channel_id: string or null
Slack channel the usage originated from. Populated only when `slack_channel_id` is in `group_by[]`; null for usage outside Slack (and for rows recorded before channel attribution was enabled).
speed: "fast" or "standard" or null
Inference speed mode of the usage or cost: `fast` or `standard`. Null unless `speed` is in `group_by[]`.
One of the following:
"fast"
"standard"
uncached_input_tokens: number
The number of uncached input tokens processed.
starting_at: string
Start of the time bucket (inclusive) in RFC 3339 format.
formatdate-time
data_refreshed_at: string or null
RFC 3339 timestamp of the export this response was served from. Null when no export yet covers any part of the requested range, in which case every bucket's `results` list is empty. Buckets beyond this watermark are incomplete; for stable results, set `ending_at` to this value or earlier. Data is typically refreshed every 4 hours but not final until about 30 days after the usage date (late-arriving events, reconciliation adjustments).
formatdate-time
has_more: boolean
Whether another page is available. When true, pass `next_page` as the `page` parameter to fetch it.
next_page: string or null
Opaque cursor for the next page, or null when `has_more` is false. Pass it as the `page` parameter, keeping the other parameters unchanged. A cursor can expire after the underlying data refreshes; the request then returns HTTP 410 and pagination must restart from the first page.
organization_id: string
ID of the Organization.
Get Token Usage Over Time
cURL
```python
curl https://api.anthropic.com/v1/organizations/analytics/usage_report \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"data": [
{
"ending_at": "2019-12-27T18:11:19.117Z",
"results": [
{
"cache_creation": {
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 0
},
"cache_read_input_tokens": 0,
"claude_tag_category": "dm",
"claude_tag_user_id": "U0123ABCDEF",
"context_window": "0-200k",
"inference_geo": "global",
"model": "claude-opus-5",
"output_tokens": 0,
"product": "chat",
"rbac_group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"requests": 0,
"server_tool_use": {
"web_search_requests": 10
},
"slack_channel_id": "C0123ABCDEF",
"speed": "fast",
"uncached_input_tokens": 0
}
],
"starting_at": "2019-12-27T18:11:19.117Z"
}
],
"data_refreshed_at": "2019-12-27T18:11:19.117Z",
"has_more": true,
"next_page": "next_page",
"organization_id": "org_013FP9SaFPBg7Kw7fetjn6cF"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"ending_at": "2019-12-27T18:11:19.117Z",
"results": [
{
"cache_creation": {
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 0
},
"cache_read_input_tokens": 0,
"claude_tag_category": "dm",
"claude_tag_user_id": "U0123ABCDEF",
"context_window": "0-200k",
"inference_geo": "global",
"model": "claude-opus-5",
"output_tokens": 0,
"product": "chat",
"rbac_group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"requests": 0,
"server_tool_use": {
"web_search_requests": 10
},
"slack_channel_id": "C0123ABCDEF",
"speed": "fast",
"uncached_input_tokens": 0
}
],
"starting_at": "2019-12-27T18:11:19.117Z"
}
],
"data_refreshed_at": "2019-12-27T18:11:19.117Z",
"has_more": true,
"next_page": "next_page",
"organization_id": "org_013FP9SaFPBg7Kw7fetjn6cF"
---
## Usage Report - Claude API Reference
Source: https://platform.claude.com/docs/en/api/http/beta/organization/analytics/usage_report
Path: 04-API-Reference/Admin/http-beta-organization-analytics-usage-report.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fhttp%2Fbeta%2Forganization%2Fanalytics%2Fusage_report)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Summaries
Users
Apps
Connectors
Plugins
Skills
Artifacts
Usage Report
Get Token Usage Over Time
User Usage Report
Cost Report
User Cost Report
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Analytics](platform-claude-com-http-beta-organization-analytics.md)
# Usage Report
##### [Get Token Usage Over Time](http-beta-organization-analytics-usage-report-list.md)
GET/v1/organizations/analytics/usage_report
Get token usage over time across a date range.
---
## Usage - Claude API Reference
Source: https://platform.claude.com/docs/en/api/http/beta/organization/analytics/usage
Path: 04-API-Reference/Admin/http-beta-organization-analytics-usage.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [CLI, SDKs, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fhttp%2Fbeta%2Forganization%2Fanalytics%2Fusage)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Get Activity Summaries
Usage
Get Token Usage Over Time
Get Per-User Token Usage
Cost
Users
Skills
Connectors
Chat Projects
Plugins
Artifacts
Spend Limits
RBAC Groups
RBAC Roles
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Analytics](platform-claude-com-http-beta-organization-analytics.md)
# Usage
##### [Get Token Usage Over Time](http-beta-organization-analytics-usage-list.md)
GET/v1/organizations/analytics/usage_report
Get token usage over time across a date range.
##### [Get Per-User Token Usage](beta-organization-analytics-usage-list-by-user.md)
GET/v1/organizations/analytics/user_usage_report
Get per-user token usage across a date range.
##### Models
BetaUsageBucket object{ data, data_refreshed_at, has_more, 2 more }
BetaUserUsage object{ data, data_refreshed_at, has_more, 2 more }
---
## Get Per-User Cost - Claude API Reference
Source: https://platform.claude.com/docs/en/api/http/beta/organization/analytics/user_cost_report/list
Path: 04-API-Reference/Admin/http-beta-organization-analytics-user-cost-report-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fhttp%2Fbeta%2Forganization%2Fanalytics%2Fuser_cost_report%2Flist)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Summaries
Users
Apps
Connectors
Plugins
Skills
Artifacts
Usage Report
User Usage Report
Cost Report
User Cost Report
Get Per-User Cost
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Analytics](platform-claude-com-http-beta-organization-analytics.md)
5. [User Cost Report](http-beta-organization-analytics-user-cost-report.md)
# Get Per-User Cost
GET/v1/organizations/analytics/user_cost_report
Get per-user cost in USD across a date range.
Returns one row per user, ranked by spend. Use this to see which users account for the most cost. Only cost attributable to a seat user is included; for organization-wide totals including direct API-key and automation traffic, use the bucketed `/v1/organizations/analytics/cost_report` endpoint. Available to organizations on a Claude Enterprise plan. Requires an API key with the `read:analytics` scope.
##### Query parameters
starting_at: string
Start of range, inclusive. RFC 3339 tz-aware. Must be within the last 365 days and no earlier than 2026-01-01T00:00:00Z.
formatdate-time
bucket_width: optional "1d" or "1h" or "1m"
Time-bucket granularity. When set, each row's `starting_at` and `ending_at` are populated and one actor may span several rows (one per time bucket with usage). The time bucket counts toward `limit`, so one page can return multiple rows for the same actor. `ending_at` is required when `bucket_width` is set, and with `bucket_width="1m"` the range may span at most 24 hours. When omitted, each row aggregates the full `[starting_at, ending_at)` range.
One of the following:
"1d"
"1h"
"1m"
claude_tag_categories: optional array of [BetaAnalyticsClaudeTagCategory](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_claude_tag_category)
Filter to Claude Tag (Claude in Slack) usage in specific spend categories. Usage with no category never matches. `dm` usage is reported under the user's product rather than `claude-tag`, so combining this filter with `products[]=claude-tag` excludes it. Use `group_by[]=claude_tag_category` to break out per-category values.
maxItems100
One of the following:
"dm"
"engaged"
"monitoring"
"proactive"
"scheduled"
claude_tag_user_ids: optional array of string
Filter to Claude Tag (Claude in Slack) usage attributed to specific Slack users, by Slack user ID (for example `U0123ABCDEF`), not claude.ai user ID. Usage that is not Claude Tag, and Claude Tag usage not attributed to a single user, never matches. Use `group_by[]=claude_tag_user_id` to break out per-user values.
maxItems100
context_windows: optional array of [BetaAnalyticsContextWindow](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_context_window)
Filter to specific context-window pricing tiers. Use `group_by[]=context_window` to break out per-tier values.
maxItems100
One of the following:
"0-200k"
"200k-1M"
ending_at: optional string
End of range, exclusive. When omitted, defaults to the earlier of now and `starting_at` + 31 days. The range may span at most 31 days.
formatdate-time
exclude_deleted_users: optional boolean
If true, omit rows for users who are deleted (`deleted: true`). A page may contain fewer than `limit` rows; use `has_more` and `next_page` to paginate as usual.
defaultfalse
group_by: optional array of "claude_tag_category" or "claude_tag_user_id" or "context_window" or 8 more
Break each actor's row out by the given dimensions. Accepts the same values as the bucketed `/cost_report` endpoint. The `product`, `model`, `context_window`, `inference_geo`, and `speed` dimensions — and the time bucket, when `bucket_width` is set — count toward `limit`. `cost_type` and `token_type` do not: `cost_type` returns one row per cost component (tokens, web search, code execution); `token_type` returns one row per token type, each with `cost_type: "tokens"`; combining both returns the per-token-type rows plus the web-search and code-execution rows. A page can therefore contain more rows than `limit` when `cost_type` or `token_type` is requested.
maxItems100
One of the following:
"claude_tag_category"
"claude_tag_user_id"
"context_window"
"cost_type"
"inference_geo"
"model"
"product"
"rbac_group_id"
"slack_channel_id"
"speed"
"token_type"
inference_geos: optional array of [BetaAnalyticsInferenceGeoFilter](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_inference_geo_filter)
Filter to specific inference regions. `not_available` matches rows where the region is unset. Use `group_by[]=inference_geo` to break out per-region values.
maxItems100
One of the following:
"global"
"not_available"
"us"
limit: optional number
Number of rows per page (1-1000, default 20). One row per actor unless `group_by[]` or `bucket_width` splits an actor across rows; `cost_type`/`token_type` fan-out rows (cost endpoint only) are the exception — they do not count toward this limit, so `data` can exceed it.
default20
minimum1
maximum1000
models: optional array of string
Models to include. Defaults to all models. Use `group_by[]=model` to break out per-model values.
maxItems100
order: optional "asc" or "desc"
Sort direction. Defaults to `desc`.
defaultdesc
One of the following:
"asc"
"desc"
order_by: optional "amount" or "list_amount"
Metric to rank actors by. Defaults to `amount`.
defaultamount
One of the following:
"amount"
"list_amount"
page: optional string
Opaque cursor from a previous response's `next_page` field.
products: optional array of [BetaAnalyticsProductFilter](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_product_filter)
Product surfaces to include. Defaults to all products.
maxItems100
One of the following:
"chat"
"claude-tag"
"claude_code"
"claude_design"
"claude_in_chrome"
"cowork"
"office_agent"
rbac_group_ids: optional array of string
Filter to usage attributed to specific RBAC groups. Accepts tagged RBAC group IDs (`rbac_group_...`) or bare group UUIDs. A row matches when the user belonged to any of the listed groups on the (UTC) day the usage occurred; usage with no group attribution never matches.
maxItems100
slack_channel_ids: optional array of string
Filter to usage originating from specific Slack channels. Use `group_by[]=slack_channel_id` to break out per-channel values.
maxItems100
speeds: optional array of "fast" or "standard"
Filter to fast or standard inference mode. Use `group_by[]=speed` to break out per-mode values.
maxItems100
One of the following:
"fast"
"standard"
user_ids: optional array of string
Filter to specific users by tagged user ID.
maxItems100
##### Returns
data: array of [BetaAnalyticsCostUsersItem](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_cost_users_item) { actor, amount, claude_tag_category, 15 more }
Rows for this page, ranked by `order_by` in the `order` direction. One row per user, or several per user when `group_by[]` or `bucket_width` breaks that user's usage or cost out across rows. Rows split out by `cost_type` or `token_type` (cost endpoint only) stay adjacent and are ranked as one unit.
actor: [BetaAnalyticsUserActor](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_user_actor) { type: "user_actor", deleted, email, 3 more }
The user this row's usage or cost is attributed to. Always a `user_actor`.
type: "user_actor"
Actor type. Always `"user_actor"`.
deleted: boolean
True when the account has been deleted, or when the user is no longer a member of the organization or its associated organizations (for example, their membership was removed or they were deprovisioned via your identity provider). `email_address` stays populated for removed users and is null when the account has been deleted. `name` follows the rules described on that field. The `user_id` is still populated for reconciliation.
email_address: string or null
The user's email address, including for users who are no longer members of the organization or its associated organizations. Null when the account has been deleted (check `deleted`) and for system-minted service accounts, which have no person's mailbox behind them (check `name`).
name: string or null
The user's full name. Null when the user has not set a name. Returns `"Deleted User"` when the account itself has been deleted, or when the user is no longer a member of the organization or its associated organizations and the organization has chosen to hide the names of removed users. Otherwise, the name stays populated for removed users. Rows for system-minted service accounts render the service name (for example, `"Claude Security"` for usage by Anthropic's security-patching service) or null.
user_id: string
Tagged user ID.
email: string or nullDeprecated
Deprecated: use `email_address`, which carries the same value.
amount: string
Amount (post-discount, pre-credit) in fractional cents (minor units).
claude_tag_category: [BetaAnalyticsClaudeTagCategory](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_claude_tag_category) or null
Claude Tag (Claude in Slack) spend category: `engaged` (a person addressed Claude in a channel or thread), `proactive` (Claude responded without being addressed), `scheduled` (a scheduled routine ran), `monitoring` (Claude watching a channel it was asked to monitor), or `dm` (direct messages with Claude). Populated only when `claude_tag_category` is in `group_by[]`; null for usage that is not Claude Tag. Direct-message usage is billed to the individual user and is reported under that user's product, not under `claude-tag`. New categories may be added over time.
One of the following:
"dm"
"engaged"
"monitoring"
"proactive"
"scheduled"
claude_tag_user_id: string or null
Slack user ID (for example `U0123ABCDEF`) of the member the Claude Tag (Claude in Slack) usage is attributed to, not a claude.ai user ID. Populated only when `claude_tag_user_id` is in `group_by[]`; null for usage that is not Claude Tag and for Claude Tag usage that is not attributed to a single user (for example `monitoring`, and `proactive` usage Claude initiated), so per-user rows can sum to less than the Claude Tag total. Cannot be combined with `group_by[]=rbac_group_id` or the `rbac_group_ids[]` filter.
context_window: [BetaAnalyticsContextWindow](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_context_window) or null
Context-window pricing tier of the usage or cost. Null unless `context_window` is in `group_by[]`; it can also be null on grouped rows with no context-window tier, such as code execution.
One of the following:
"0-200k"
"200k-1M"
cost_type: [BetaAnalyticsCostType](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_cost_type) or null
Cost component breakdown; null when returning the combined total.
One of the following:
"code_execution"
"tokens"
"web_search"
currency: string
Currency code for the cost amount. Currently always `"USD"`.
defaultUSD
ending_at: string or null
End of the row's UTC time bucket (exclusive), as an RFC 3339 timestamp; equal to `starting_at` plus one `bucket_width`. Null unless `bucket_width` is set.
formatdate-time
inference_geo: "global" or "us" or null
Inference region of the usage or cost. Null unless `inference_geo` is in `group_by[]`; it can also be null on grouped rows where the region is not set (the rows that `inference_geos[]=not_available` matches).
One of the following:
"global"
"us"
list_amount: string
List-price amount (pre-discount) in fractional cents.
model: string or null
Model that produced the usage or cost, as a model name in the form the `models[]` filter accepts (for example, `claude-opus-5`). Null unless `model` is in `group_by[]`; it can also be null on grouped rows whose usage or cost is not attributed to a specific model, such as code execution.
product: string or null
Product surface that produced the usage or cost. Null unless product is in `group_by[]`; it can also be null on grouped rows whose usage cannot be attributed to a known surface. Values include `chat`, `claude_code`, `cowork`, `office_agent`, `claude_in_chrome`, `claude_design`, and `claude-tag`. `claude-tag` is Claude Tag, the Claude product in Slack. Some unattributed usage is reported as "other".
rbac_group_id: string or null
RBAC group (team) the usage is attributed to, in the public tagged `rbac_group_...` spelling — the same spelling the activity resources use for this key, so the same team has one id across resources and it round-trips as an `rbac_group_ids[]` filter value. Populated only when `rbac_group_id` is in `group_by[]`. Any-membership semantics: a user in several groups contributes their full usage to each of those groups' rows, so the named-group rows overlap and their sum can exceed the org total. A null value is the single unassigned row: users in no group on that (UTC) day. For the true org total, run the same query without `group_by[]`.
requests: number or null
Number of API requests in this row's scope. Null when `group_by` includes `cost_type` or `token_type` (the count has no per-component attribution; read it from the ungrouped response). For sandbox / code-execution events, this counts execution spans rather than HTTP requests (these rows surface with `product: null`).
slack_channel_id: string or null
Slack channel the usage originated from. Populated only when `slack_channel_id` is in `group_by[]`; null for usage outside Slack (and for rows recorded before channel attribution was enabled).
speed: "fast" or "standard" or null
Inference speed mode of the usage or cost: `fast` or `standard`. Null unless `speed` is in `group_by[]`.
One of the following:
"fast"
"standard"
starting_at: string or null
Start of the row's UTC time bucket (inclusive), as an RFC 3339 timestamp. Null unless `bucket_width` is set; without `bucket_width`, each row aggregates the full requested range.
formatdate-time
token_type: [BetaAnalyticsTokenType](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_token_type) or null
Token type when `cost_type` is `tokens`; null otherwise.
One of the following:
"cache_creation.ephemeral_1h_input_tokens"
"cache_creation.ephemeral_5m_input_tokens"
"cache_read_input_tokens"
"output_tokens"
"uncached_input_tokens"
data_refreshed_at: string or null
RFC 3339 timestamp of the export this response was served from. Null when no export yet covers any part of the requested range, in which case `data` is empty. Data beyond this watermark is incomplete; for stable results, set `ending_at` to this value or earlier. Data is typically refreshed every 4 hours but not final until about 30 days after the usage date (late-arriving events, reconciliation adjustments).
formatdate-time
has_more: boolean
Whether another page is available. When true, pass `next_page` as the `page` parameter to fetch it.
next_page: string or null
Opaque cursor for the next page, or null when `has_more` is false. Pass it as the `page` parameter, keeping the other parameters unchanged. A cursor can expire after the underlying data refreshes; the request then returns HTTP 410 and pagination must restart from the first page.
organization_id: string
ID of the Organization.
Get Per-User Cost
cURL
```python
curl https://api.anthropic.com/v1/organizations/analytics/user_cost_report \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"data": [
{
"actor": {
"deleted": true,
"email": "jane@example.com",
"email_address": "jane@example.com",
"name": "Jane Smith",
"type": "user_actor",
"user_id": "user_01AbCdEfGhIjKlMnOpQrSt"
},
"amount": "41280.000000",
"claude_tag_category": "dm",
"claude_tag_user_id": "U0123ABCDEF",
"context_window": "0-200k",
"cost_type": "code_execution",
"currency": "USD",
"ending_at": "2019-12-27T18:11:19.117Z",
"inference_geo": "global",
"list_amount": "51600.000000",
"model": "claude-opus-5",
"product": "chat",
"rbac_group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"requests": 128,
"slack_channel_id": "C0123ABCDEF",
"speed": "fast",
"starting_at": "2019-12-27T18:11:19.117Z",
"token_type": "cache_creation.ephemeral_1h_input_tokens"
}
],
"data_refreshed_at": "2019-12-27T18:11:19.117Z",
"has_more": true,
"next_page": "next_page",
"organization_id": "org_013FP9SaFPBg7Kw7fetjn6cF"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"actor": {
"deleted": true,
"email": "jane@example.com",
"email_address": "jane@example.com",
"name": "Jane Smith",
"type": "user_actor",
"user_id": "user_01AbCdEfGhIjKlMnOpQrSt"
},
"amount": "41280.000000",
"claude_tag_category": "dm",
"claude_tag_user_id": "U0123ABCDEF",
"context_window": "0-200k",
"cost_type": "code_execution",
"currency": "USD",
"ending_at": "2019-12-27T18:11:19.117Z",
"inference_geo": "global",
"list_amount": "51600.000000",
"model": "claude-opus-5",
"product": "chat",
"rbac_group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"requests": 128,
"slack_channel_id": "C0123ABCDEF",
"speed": "fast",
"starting_at": "2019-12-27T18:11:19.117Z",
"token_type": "cache_creation.ephemeral_1h_input_tokens"
}
],
"data_refreshed_at": "2019-12-27T18:11:19.117Z",
"has_more": true,
"next_page": "next_page",
"organization_id": "org_013FP9SaFPBg7Kw7fetjn6cF"
---
## User Cost Report - Claude API Reference
Source: https://platform.claude.com/docs/en/api/http/beta/organization/analytics/user_cost_report
Path: 04-API-Reference/Admin/http-beta-organization-analytics-user-cost-report.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fhttp%2Fbeta%2Forganization%2Fanalytics%2Fuser_cost_report)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Summaries
Users
Apps
Connectors
Plugins
Skills
Artifacts
Usage Report
User Usage Report
Cost Report
User Cost Report
Get Per-User Cost
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Analytics](platform-claude-com-http-beta-organization-analytics.md)
# User Cost Report
##### [Get Per-User Cost](http-beta-organization-analytics-user-cost-report-list.md)
GET/v1/organizations/analytics/user_cost_report
Get per-user cost in USD across a date range.
---
## Get Per-User Token Usage - Claude API Reference
Source: https://platform.claude.com/docs/en/api/http/beta/organization/analytics/user_usage_report/list
Path: 04-API-Reference/Admin/http-beta-organization-analytics-user-usage-report-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fhttp%2Fbeta%2Forganization%2Fanalytics%2Fuser_usage_report%2Flist)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Summaries
Users
Apps
Connectors
Plugins
Skills
Artifacts
Usage Report
User Usage Report
Get Per-User Token Usage
Cost Report
User Cost Report
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Analytics](platform-claude-com-http-beta-organization-analytics.md)
5. [User Usage Report](http-beta-organization-analytics-user-usage-report.md)
# Get Per-User Token Usage
GET/v1/organizations/analytics/user_usage_report
Get per-user token usage across a date range.
Returns one row per user, ranked by the chosen token metric. Use this to see which users consume the most tokens. Only usage attributable to a seat user is included; for organization-wide totals including direct API-key and automation traffic, use the bucketed `/v1/organizations/analytics/usage_report` endpoint. Available to organizations on a Claude Enterprise plan. Requires an API key with the `read:analytics` scope.
##### Query parameters
starting_at: string
Start of range, inclusive. RFC 3339 tz-aware. Must be within the last 365 days and no earlier than 2026-01-01T00:00:00Z.
formatdate-time
bucket_width: optional "1d" or "1h" or "1m"
Time-bucket granularity. When set, each row's `starting_at` and `ending_at` are populated and one actor may span several rows (one per time bucket with usage). The time bucket counts toward `limit`, so one page can return multiple rows for the same actor. `ending_at` is required when `bucket_width` is set, and with `bucket_width="1m"` the range may span at most 24 hours. When omitted, each row aggregates the full `[starting_at, ending_at)` range.
One of the following:
"1d"
"1h"
"1m"
claude_tag_categories: optional array of [BetaAnalyticsClaudeTagCategory](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_claude_tag_category)
Filter to Claude Tag (Claude in Slack) usage in specific spend categories. Usage with no category never matches. `dm` usage is reported under the user's product rather than `claude-tag`, so combining this filter with `products[]=claude-tag` excludes it. Use `group_by[]=claude_tag_category` to break out per-category values.
maxItems100
One of the following:
"dm"
"engaged"
"monitoring"
"proactive"
"scheduled"
claude_tag_user_ids: optional array of string
Filter to Claude Tag (Claude in Slack) usage attributed to specific Slack users, by Slack user ID (for example `U0123ABCDEF`), not claude.ai user ID. Usage that is not Claude Tag, and Claude Tag usage not attributed to a single user, never matches. Use `group_by[]=claude_tag_user_id` to break out per-user values.
maxItems100
context_windows: optional array of [BetaAnalyticsContextWindow](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_context_window)
Filter to specific context-window pricing tiers. Use `group_by[]=context_window` to break out per-tier values.
maxItems100
One of the following:
"0-200k"
"200k-1M"
ending_at: optional string
End of range, exclusive. When omitted, defaults to the earlier of now and `starting_at` + 31 days. The range may span at most 31 days.
formatdate-time
exclude_deleted_users: optional boolean
If true, omit rows for users who are deleted (`deleted: true`). A page may contain fewer than `limit` rows; use `has_more` and `next_page` to paginate as usual.
defaultfalse
group_by: optional array of "claude_tag_category" or "claude_tag_user_id" or "context_window" or 6 more
Break each actor's row out by the given dimensions. Accepts the same values as the bucketed `/usage_report` endpoint. `limit` bounds (actor × time bucket × dimension) rows — with dimensions or `bucket_width` present, one actor may span several rows.
maxItems100
One of the following:
"claude_tag_category"
"claude_tag_user_id"
"context_window"
"inference_geo"
"model"
"product"
"rbac_group_id"
"slack_channel_id"
"speed"
inference_geos: optional array of [BetaAnalyticsInferenceGeoFilter](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_inference_geo_filter)
Filter to specific inference regions. `not_available` matches rows where the region is unset. Use `group_by[]=inference_geo` to break out per-region values.
maxItems100
One of the following:
"global"
"not_available"
"us"
limit: optional number
Number of rows per page (1-1000, default 20). One row per actor unless `group_by[]` or `bucket_width` splits an actor across rows; `cost_type`/`token_type` fan-out rows (cost endpoint only) are the exception — they do not count toward this limit, so `data` can exceed it.
default20
minimum1
maximum1000
models: optional array of string
Models to include. Defaults to all models. Use `group_by[]=model` to break out per-model values.
maxItems100
order: optional "asc" or "desc"
Sort direction. Defaults to `desc`.
defaultdesc
One of the following:
"asc"
"desc"
order_by: optional "output_tokens" or "requests" or "total_tokens" or "uncached_input_tokens"
Metric to rank actors by. Defaults to `total_tokens`.
defaulttotal_tokens
One of the following:
"output_tokens"
"requests"
"total_tokens"
"uncached_input_tokens"
page: optional string
Opaque cursor from a previous response's `next_page` field.
products: optional array of [BetaAnalyticsProductFilter](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_product_filter)
Product surfaces to include. Defaults to all products.
maxItems100
One of the following:
"chat"
"claude-tag"
"claude_code"
"claude_design"
"claude_in_chrome"
"cowork"
"office_agent"
rbac_group_ids: optional array of string
Filter to usage attributed to specific RBAC groups. Accepts tagged RBAC group IDs (`rbac_group_...`) or bare group UUIDs. A row matches when the user belonged to any of the listed groups on the (UTC) day the usage occurred; usage with no group attribution never matches.
maxItems100
slack_channel_ids: optional array of string
Filter to usage originating from specific Slack channels. Use `group_by[]=slack_channel_id` to break out per-channel values.
maxItems100
speeds: optional array of "fast" or "standard"
Filter to fast or standard inference mode. Use `group_by[]=speed` to break out per-mode values.
maxItems100
One of the following:
"fast"
"standard"
user_ids: optional array of string
Filter to specific users by tagged user ID.
maxItems100
##### Returns
data: array of [BetaAnalyticsUsageUsersItem](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_usage_users_item) { actor, cache_creation, cache_read_input_tokens, 16 more }
Rows for this page, ranked by `order_by` in the `order` direction. One row per user, or several per user when `group_by[]` or `bucket_width` breaks that user's usage or cost out across rows. Rows split out by `cost_type` or `token_type` (cost endpoint only) stay adjacent and are ranked as one unit.
actor: [BetaAnalyticsUserActor](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_user_actor) { type: "user_actor", deleted, email, 3 more }
The user this row's usage or cost is attributed to. Always a `user_actor`.
type: "user_actor"
Actor type. Always `"user_actor"`.
deleted: boolean
True when the account has been deleted, or when the user is no longer a member of the organization or its associated organizations (for example, their membership was removed or they were deprovisioned via your identity provider). `email_address` stays populated for removed users and is null when the account has been deleted. `name` follows the rules described on that field. The `user_id` is still populated for reconciliation.
email_address: string or null
The user's email address, including for users who are no longer members of the organization or its associated organizations. Null when the account has been deleted (check `deleted`) and for system-minted service accounts, which have no person's mailbox behind them (check `name`).
name: string or null
The user's full name. Null when the user has not set a name. Returns `"Deleted User"` when the account itself has been deleted, or when the user is no longer a member of the organization or its associated organizations and the organization has chosen to hide the names of removed users. Otherwise, the name stays populated for removed users. Rows for system-minted service accounts render the service name (for example, `"Claude Security"` for usage by Anthropic's security-patching service) or null.
user_id: string
Tagged user ID.
email: string or nullDeprecated
Deprecated: use `email_address`, which carries the same value.
cache_creation: [BetaCacheCreation](../Endpoints/platform-claude-com-http-beta-messages.md#beta_cache_creation) { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens }
The number of input tokens for cache creation.
ephemeral_1h_input_tokens: number
The number of input tokens used to create the 1 hour cache entry.
default0
minimum0
ephemeral_5m_input_tokens: number
The number of input tokens used to create the 5 minute cache entry.
default0
minimum0
cache_read_input_tokens: number
The number of input tokens read from the cache.
claude_tag_category: [BetaAnalyticsClaudeTagCategory](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_claude_tag_category) or null
Claude Tag (Claude in Slack) spend category: `engaged` (a person addressed Claude in a channel or thread), `proactive` (Claude responded without being addressed), `scheduled` (a scheduled routine ran), `monitoring` (Claude watching a channel it was asked to monitor), or `dm` (direct messages with Claude). Populated only when `claude_tag_category` is in `group_by[]`; null for usage that is not Claude Tag. Direct-message usage is billed to the individual user and is reported under that user's product, not under `claude-tag`. New categories may be added over time.
One of the following:
"dm"
"engaged"
"monitoring"
"proactive"
"scheduled"
claude_tag_user_id: string or null
Slack user ID (for example `U0123ABCDEF`) of the member the Claude Tag (Claude in Slack) usage is attributed to, not a claude.ai user ID. Populated only when `claude_tag_user_id` is in `group_by[]`; null for usage that is not Claude Tag and for Claude Tag usage that is not attributed to a single user (for example `monitoring`, and `proactive` usage Claude initiated), so per-user rows can sum to less than the Claude Tag total. Cannot be combined with `group_by[]=rbac_group_id` or the `rbac_group_ids[]` filter.
context_window: [BetaAnalyticsContextWindow](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_context_window) or null
Context-window pricing tier of the usage or cost. Null unless `context_window` is in `group_by[]`; it can also be null on grouped rows with no context-window tier, such as code execution.
One of the following:
"0-200k"
"200k-1M"
ending_at: string or null
End of the row's UTC time bucket (exclusive), as an RFC 3339 timestamp; equal to `starting_at` plus one `bucket_width`. Null unless `bucket_width` is set.
formatdate-time
inference_geo: "global" or "us" or null
Inference region of the usage or cost. Null unless `inference_geo` is in `group_by[]`; it can also be null on grouped rows where the region is not set (the rows that `inference_geos[]=not_available` matches).
One of the following:
"global"
"us"
model: string or null
Model that produced the usage or cost, as a model name in the form the `models[]` filter accepts (for example, `claude-opus-5`). Null unless `model` is in `group_by[]`; it can also be null on grouped rows whose usage or cost is not attributed to a specific model, such as code execution.
output_tokens: number
The number of output tokens generated.
product: string or null
Product surface that produced the usage or cost. Null unless product is in `group_by[]`; it can also be null on grouped rows whose usage cannot be attributed to a known surface. Values include `chat`, `claude_code`, `cowork`, `office_agent`, `claude_in_chrome`, `claude_design`, and `claude-tag`. `claude-tag` is Claude Tag, the Claude product in Slack. Some unattributed usage is reported as "other".
rbac_group_id: string or null
RBAC group (team) the usage is attributed to, in the public tagged `rbac_group_...` spelling — the same spelling the activity resources use for this key, so the same team has one id across resources and it round-trips as an `rbac_group_ids[]` filter value. Populated only when `rbac_group_id` is in `group_by[]`. Any-membership semantics: a user in several groups contributes their full usage to each of those groups' rows, so the named-group rows overlap and their sum can exceed the org total. A null value is the single unassigned row: users in no group on that (UTC) day. For the true org total, run the same query without `group_by[]`.
requests: number or null
Number of API requests in this row's scope. For sandbox / code-execution events, this counts execution spans rather than HTTP requests (these rows surface with `product: null`).
server_tool_use: [BetaAnalyticsServerToolUse](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_server_tool_use) { web_search_requests }
Server-side tool usage metrics.
web_search_requests: number
The number of web search requests made.
slack_channel_id: string or null
Slack channel the usage originated from. Populated only when `slack_channel_id` is in `group_by[]`; null for usage outside Slack (and for rows recorded before channel attribution was enabled).
speed: "fast" or "standard" or null
Inference speed mode of the usage or cost: `fast` or `standard`. Null unless `speed` is in `group_by[]`.
One of the following:
"fast"
"standard"
starting_at: string or null
Start of the row's UTC time bucket (inclusive), as an RFC 3339 timestamp. Null unless `bucket_width` is set; without `bucket_width`, each row aggregates the full requested range.
formatdate-time
total_tokens: number
Total token count across all token types. This is the value the default `order_by` (`total_tokens`) sorts on.
uncached_input_tokens: number
The number of uncached input tokens processed.
data_refreshed_at: string or null
RFC 3339 timestamp of the export this response was served from. Null when no export yet covers any part of the requested range, in which case `data` is empty. Data beyond this watermark is incomplete; for stable results, set `ending_at` to this value or earlier. Data is typically refreshed every 4 hours but not final until about 30 days after the usage date (late-arriving events, reconciliation adjustments).
formatdate-time
has_more: boolean
Whether another page is available. When true, pass `next_page` as the `page` parameter to fetch it.
next_page: string or null
Opaque cursor for the next page, or null when `has_more` is false. Pass it as the `page` parameter, keeping the other parameters unchanged. A cursor can expire after the underlying data refreshes; the request then returns HTTP 410 and pagination must restart from the first page.
organization_id: string
ID of the Organization.
Get Per-User Token Usage
cURL
```python
curl https://api.anthropic.com/v1/organizations/analytics/user_usage_report \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"data": [
{
"actor": {
"deleted": true,
"email": "jane@example.com",
"email_address": "jane@example.com",
"name": "Jane Smith",
"type": "user_actor",
"user_id": "user_01AbCdEfGhIjKlMnOpQrSt"
},
"cache_creation": {
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 0
},
"cache_read_input_tokens": 3200000,
"claude_tag_category": "dm",
"claude_tag_user_id": "U0123ABCDEF",
"context_window": "0-200k",
"ending_at": "2019-12-27T18:11:19.117Z",
"inference_geo": "global",
"model": "claude-opus-5",
"output_tokens": 891000,
"product": "chat",
"rbac_group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"requests": 128,
"server_tool_use": {
"web_search_requests": 10
},
"slack_channel_id": "C0123ABCDEF",
"speed": "fast",
"starting_at": "2019-12-27T18:11:19.117Z",
"total_tokens": 5377000,
"uncached_input_tokens": 1284500
}
],
"data_refreshed_at": "2019-12-27T18:11:19.117Z",
"has_more": true,
"next_page": "next_page",
"organization_id": "org_013FP9SaFPBg7Kw7fetjn6cF"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"actor": {
"deleted": true,
"email": "jane@example.com",
"email_address": "jane@example.com",
"name": "Jane Smith",
"type": "user_actor",
"user_id": "user_01AbCdEfGhIjKlMnOpQrSt"
},
"cache_creation": {
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 0
},
"cache_read_input_tokens": 3200000,
"claude_tag_category": "dm",
"claude_tag_user_id": "U0123ABCDEF",
"context_window": "0-200k",
"ending_at": "2019-12-27T18:11:19.117Z",
"inference_geo": "global",
"model": "claude-opus-5",
"output_tokens": 891000,
"product": "chat",
"rbac_group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"requests": 128,
"server_tool_use": {
"web_search_requests": 10
},
"slack_channel_id": "C0123ABCDEF",
"speed": "fast",
"starting_at": "2019-12-27T18:11:19.117Z",
"total_tokens": 5377000,
"uncached_input_tokens": 1284500
}
],
"data_refreshed_at": "2019-12-27T18:11:19.117Z",
"has_more": true,
"next_page": "next_page",
"organization_id": "org_013FP9SaFPBg7Kw7fetjn6cF"
---
## User Usage Report - Claude API Reference
Source: https://platform.claude.com/docs/en/api/http/beta/organization/analytics/user_usage_report
Path: 04-API-Reference/Admin/http-beta-organization-analytics-user-usage-report.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fhttp%2Fbeta%2Forganization%2Fanalytics%2Fuser_usage_report)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Summaries
Users
Apps
Connectors
Plugins
Skills
Artifacts
Usage Report
User Usage Report
Get Per-User Token Usage
Cost Report
User Cost Report
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Analytics](platform-claude-com-http-beta-organization-analytics.md)
# User Usage Report
##### [Get Per-User Token Usage](http-beta-organization-analytics-user-usage-report-list.md)
GET/v1/organizations/analytics/user_usage_report
Get per-user token usage across a date range.
---
## List User Activity - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/analytics/users/list
Path: 04-API-Reference/Admin/http-beta-organization-analytics-users-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fanalytics%2Fusers%2Flist)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Summaries
Users
List User Activity
Apps
Connectors
Plugins
Skills
Artifacts
Usage Report
User Usage Report
Cost Report
User Cost Report
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Analytics](platform-claude-com-http-beta-organization-analytics.md)
5. [Users](platform-claude-com-http-beta-organization-analytics-users.md)
# List User Activity
Copy page
cURL
GET/v1/organizations/analytics/users
Get per-user activity for a given day, with cursor-based pagination.
Returns activity metrics for each user in the organization, sorted by email address. Use `group_by[]` for per-RBAC-group aggregates, or `filter[]` to scope results to specific members, groups, or a chat project. Available to organizations on a Claude Enterprise plan. Requires an API key with the `read:analytics` scope.
##### Query parameters
date: optional string
UTC date in YYYY-MM-DD format. The day to get user activity for. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day) and may be revised by a few percent over the following days. No earlier than 2026-01-01.
formatdate
ending_date: optional string
UTC date in YYYY-MM-DD format. End of the date range (exclusive); only valid with `starting_date`. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day), so this can be at most today — which is also the default when omitted, resolved once when the first page is served and reused for the rest of the pagination sequence. At most 366 days after `starting_date`.
formatdate
filter: optional array of string
Filters as `dimension:value`, e.g. `filter[]=rbac_group_id:{id}`. Repeat the param for OR within a dimension and across dimensions for AND. Supported dimensions on this endpoint: `project_id`, `rbac_group_id`, `user_id`. Value forms: `project_id` takes a tagged project id (`claude_proj_...`); `rbac_group_id` takes the tagged id (`rbac_group_...`, as emitted in responses and by the spend-limits API) or a bare group UUID, and matches users who held the group at any point during each covered UTC day (time-of-usage attribution); `user_id` takes a tagged user id (`user_...`), as emitted in responses. An unsupported dimension returns 400. At most 100 entries. A `project_id` filter limits each member's row to their claude.ai chat activity in that project and cannot be combined with `group_by[]` or an `rbac_group_id` filter. On these rows, every count in `chat_cowork_unified_metrics.sessions` is 0, because sessions are not measured per project. On any day a member sent a chat message in Chat and Cowork unified, all of that member's project activity for the day is counted in `chat_cowork_unified_metrics.chat` instead of `chat_metrics`.
maxItems100
group_by: optional array of "rbac_group_id"
Dimensions to break results out by (e.g. `group_by[]=rbac_group_id`). Supported on this endpoint: `rbac_group_id`. Rows are already per-member, so the one supported grouping aggregates them per RBAC group instead. Grouped rows carry the requested dimension values as additional fields and paginate like ungrouped responses via `next_page`; an unsupported dimension returns 400. `rbac_group_id` attributes a user to every group they held at any point during each covered UTC day, so grouped rows are not an exclusive partition and can sum above org-level totals. At most 100 entries.
maxItems100
limit: optional number
Number of results per page (1-1000, default 100).
minimum1
maximum1000
order: optional "asc" or "desc"
Sort direction: `asc` or `desc`. Defaults to `asc` for the endpoint's sort column and to `desc` when `order_by` names a metric (a top-N ranking). Applies to `order_by`, or to the endpoint's default sort field when `order_by` is omitted.
One of the following:
"asc"
"desc"
order_by: optional string
Sort field. Restricted to the endpoint's sort column plus its rankable metrics (metrics default to descending; a few metrics rank in date-range mode only, per the endpoint's documented orderable set).
page: optional string
Opaque cursor from a previous response's `next_page` field.
starting_date: optional string
UTC date in YYYY-MM-DD format. Start of a date range (inclusive). Enables rollup mode: one row per entity aggregated over the whole range — addable counters are summed across days, and a distinct count is never summed where summing could double-count (a field's range value is recomputed exactly over the window, approximate via HLL with typical error under 2%, null, or — for the creation-event counts, whose per-day values cannot overlap — a per-day sum that is itself exact; each field's own description says which). Use either `date` or `starting_date`, not both. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day) and may be revised by a few percent over the following days. No earlier than 2026-01-01.
formatdate
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
##### Returns
data: array of [BetaAnalyticsUserActivity](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_user_activity) { chat_metrics, claude_code_metrics, cowork_metrics, 10 more }
chat_metrics: [BetaAnalyticsChatMetrics](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_chat_metrics) { connectors_used_count, distinct_artifacts_created_count, distinct_connectors_used_count, 9 more }
Claude.ai activity metrics for a single user on a given day.
claude_code_metrics: [BetaAnalyticsClaudeCodeMetrics](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_claude_code_metrics) { core_metrics, tool_actions }
Claude Code activity metrics for a single user on a given day.
cowork_metrics: [BetaAnalyticsCoworkMetrics](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_cowork_metrics) { action_count, artifacts_created_count, connectors_used_count, 14 more }
Cowork activity metrics for a single user on a given day.
design_metrics: [BetaAnalyticsDesignMetrics](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_design_metrics) { distinct_projects_created_count, distinct_projects_used_count, distinct_session_count, message_count }
Claude Design activity metrics for a single user on a given day.
distinct_projects_created_count: number
Number of distinct Claude Design projects created. Exact in date-range mode: a creation belongs to exactly one day, so the per-day counts never overlap and their sum over the window is the exact count of distinct creations in it.
distinct_projects_used_count: number or null
Number of distinct Claude Design projects the user worked in. Approximate (HLL, typical error \<2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.
distinct_session_count: number or null
Number of distinct Claude Design sessions. Approximate (HLL, typical error \<2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.
message_count: number
Number of messages sent in Claude Design sessions
office_metrics: [BetaAnalyticsOfficeMetrics](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_office_metrics) { excel, outlook, powerpoint, word }
Office Agent activity metrics for a single user on a given day, broken out by Office product.
science_metrics: [BetaAnalyticsScienceMetrics](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_science_metrics) { delegation_count, distinct_session_count, message_count, 2 more }
Claude Science activity metrics for a single user on a given day.
delegation_count: number
Number of delegations (handoffs to a specialized agent) in Claude Science sessions
distinct_session_count: number or null
Number of distinct Claude Science sessions. Approximate (HLL, typical error \<2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.
message_count: number
Number of messages sent in Claude Science sessions
remote_compute_job_count: number
Number of remote compute jobs launched from Claude Science sessions
skills_used_count: number
Total number of skill invocations in Claude Science sessions
web_search_count: number
Number of web searches performed
chat_cowork_unified_metrics: optional object{ chat, sessions } or null
Activity recorded while the member had Chat and Cowork unified (Cowork's features inside claude.ai chat) turned on, split into `chat` (chat activity) and `sessions` (Cowork activity). Omitted from the response on deployments that do not offer Chat and Cowork unified.
chat: [BetaAnalyticsChatCoworkUnifiedChatMetrics](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_chat_cowork_unified_chat_metrics) { connectors_used_count, distinct_artifacts_created_count, distinct_connectors_used_count, 9 more }
Chat activity recorded while members had Chat and Cowork unified turned on.
sessions: [BetaAnalyticsChatCoworkUnifiedSessionsMetrics](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_chat_cowork_unified_sessions_metrics) { action_count, artifacts_created_count, connectors_used_count, 14 more }
Cowork session activity recorded while members had Chat and Cowork unified turned on.
distinct_user_count: optional number or null
Number of distinct active users represented by this row. Only set for grouped rollups (`group_by[]`); null for per-user rows. In date-range mode, recomputed as an exact distinct count of the group's active members over the requested window, never a sum of per-day values.
last_activity_date: optional string or null
Most recent UTC day (YYYY-MM-DD) on which the user had any counted activity, within the requested window: equal to the requested `date` in single-day mode, and to the latest active day from `starting_date` (inclusive) to `ending_date` (exclusive) in date-range rollup mode — never a day earlier than the window start. On filtered requests (`filter[]`) only days matching the filter count: with `filter[]=rbac_group_id:{id}` it is the last day the user was active while a member of that group, consistent with the row's other metrics. On grouped (`group_by[]`) rows it is the latest day any member of the group was active (the requested `date` in single-day mode). Omitted from the response while last-activity reporting is not enabled for this organization.
formatdate
rbac_group_id: optional string or null
Tagged RBAC group identifier (`rbac_group_...`), matching the spend-limits API spelling. Present only when the request grouped by `rbac_group_id`.
rbac_group_name: optional string or null
Resolved RBAC group display name, alongside `rbac_group_id` when name resolution is available. Null if the group has been deleted or its name could not be resolved; `rbac_group_id` remains the stable key.
user: optional [BetaAnalyticsUser](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_user) { type: "user", id, email_address } or null
The user this row describes. Null on rows aggregated across users.
type: "user"
Object type. Always `user`.
defaultuser
id: string
Tagged user identifier (e.g. `user_...`)
email_address: string
Email address of the user
next_page: string or null
Opaque cursor for the next page, or null if no more results
List User Activity
cURL
```python
curl https://api.anthropic.com/v1/organizations/analytics/users \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"data": [
{
"chat_metrics": {
"connectors_used_count": 0,
"distinct_artifacts_created_count": 0,
"distinct_connectors_used_count": 0,
"distinct_conversation_count": 0,
"distinct_files_uploaded_count": 0,
"distinct_projects_created_count": 0,
"distinct_projects_used_count": 0,
"distinct_shared_artifacts_viewed_count": 0,
"distinct_skills_used_count": 0,
"message_count": 0,
"shared_conversations_viewed_count": 0,
"thinking_message_count": 0
},
"claude_code_metrics": {
"core_metrics": {
"artifacts_created_count": 0,
"commit_count": 0,
"distinct_session_count": 0,
"lines_of_code": {
"added_count": 0,
"removed_count": 0
},
"pull_request_count": 0
},
"tool_actions": {
"edit_tool": {
"accepted_count": 0,
"rejected_count": 0
},
"multi_edit_tool": {
"accepted_count": 0,
"rejected_count": 0
},
"notebook_edit_tool": {
"accepted_count": 0,
"rejected_count": 0
},
"write_tool": {
"accepted_count": 0,
"rejected_count": 0
}
}
},
"cowork_metrics": {
"action_count": 0,
"artifacts_created_count": 0,
"connectors_used_count": 0,
"dispatch_turn_count": 0,
"distinct_connectors_used_count": 0,
"distinct_session_count": 0,
"distinct_skills_used_count": 0,
"message_count": 0,
"skills_used_count": 0,
"distinct_plugins_used_count": 0,
"edit_tool_count": 0,
"file_edit_count": 0,
"multi_edit_tool_count": 0,
"notebook_edit_tool_count": 0,
"plugins_used_count": 0,
"sessions_with_file_edits_count": 0,
"write_tool_count": 0
},
"design_metrics": {
"distinct_projects_created_count": 0,
"distinct_projects_used_count": 0,
"distinct_session_count": 0,
"message_count": 0
},
"office_metrics": {
"excel": {
"connectors_used_count": 0,
"distinct_connectors_used_count": 0,
"distinct_session_count": 0,
"distinct_skills_used_count": 0,
"message_count": 0,
"skills_used_count": 0
},
"outlook": {
"connectors_used_count": 0,
"distinct_connectors_used_count": 0,
"distinct_session_count": 0,
"distinct_skills_used_count": 0,
"message_count": 0,
"skills_used_count": 0
},
"powerpoint": {
"connectors_used_count": 0,
"distinct_connectors_used_count": 0,
"distinct_session_count": 0,
"distinct_skills_used_count": 0,
"message_count": 0,
"skills_used_count": 0
},
"word": {
"connectors_used_count": 0,
"distinct_connectors_used_count": 0,
"distinct_session_count": 0,
"distinct_skills_used_count": 0,
"message_count": 0,
"skills_used_count": 0
}
},
"science_metrics": {
"delegation_count": 0,
"distinct_session_count": 0,
"message_count": 0,
"remote_compute_job_count": 0,
"skills_used_count": 0
},
"web_search_count": 0,
"chat_cowork_unified_metrics": {
"chat": {
"connectors_used_count": 0,
"distinct_artifacts_created_count": 0,
"distinct_connectors_used_count": 0,
"distinct_conversation_count": 0,
"distinct_files_uploaded_count": 0,
"distinct_projects_created_count": 0,
"distinct_projects_used_count": 0,
"distinct_shared_artifacts_viewed_count": 0,
"distinct_skills_used_count": 0,
"message_count": 0,
"shared_conversations_viewed_count": 0,
"thinking_message_count": 0
},
"sessions": {
"action_count": 0,
"artifacts_created_count": 0,
"connectors_used_count": 0,
"dispatch_turn_count": 0,
"distinct_connectors_used_count": 0,
"distinct_plugins_used_count": 0,
"distinct_session_count": 0,
"distinct_skills_used_count": 0,
"edit_tool_count": 0,
"file_edit_count": 0,
"message_count": 0,
"multi_edit_tool_count": 0,
"notebook_edit_tool_count": 0,
"plugins_used_count": 0,
"sessions_with_file_edits_count": 0,
"skills_used_count": 0,
"write_tool_count": 0
}
},
"distinct_user_count": 0,
"last_activity_date": "2019-12-27",
"rbac_group_id": "rbac_group_id",
"rbac_group_name": "rbac_group_name",
"user": {
"id": "id",
"email_address": "email_address",
"type": "user"
}
}
],
"next_page": "next_page"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"chat_metrics": {
"connectors_used_count": 0,
"distinct_artifacts_created_count": 0,
"distinct_connectors_used_count": 0,
"distinct_conversation_count": 0,
"distinct_files_uploaded_count": 0,
"distinct_projects_created_count": 0,
"distinct_projects_used_count": 0,
"distinct_shared_artifacts_viewed_count": 0,
"distinct_skills_used_count": 0,
"message_count": 0,
"shared_conversations_viewed_count": 0,
"thinking_message_count": 0
},
"claude_code_metrics": {
"core_metrics": {
"artifacts_created_count": 0,
"commit_count": 0,
"distinct_session_count": 0,
"lines_of_code": {
"added_count": 0,
"removed_count": 0
},
"pull_request_count": 0
},
"tool_actions": {
"edit_tool": {
"accepted_count": 0,
"rejected_count": 0
},
"multi_edit_tool": {
"accepted_count": 0,
"rejected_count": 0
},
"notebook_edit_tool": {
"accepted_count": 0,
"rejected_count": 0
},
"write_tool": {
"accepted_count": 0,
"rejected_count": 0
}
}
},
"cowork_metrics": {
"action_count": 0,
"artifacts_created_count": 0,
"connectors_used_count": 0,
"dispatch_turn_count": 0,
"distinct_connectors_used_count": 0,
"distinct_session_count": 0,
"distinct_skills_used_count": 0,
"message_count": 0,
"skills_used_count": 0,
"distinct_plugins_used_count": 0,
"edit_tool_count": 0,
"file_edit_count": 0,
"multi_edit_tool_count": 0,
"notebook_edit_tool_count": 0,
"plugins_used_count": 0,
"sessions_with_file_edits_count": 0,
"write_tool_count": 0
},
"design_metrics": {
"distinct_projects_created_count": 0,
"distinct_projects_used_count": 0,
"distinct_session_count": 0,
"message_count": 0
},
"office_metrics": {
"excel": {
"connectors_used_count": 0,
"distinct_connectors_used_count": 0,
"distinct_session_count": 0,
"distinct_skills_used_count": 0,
"message_count": 0,
"skills_used_count": 0
},
"outlook": {
"connectors_used_count": 0,
"distinct_connectors_used_count": 0,
"distinct_session_count": 0,
"distinct_skills_used_count": 0,
"message_count": 0,
"skills_used_count": 0
},
"powerpoint": {
"connectors_used_count": 0,
"distinct_connectors_used_count": 0,
"distinct_session_count": 0,
"distinct_skills_used_count": 0,
"message_count": 0,
"skills_used_count": 0
},
"word": {
"connectors_used_count": 0,
"distinct_connectors_used_count": 0,
"distinct_session_count": 0,
"distinct_skills_used_count": 0,
"message_count": 0,
"skills_used_count": 0
}
},
"science_metrics": {
"delegation_count": 0,
"distinct_session_count": 0,
"message_count": 0,
"remote_compute_job_count": 0,
"skills_used_count": 0
},
"web_search_count": 0,
"chat_cowork_unified_metrics": {
"chat": {
"connectors_used_count": 0,
"distinct_artifacts_created_count": 0,
"distinct_connectors_used_count": 0,
"distinct_conversation_count": 0,
"distinct_files_uploaded_count": 0,
"distinct_projects_created_count": 0,
"distinct_projects_used_count": 0,
"distinct_shared_artifacts_viewed_count": 0,
"distinct_skills_used_count": 0,
"message_count": 0,
"shared_conversations_viewed_count": 0,
"thinking_message_count": 0
},
"sessions": {
"action_count": 0,
"artifacts_created_count": 0,
"connectors_used_count": 0,
"dispatch_turn_count": 0,
"distinct_connectors_used_count": 0,
"distinct_plugins_used_count": 0,
"distinct_session_count": 0,
"distinct_skills_used_count": 0,
"edit_tool_count": 0,
"file_edit_count": 0,
"message_count": 0,
"multi_edit_tool_count": 0,
"notebook_edit_tool_count": 0,
"plugins_used_count": 0,
"sessions_with_file_edits_count": 0,
"skills_used_count": 0,
"write_tool_count": 0
}
},
"distinct_user_count": 0,
"last_activity_date": "2019-12-27",
"rbac_group_id": "rbac_group_id",
"rbac_group_name": "rbac_group_name",
"user": {
"id": "id",
"email_address": "email_address",
---
## Users - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/analytics/users
Path: 04-API-Reference/Admin/http-beta-organization-analytics-users.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fanalytics%2Fusers)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Summaries
Users
List User Activity
Apps
Connectors
Plugins
Skills
Artifacts
Usage Report
User Usage Report
Cost Report
User Cost Report
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Analytics](platform-claude-com-http-beta-organization-analytics.md)
# Users
Copy page
cURL
##### [List User Activity](platform-claude-com-http-beta-organization-analytics-users-list.md)
GET/v1/organizations/analytics/users
Get per-user activity for a given day, with cursor-based pagination.
---
## Analytics - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/analytics
Path: 04-API-Reference/Admin/http-beta-organization-analytics.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fanalytics)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Summaries
Users
Apps
Connectors
Plugins
Skills
Artifacts
Usage Report
User Usage Report
Cost Report
User Cost Report
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
# Analytics
Copy page
cURL
##### Models
BetaAnalyticsArtifactActivity object{ artifact_type, artifacts_created_count, distinct_user_count, 6 more }
Artifact-creation activity for one (`artifact_type`, `is_shared`) bucket on a given day.
Artifacts form a small finite cube — the canonical MIME type (8 values incl. `other`) crossed with shared-vs-private — so the response is the full set of non-empty buckets, not a ranked/paginated list. Claude Code and Cowork artifacts report under `text/html` and are counted from 2026-08-17 onward; earlier days contain claude.ai chat artifacts only. With `group_by[]=product` / `user_id` / `rbac_group_id` each row is further split by the flat group keys and counts are scoped to that cut.
BetaAnalyticsChatCoworkUnifiedChatMetrics object{ connectors_used_count, distinct_artifacts_created_count, distinct_connectors_used_count, 9 more }
Chat activity recorded while members had Chat and Cowork unified turned on.
BetaAnalyticsChatCoworkUnifiedSessionsMetrics object{ action_count, artifacts_created_count, connectors_used_count, 14 more }
Cowork session activity recorded while members had Chat and Cowork unified turned on.
BetaAnalyticsChatMetrics object{ connectors_used_count, distinct_artifacts_created_count, distinct_connectors_used_count, 9 more }
Claude.ai activity metrics for a single user on a given day.
BetaAnalyticsClaudeCodeMetrics object{ core_metrics, tool_actions }
Claude Code activity metrics for a single user on a given day.
BetaAnalyticsClaudeTagCategory = "dm" or "engaged" or "monitoring" or 2 more
One of the following:
"dm"
"engaged"
"monitoring"
"proactive"
"scheduled"
BetaAnalyticsConnectorActivity object{ chat_metrics, claude_code_metrics, connector_name, 14 more }
Per-connector activity data for a given day.
BetaAnalyticsConnectorChatCoworkUnifiedChatMetrics object{ distinct_conversation_connector_used_count }
A connector's use in chat conversations recorded while members had Chat and Cowork unified turned on.
distinct_conversation_connector_used_count: number or null
Same measure as `chat_metrics.distinct_conversation_connector_used_count`, for activity recorded while members had Chat and Cowork unified turned on. Approximate (HLL, typical error \<2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.
BetaAnalyticsConnectorChatCoworkUnifiedSessionsMetrics object{ distinct_session_connector_used_count }
A connector's use in Cowork sessions recorded while members had Chat and Cowork unified turned on.
distinct_session_connector_used_count: number or null
Same measure as `cowork_metrics.distinct_session_connector_used_count`, for activity recorded while members had Chat and Cowork unified turned on. Approximate (HLL, typical error \<2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.
BetaAnalyticsConnectorChatMetrics object{ distinct_conversation_connector_used_count }
Claude.ai activity metrics for a single connector on a given day.
distinct_conversation_connector_used_count: number or null
Number of distinct conversations in which the connector was used. Approximate (HLL, typical error \<2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.
BetaAnalyticsConnectorClaudeCodeMetrics object{ distinct_session_connector_used_count }
Claude Code activity metrics for a single connector on a given day.
distinct_session_connector_used_count: number or null
Number of distinct Claude Code sessions in which the connector was used. Approximate (HLL, typical error \<2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.
BetaAnalyticsConnectorCoworkMetrics object{ distinct_session_connector_used_count }
Cowork activity metrics for a single connector on a given day.
distinct_session_connector_used_count: number or null
Number of distinct Cowork sessions in which the connector was used. Approximate (HLL, typical error \<2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.
BetaAnalyticsConnectorOfficeMetrics object{ excel, outlook, powerpoint, word }
Office Agent activity metrics for a single connector on a given day, broken out by Office product.
BetaAnalyticsConnectorOfficeProductMetrics object{ distinct_session_connector_used_count }
Office Agent activity metrics for a single connector on a given day within one Office product.
distinct_session_connector_used_count: number or null
Number of distinct Office Agent sessions in which the connector was used. Approximate (HLL, typical error \<2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.
BetaAnalyticsContextWindow = "0-200k" or "200k-1M"
One of the following:
"0-200k"
"200k-1M"
BetaAnalyticsCoreCodeMetrics object{ artifacts_created_count, commit_count, distinct_session_count, 2 more }
Core Claude Code activity metrics for a single user on a given day.
artifacts_created_count: number
Number of artifacts created in Claude Code sessions: an artifact counts once, on the day a session first saves it. Counted from 2026-08-17; 0 on earlier days. Exact in date-range mode: a creation belongs to exactly one day, so the per-day counts never overlap and their sum over the window is the exact count of distinct creations in it.
commit_count: number
Number of commits made via Claude Code
distinct_session_count: number or null
Number of distinct Claude Code sessions. On aggregated rows and in date-range mode: summed per-day distinct counts. A session essentially never spans a UTC day, so the sum is in practice the true distinct count.
lines_of_code: [BetaAnalyticsLinesOfCode](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_lines_of_code) { added_count, removed_count }
Lines of code added and removed via Claude Code.
added_count: number
Lines of code added
removed_count: number
Lines of code removed
pull_request_count: number
Number of pull requests created via Claude Code
BetaAnalyticsCostBucketedResult object{ amount, claude_tag_category, claude_tag_user_id, 12 more }
BetaAnalyticsCostReportTimeBucket object{ ending_at, results, starting_at }
BetaAnalyticsCostType = "code_execution" or "tokens" or "web_search"
One of the following:
"code_execution"
"tokens"
"web_search"
BetaAnalyticsCostUsersItem object{ actor, amount, claude_tag_category, 15 more }
BetaAnalyticsCoworkMetrics object{ action_count, artifacts_created_count, connectors_used_count, 14 more }
Cowork activity metrics for a single user on a given day.
BetaAnalyticsDesignMetrics object{ distinct_projects_created_count, distinct_projects_used_count, distinct_session_count, message_count }
Claude Design activity metrics for a single user on a given day.
distinct_projects_created_count: number
Number of distinct Claude Design projects created. Exact in date-range mode: a creation belongs to exactly one day, so the per-day counts never overlap and their sum over the window is the exact count of distinct creations in it.
distinct_projects_used_count: number or null
Number of distinct Claude Design projects the user worked in. Approximate (HLL, typical error \<2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.
distinct_session_count: number or null
Number of distinct Claude Design sessions. Approximate (HLL, typical error \<2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.
message_count: number
Number of messages sent in Claude Design sessions
BetaAnalyticsInferenceGeoFilter = "global" or "not_available" or "us"
One of the following:
"global"
"not_available"
"us"
BetaAnalyticsLinesOfCode object{ added_count, removed_count }
Lines of code added and removed via Claude Code.
added_count: number
Lines of code added
removed_count: number
Lines of code removed
BetaAnalyticsOfficeMetrics object{ excel, outlook, powerpoint, word }
Office Agent activity metrics for a single user on a given day, broken out by Office product.
BetaAnalyticsOfficeProductMetrics object{ connectors_used_count, distinct_connectors_used_count, distinct_session_count, 3 more }
Office Agent activity metrics for a single user on a given day within one Office product.
connectors_used_count: number
Number of MCP connector invocations
distinct_connectors_used_count: number or null
Number of distinct MCP connectors used. Approximate (HLL, typical error \<2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.
distinct_session_count: number or null
Number of distinct Office Agent sessions. Approximate (HLL, typical error \<2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.
distinct_skills_used_count: number or null
Number of distinct skills used. Approximate (HLL, typical error \<2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.
message_count: number
Number of messages sent
skills_used_count: number
Number of skill invocations
BetaAnalyticsPluginActivity object{ claude_code_metrics, cowork_metrics, distinct_user_count, 9 more }
Per-plugin install + invocation activity for a given day.
With `group_by[]=user_id` / `rbac_group_id` / `product` (`cowork`, `claude_code` and `chat_cowork_unified` only on this endpoint) each row is one (plugin, user), (plugin, group), or (plugin, product) cut: the flat `user_id` / `rbac_group_id` / `product` keys carry the cut and the counts are scoped to it.
BetaAnalyticsPluginClaudeCodeMetrics object{ distinct_session_plugin_used_count }
Claude Code activity metrics for a single plugin on a given day.
distinct_session_plugin_used_count: number or null
Number of distinct Claude Code sessions in which the plugin was invoked. Null on aggregated rows where a distinct count cannot be computed.
BetaAnalyticsPluginCoworkMetrics object{ distinct_session_plugin_used_count }
Cowork activity metrics for a single plugin on a given day.
distinct_session_plugin_used_count: number or null
Number of distinct Cowork sessions in which the plugin was invoked. Null on aggregated rows where a distinct count cannot be computed.
BetaAnalyticsProductFilter = "chat" or "chat_cowork_unified" or "claude-tag" or 5 more
Publicly documented product surfaces. `claude-tag` is Claude Tag, the Claude product in Slack. `chat_cowork_unified` is Chat and Cowork unified, Cowork's features inside claude.ai chat: chat and Cowork usage by a member who has it turned on is reported under this value instead of `chat` or `cowork`. It is accepted as a filter only on deployments that offer Chat and Cowork unified.
One of the following:
"chat"
"chat_cowork_unified"
"claude-tag"
"claude_code"
"claude_design"
"claude_in_chrome"
"cowork"
"office_agent"
BetaAnalyticsProjectActivity object{ distinct_user_count, message_count, project_id, 8 more }
Per-project activity data for a given day.
BetaAnalyticsScienceMetrics object{ delegation_count, distinct_session_count, message_count, 2 more }
Claude Science activity metrics for a single user on a given day.
delegation_count: number
Number of delegations (handoffs to a specialized agent) in Claude Science sessions
distinct_session_count: number or null
Number of distinct Claude Science sessions. Approximate (HLL, typical error \<2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.
message_count: number
Number of messages sent in Claude Science sessions
remote_compute_job_count: number
Number of remote compute jobs launched from Claude Science sessions
skills_used_count: number
Total number of skill invocations in Claude Science sessions
BetaAnalyticsServerToolUse object{ web_search_requests }
web_search_requests: number
The number of web search requests made.
BetaAnalyticsSingleDayActivitySummary object{ assigned_seat_count, cowork_daily_active_user_count, cowork_monthly_active_user_count, 29 more }
Per-day entry in the /summaries response.
BetaAnalyticsSkillActivity object{ chat_metrics, claude_code_metrics, cowork_metrics, 15 more }
Per-skill activity data for a given day.
BetaAnalyticsSkillChatCoworkUnifiedChatMetrics object{ distinct_conversation_skill_used_count }
A skill's use in chat conversations recorded while members had Chat and Cowork unified turned on.
distinct_conversation_skill_used_count: number or null
Same measure as `chat_metrics.distinct_conversation_skill_used_count`, for activity recorded while members had Chat and Cowork unified turned on. Approximate (HLL, typical error \<2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.
BetaAnalyticsSkillChatCoworkUnifiedSessionsMetrics object{ distinct_session_skill_used_count }
A skill's use in Cowork sessions recorded while members had Chat and Cowork unified turned on.
distinct_session_skill_used_count: number or null
Same measure as `cowork_metrics.distinct_session_skill_used_count`, for activity recorded while members had Chat and Cowork unified turned on. Approximate (HLL, typical error \<2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.
BetaAnalyticsSkillChatMetrics object{ distinct_conversation_skill_used_count }
Claude.ai activity metrics for a single skill on a given day.
distinct_conversation_skill_used_count: number or null
Number of distinct conversations in which the skill was used. A skill counts as used only when it is explicitly activated — the model (or the user, via the skill's slash command) invokes it, reading its instructions into context as part of that activation. Skills that are merely installed or listed as available, or whose content reaches the context without an activation (preloaded, hook-injected, or read as a plain file), are not counted. Approximate (HLL, typical error \<2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.
BetaAnalyticsSkillClaudeCodeMetrics object{ distinct_session_skill_used_count }
Claude Code activity metrics for a single skill on a given day.
distinct_session_skill_used_count: number or null
Number of distinct Claude Code sessions in which the skill was used. A skill counts as used only when it is explicitly activated — the model (or the user, via the skill's slash command) invokes it, reading its instructions into context as part of that activation. Skills that are merely installed or listed as available, or whose content reaches the context without an activation (preloaded, hook-injected, or read as a plain file), are not counted. Approximate (HLL, typical error \<2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.
BetaAnalyticsSkillCoworkMetrics object{ distinct_session_skill_used_count }
Cowork activity metrics for a single skill on a given day.
distinct_session_skill_used_count: number or null
Number of distinct Cowork sessions in which the skill was used. A skill counts as used only when it is explicitly activated — the model (or the user, via the skill's slash command) invokes it, reading its instructions into context as part of that activation. Skills that are merely installed or listed as available, or whose content reaches the context without an activation (preloaded, hook-injected, or read as a plain file), are not counted. Approximate (HLL, typical error \<2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.
BetaAnalyticsSkillOfficeMetrics object{ excel, outlook, powerpoint, word }
Office Agent activity metrics for a single skill on a given day, broken out by Office product.
BetaAnalyticsSkillOfficeProductMetrics object{ distinct_session_skill_used_count }
Office Agent activity metrics for a single skill on a given day within one Office product.
distinct_session_skill_used_count: number or null
Number of distinct Office Agent sessions in which the skill was used. A skill counts as used only when it is explicitly activated — the model (or the user, via the skill's slash command) invokes it, reading its instructions into context as part of that activation. Skills that are merely installed or listed as available, or whose content reaches the context without an activation (preloaded, hook-injected, or read as a plain file), are not counted. Approximate (HLL, typical error \<2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.
BetaAnalyticsTokenType = "cache_creation.ephemeral_1h_input_tokens" or "cache_creation.ephemeral_5m_input_tokens" or "cache_read_input_tokens" or 2 more
One of the following:
"cache_creation.ephemeral_1h_input_tokens"
"cache_creation.ephemeral_5m_input_tokens"
"cache_read_input_tokens"
"output_tokens"
"uncached_input_tokens"
BetaAnalyticsToolActionCounts object{ accepted_count, rejected_count }
Accepted/rejected counts for a single Claude Code tool type.
accepted_count: number
Number of tool proposals accepted
rejected_count: number
Number of tool proposals rejected
BetaAnalyticsToolActions object{ edit_tool, multi_edit_tool, notebook_edit_tool, write_tool }
Per-tool accepted/rejected counts for Claude Code file modification tools.
BetaAnalyticsUsageBucketedResult object{ cache_creation, cache_read_input_tokens, claude_tag_category, 12 more }
BetaAnalyticsUsageReportTimeBucket object{ ending_at, results, starting_at }
BetaAnalyticsUsageUsersItem object{ actor, cache_creation, cache_read_input_tokens, 16 more }
BetaAnalyticsUser object{ type: "user", id, email_address }
A user in the organization, identified by tagged id and email address.
type: "user"
Object type. Always `user`.
defaultuser
id: string
Tagged user identifier (e.g. `user_...`)
email_address: string
Email address of the user
BetaAnalyticsUserActivity object{ chat_metrics, claude_code_metrics, cowork_metrics, 10 more }
Per-user activity data for a given day.
BetaAnalyticsUserActor object{ type: "user_actor", deleted, email, 3 more }
type: "user_actor"
Actor type. Always `"user_actor"`.
deleted: boolean
True when the account has been deleted, or when the user is no longer a member of the organization or its associated organizations (for example, their membership was removed or they were deprovisioned via your identity provider). `email_address` stays populated for removed users and is null when the account has been deleted. `name` follows the rules described on that field. The `user_id` is still populated for reconciliation.
email_address: string or null
The user's email address, including for users who are no longer members of the organization or its associated organizations. Null when the account has been deleted (check `deleted`) and for system-minted service accounts, which have no person's mailbox behind them (check `name`).
name: string or null
The user's full name. Null when the user has not set a name. Returns `"Deleted User"` when the account itself has been deleted, or when the user is no longer a member of the organization or its associated organizations and the organization has chosen to hide the names of removed users. Otherwise, the name stays populated for removed users. Rows for system-minted service accounts render the service name (for example, `"Claude Security"` for usage by Anthropic's security-patching service) or null.
user_id: string
Tagged user ID.
email: string or nullDeprecated
Deprecated: use `email_address`, which carries the same value.
#### Analytics[Summaries](http-beta-organization-analytics-summaries.md)
##### [Get Activity Summaries](http-beta-organization-analytics-summaries-list.md)
GET/v1/organizations/analytics/summaries
Get organization-wide activity summaries for a date range.
#### Analytics[Users](platform-claude-com-http-beta-organization-analytics-users.md)
##### [List User Activity](platform-claude-com-http-beta-organization-analytics-users-list.md)
GET/v1/organizations/analytics/users
Get per-user activity for a given day, with cursor-based pagination.
#### AnalyticsAppsChat[Projects](http-beta-organization-analytics-apps-chat-projects.md)
##### [Get Chat Project Usage](http-beta-organization-analytics-apps-chat-projects-list.md)
GET/v1/organizations/analytics/apps/chat/projects
Get per-project activity for a given day, with cursor-based pagination.
#### Analytics[Connectors](http-beta-organization-analytics-connectors.md)
##### [Get Connector Usage](platform-claude-com-http-beta-organization-analytics-connectors-list.md)
GET/v1/organizations/analytics/connectors
Get per-connector usage for a given day, with cursor-based pagination.
#### Analytics[Plugins](platform-claude-com-http-beta-organization-analytics-plugins.md)
##### [Get Plugin Usage](platform-claude-com-http-beta-organization-analytics-plugins-list.md)
GET/v1/organizations/analytics/plugins
Get per-plugin install + invocation usage for a given day, with pagination.
#### Analytics[Skills](http-beta-organization-analytics-skills.md)
##### [Get Skill Usage](platform-claude-com-http-beta-organization-analytics-skills-list.md)
GET/v1/organizations/analytics/skills
Get per-skill usage for a given day, with cursor-based pagination.
#### Analytics[Artifacts](http-beta-organization-analytics-artifacts.md)
##### [Get Artifact Activity](platform-claude-com-http-beta-organization-analytics-artifacts-list.md)
GET/v1/organizations/analytics/artifacts
Get artifact-creation activity for a given day, broken out by MIME type.
#### Analytics[Usage Report](http-beta-organization-analytics-usage-report.md)
##### [Get Token Usage Over Time](http-beta-organization-analytics-usage-report-list.md)
GET/v1/organizations/analytics/usage_report
Get token usage over time across a date range.
#### Analytics[User Usage Report](http-beta-organization-analytics-user-usage-report.md)
##### [Get Per-User Token Usage](http-beta-organization-analytics-user-usage-report-list.md)
GET/v1/organizations/analytics/user_usage_report
Get per-user token usage across a date range.
#### Analytics[Cost Report](http-beta-organization-analytics-cost-report.md)
##### [Get Cost Over Time](http-beta-organization-analytics-cost-report-list.md)
GET/v1/organizations/analytics/cost_report
Get cost in USD over time across a date range.
#### Analytics[User Cost Report](http-beta-organization-analytics-user-cost-report.md)
##### [Get Per-User Cost](http-beta-organization-analytics-user-cost-report-list.md)
GET/v1/organizations/analytics/user_cost_report
Get per-user cost in USD across a date range.
---
## Get Current Organization - Claude API Reference
Source: https://platform.claude.com/docs/en/api/http/beta/organization/retrieve
Path: 04-API-Reference/Admin/http-beta-organization-retrieve.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fhttp%2Fbeta%2Forganization%2Fretrieve)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
# Get Current Organization
GET/v1/organizations/me
Retrieve information about the organization associated with the authenticated API key.
##### Returns
BetaOrganization object{ type: "organization", id, name }
type: "organization"
Object type.
For Organizations, this is always `"organization"`.
defaultorganization
id: string
ID of the Organization.
formatuuid
name: string
Name of the Organization.
Get Current Organization
cURL
```python
curl https://api.anthropic.com/v1/organizations/me \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"id": "12345678-1234-5678-1234-567812345678",
"name": "Organization Name",
"type": "organization"
}
```
##### Returns Examples
Response 200
```python
{
"id": "12345678-1234-5678-1234-567812345678",
---
## Organization - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization
Path: 04-API-Reference/Admin/http-beta-organization.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
# Organization
Copy page
cURL
##### [Get Current Organization](http-beta-organization-retrieve.md)
GET/v1/organizations/me
Retrieve information about the organization associated with the authenticated API key.
##### Models
BetaOrganization object{ type: "organization", id, name }
type: "organization"
Object type.
For Organizations, this is always `"organization"`.
defaultorganization
id: string
ID of the Organization.
formatuuid
name: string
Name of the Organization.
BetaOrganizationRole = "admin" or "billing" or "claude_code_user" or 6 more
One of the following:
"admin"
"billing"
"claude_code_user"
"developer"
"managed"
"membership_admin"
"owner"
"primary_owner"
"user"
#### Organization[API Keys](https://platform.claude.com/docs/en/api/http/beta/organization/api_keys)
##### [List API Keys](https://platform.claude.com/docs/en/api/http/beta/organization/api_keys/list)
GET/v1/organizations/api_keys
##### [Retrieve API Key (Admin API)](https://platform.claude.com/docs/en/api/http/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](../Other/playground.md) in the Claude Console.
##### [Update API Key](https://platform.claude.com/docs/en/api/http/beta/organization/api_keys/update)
POST/v1/organizations/api_keys/{api_key_id}
#### Organization[External Keys](https://platform.claude.com/docs/en/api/http/beta/organization/external_keys)
##### [Create External Key](https://platform.claude.com/docs/en/api/http/beta/organization/external_keys/create)
POST/v1/organizations/external_keys
Create an external key config owned by the caller's organization.
##### [List External Keys](https://platform.claude.com/docs/en/api/http/beta/organization/external_keys/list)
GET/v1/organizations/external_keys
List external key configs in the caller's organization.
##### [Get External Key](https://platform.claude.com/docs/en/api/http/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](https://platform.claude.com/docs/en/api/http/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](https://platform.claude.com/docs/en/api/http/beta/organization/external_keys/delete)
DELETE/v1/organizations/external_keys/{external_key_id}
Delete an external key config.
##### [Validate External Key](https://platform.claude.com/docs/en/api/http/beta/organization/external_keys/validate)
POST/v1/organizations/external_keys/{external_key_id}/validate
Validate an external key config against the customer's KMS.
#### OrganizationFederation[Issuers](https://platform.claude.com/docs/en/api/http/beta/organization/federation/issuers)
##### [Create Federation Issuer](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [List Federation Issuers](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [Get Federation Issuer](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [Update Federation Issuer](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [Archive Federation Issuer](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
#### OrganizationFederation[Rules](https://platform.claude.com/docs/en/api/http/beta/organization/federation/rules)
##### [Create Federation Rule](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [List Federation Rules](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [Get Federation Rule](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [Update Federation Rule](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [Archive Federation Rule](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
#### OrganizationFederationRules[Workspaces](https://platform.claude.com/docs/en/api/http/beta/organization/federation/rules/workspaces)
##### [Add Federation Rule Workspace](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [List Federation Rule Workspaces](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [Remove Federation Rule Workspace](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
#### Organization[Invites](https://platform.claude.com/docs/en/api/http/beta/organization/invites)
##### [Create Invite](https://platform.claude.com/docs/en/api/http/beta/organization/invites/create)
POST/v1/organizations/invites
Invite a user to join the organization by email.
##### [List Invites](https://platform.claude.com/docs/en/api/http/beta/organization/invites/list)
GET/v1/organizations/invites
List the organization's invites.
##### [Get Invite](https://platform.claude.com/docs/en/api/http/beta/organization/invites/retrieve)
GET/v1/organizations/invites/{invite_id}
Retrieve an invite by ID.
##### [Delete Invite](https://platform.claude.com/docs/en/api/http/beta/organization/invites/delete)
DELETE/v1/organizations/invites/{invite_id}
Delete a pending invite.
#### Organization[Service Accounts](https://platform.claude.com/docs/en/api/http/beta/organization/service_accounts)
##### [Create Service Account](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [List Service Accounts](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [Get Service Account](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [Update Service Account](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [Archive Service Account](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
#### OrganizationService Accounts[Workspaces](https://platform.claude.com/docs/en/api/http/beta/organization/service_accounts/workspaces)
##### [Add Workspace To Service Account](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [List Workspaces For Service Account](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [Remove Workspace From Service Account](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
#### Organization[Users](https://platform.claude.com/docs/en/api/http/beta/organization/users)
##### [List Users](https://platform.claude.com/docs/en/api/http/beta/organization/users/list)
GET/v1/organizations/users
List the organization's members.
##### [Get User](https://platform.claude.com/docs/en/api/http/beta/organization/users/retrieve)
GET/v1/organizations/users/{user_id}
Retrieve a member of the organization by user ID.
##### [Update User](https://platform.claude.com/docs/en/api/http/beta/organization/users/update)
POST/v1/organizations/users/{user_id}
Update a member's organization role.
##### [Remove User](https://platform.claude.com/docs/en/api/http/beta/organization/users/remove)
DELETE/v1/organizations/users/{user_id}
Remove a member from the organization.
#### Organization[Workspaces](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces)
##### [List Workspaces](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces/list)
GET/v1/organizations/workspaces
##### [Create Workspace](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces/create)
POST/v1/organizations/workspaces
##### [Get Workspace](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces/retrieve)
GET/v1/organizations/workspaces/{workspace_id}
##### [Update Workspace](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces/update)
POST/v1/organizations/workspaces/{workspace_id}
##### [Archive Workspace](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces/archive)
POST/v1/organizations/workspaces/{workspace_id}/archive
#### OrganizationWorkspaces[Rate Limits](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces/rate_limits)
##### [List Workspace Rate Limits](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces/rate_limits/list)
GET/v1/organizations/workspaces/{workspace_id}/rate_limits
List a workspace's rate limits.
##### [Set Workspace Rate Limits](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces/rate_limits/update)
POST/v1/organizations/workspaces/{workspace_id}/rate_limits/{rate_limit_id}
Set or clear rate-limit overrides for one rate-limit group in a workspace.
#### OrganizationWorkspaces[Members](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces/members)
##### [List Workspace Members](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces/members/list)
GET/v1/organizations/workspaces/{workspace_id}/members
##### [Create Workspace Member](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces/members/add)
POST/v1/organizations/workspaces/{workspace_id}/members
##### [Get Workspace Member](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces/members/retrieve)
GET/v1/organizations/workspaces/{workspace_id}/members/{user_id}
##### [Update Workspace Member](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces/members/update)
POST/v1/organizations/workspaces/{workspace_id}/members/{user_id}
##### [Delete Workspace Member](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces/members/remove)
DELETE/v1/organizations/workspaces/{workspace_id}/members/{user_id}
#### OrganizationWorkspaces[Service Accounts](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces/service_accounts)
##### [List Service Account Workspace Members](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [Create Service Account Workspace Member](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [Get Service Account Workspace Member](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [Update Service Account Workspace Member](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [Delete Service Account Workspace Member](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
#### Organization[Rate Limits](https://platform.claude.com/docs/en/api/http/beta/organization/rate_limits)
##### [List Organization Rate Limits](https://platform.claude.com/docs/en/api/http/beta/organization/rate_limits/list)
GET/v1/organizations/rate_limits
List Messages API rate limits for your organization.
#### Organization[Compliance Settings](https://platform.claude.com/docs/en/api/http/beta/organization/compliance_settings)
##### [Get Compliance Settings](https://platform.claude.com/docs/en/api/http/beta/organization/compliance_settings/retrieve)
GET/v1/organizations/compliance_settings
Retrieve your organization's Compliance Settings.
##### [Update Compliance Settings](https://platform.claude.com/docs/en/api/http/beta/organization/compliance_settings/update)
POST/v1/organizations/compliance_settings
Update your organization's Compliance Settings.
#### Organization[Usage Report](https://platform.claude.com/docs/en/api/http/beta/organization/usage_report)
##### [Get Messages Usage Report](https://platform.claude.com/docs/en/api/http/beta/organization/usage_report/retrieve_messages)
GET/v1/organizations/usage_report/messages
##### [Get Claude Code Usage Report](https://platform.claude.com/docs/en/api/http/beta/organization/usage_report/retrieve_claude_code)
GET/v1/organizations/usage_report/claude_code
Retrieve daily aggregated usage metrics for Claude Code users. Enables organizations to analyze developer productivity and build custom dashboards.
#### Organization[Cost Report](https://platform.claude.com/docs/en/api/http/beta/organization/cost_report)
##### [Get Cost Report](https://platform.claude.com/docs/en/api/http/beta/organization/cost_report/retrieve)
GET/v1/organizations/cost_report
#### Organization[MCP Tunnels](https://platform.claude.com/docs/en/api/http/beta/organization/mcp_tunnels)
##### [List Tunnels](https://platform.claude.com/docs/en/api/http/beta/organization/mcp_tunnels/list)
Deprecated
GET/v1/organizations/tunnels
**Deprecated.** This Admin API endpoint is superseded by `/v1/tunnels` on the Claude API and will be removed after a migration window. New integrations should use [`/v1/tunnels`](../Endpoints/http-beta-tunnels.md) with the `anthropic-beta: mcp-tunnels-2026-06-22` header and a WIF token carrying the `workspace:manage_tunnels` scope. Existing integrations continue to work with the `mcp-tunnels-2026-05-19` header and `org:manage_tunnels` scope during the migration window.
##### [Get Tunnel](https://platform.claude.com/docs/en/api/http/beta/organization/mcp_tunnels/retrieve)
Deprecated
GET/v1/organizations/tunnels/{tunnel_id}
**Deprecated.** This Admin API endpoint is superseded by `/v1/tunnels` on the Claude API and will be removed after a migration window. New integrations should use [`/v1/tunnels`](../Endpoints/http-beta-tunnels.md) with the `anthropic-beta: mcp-tunnels-2026-06-22` header and a WIF token carrying the `workspace:manage_tunnels` scope. Existing integrations continue to work with the `mcp-tunnels-2026-05-19` header and `org:manage_tunnels` scope during the migration window.
##### [Archive Tunnel](https://platform.claude.com/docs/en/api/http/beta/organization/mcp_tunnels/archive)
Deprecated
POST/v1/organizations/tunnels/{tunnel_id}/archive
**Deprecated.** This Admin API endpoint is superseded by `/v1/tunnels` on the Claude API and will be removed after a migration window. New integrations should use [`/v1/tunnels`](../Endpoints/http-beta-tunnels.md) with the `anthropic-beta: mcp-tunnels-2026-06-22` header and a WIF token carrying the `workspace:manage_tunnels` scope. Existing integrations continue to work with the `mcp-tunnels-2026-05-19` header and `org:manage_tunnels` scope during the migration window.
##### [Reveal Tunnel Token](https://platform.claude.com/docs/en/api/http/beta/organization/mcp_tunnels/reveal_token)
Deprecated
POST/v1/organizations/tunnels/{tunnel_id}/reveal_token
**Deprecated.** This Admin API endpoint is superseded by `/v1/tunnels` on the Claude API and will be removed after a migration window. New integrations should use [`/v1/tunnels`](../Endpoints/http-beta-tunnels.md) with the `anthropic-beta: mcp-tunnels-2026-06-22` header and a WIF token carrying the `workspace:manage_tunnels` scope. Existing integrations continue to work with the `mcp-tunnels-2026-05-19` header and `org:manage_tunnels` scope during the migration window.
##### [Rotate Tunnel Token](https://platform.claude.com/docs/en/api/http/beta/organization/mcp_tunnels/rotate_token)
Deprecated
POST/v1/organizations/tunnels/{tunnel_id}/rotate_token
**Deprecated.** This Admin API endpoint is superseded by `/v1/tunnels` on the Claude API and will be removed after a migration window. New integrations should use [`/v1/tunnels`](../Endpoints/http-beta-tunnels.md) with the `anthropic-beta: mcp-tunnels-2026-06-22` header and a WIF token carrying the `workspace:manage_tunnels` scope. Existing integrations continue to work with the `mcp-tunnels-2026-05-19` header and `org:manage_tunnels` scope during the migration window.
#### OrganizationMCP Tunnels[Tunnel Certificates](https://platform.claude.com/docs/en/api/http/beta/organization/mcp_tunnels/tunnel_certificates)
##### [Create Tunnel Certificate](https://platform.claude.com/docs/en/api/http/beta/organization/mcp_tunnels/tunnel_certificates/create)
Deprecated
POST/v1/organizations/tunnels/{tunnel_id}/certificates
**Deprecated.** This Admin API endpoint is superseded by `/v1/tunnels` on the Claude API and will be removed after a migration window. New integrations should use [`/v1/tunnels`](../Endpoints/http-beta-tunnels.md) with the `anthropic-beta: mcp-tunnels-2026-06-22` header and a WIF token carrying the `workspace:manage_tunnels` scope. Existing integrations continue to work with the `mcp-tunnels-2026-05-19` header and `org:manage_tunnels` scope during the migration window.
##### [List Tunnel Certificates](https://platform.claude.com/docs/en/api/http/beta/organization/mcp_tunnels/tunnel_certificates/list)
Deprecated
GET/v1/organizations/tunnels/{tunnel_id}/certificates
**Deprecated.** This Admin API endpoint is superseded by `/v1/tunnels` on the Claude API and will be removed after a migration window. New integrations should use [`/v1/tunnels`](../Endpoints/http-beta-tunnels.md) with the `anthropic-beta: mcp-tunnels-2026-06-22` header and a WIF token carrying the `workspace:manage_tunnels` scope. Existing integrations continue to work with the `mcp-tunnels-2026-05-19` header and `org:manage_tunnels` scope during the migration window.
##### [Get Tunnel Certificate](https://platform.claude.com/docs/en/api/http/beta/organization/mcp_tunnels/tunnel_certificates/retrieve)
Deprecated
GET/v1/organizations/tunnels/{tunnel_id}/certificates/{certificate_id}
**Deprecated.** This Admin API endpoint is superseded by `/v1/tunnels` on the Claude API and will be removed after a migration window. New integrations should use [`/v1/tunnels`](../Endpoints/http-beta-tunnels.md) with the `anthropic-beta: mcp-tunnels-2026-06-22` header and a WIF token carrying the `workspace:manage_tunnels` scope. Existing integrations continue to work with the `mcp-tunnels-2026-05-19` header and `org:manage_tunnels` scope during the migration window.
##### [Archive Tunnel Certificate](https://platform.claude.com/docs/en/api/http/beta/organization/mcp_tunnels/tunnel_certificates/archive)
Deprecated
POST/v1/organizations/tunnels/{tunnel_id}/certificates/{certificate_id}/archive
**Deprecated.** This Admin API endpoint is superseded by `/v1/tunnels` on the Claude API and will be removed after a migration window. New integrations should use [`/v1/tunnels`](../Endpoints/http-beta-tunnels.md) with the `anthropic-beta: mcp-tunnels-2026-06-22` header and a WIF token carrying the `workspace:manage_tunnels` scope. Existing integrations continue to work with the `mcp-tunnels-2026-05-19` header and `org:manage_tunnels` scope during the migration window.
#### OrganizationAnalytics[Summaries](http-beta-organization-analytics-summaries.md)
##### [Get Activity Summaries](http-beta-organization-analytics-summaries-list.md)
GET/v1/organizations/analytics/summaries
Get organization-wide activity summaries for a date range.
#### OrganizationAnalytics[Users](platform-claude-com-http-beta-organization-analytics-users.md)
##### [List User Activity](platform-claude-com-http-beta-organization-analytics-users-list.md)
GET/v1/organizations/analytics/users
Get per-user activity for a given day, with cursor-based pagination.
#### OrganizationAnalyticsAppsChat[Projects](http-beta-organization-analytics-apps-chat-projects.md)
##### [Get Chat Project Usage](http-beta-organization-analytics-apps-chat-projects-list.md)
GET/v1/organizations/analytics/apps/chat/projects
Get per-project activity for a given day, with cursor-based pagination.
#### OrganizationAnalytics[Connectors](http-beta-organization-analytics-connectors.md)
##### [Get Connector Usage](platform-claude-com-http-beta-organization-analytics-connectors-list.md)
GET/v1/organizations/analytics/connectors
Get per-connector usage for a given day, with cursor-based pagination.
#### OrganizationAnalytics[Plugins](platform-claude-com-http-beta-organization-analytics-plugins.md)
##### [Get Plugin Usage](platform-claude-com-http-beta-organization-analytics-plugins-list.md)
GET/v1/organizations/analytics/plugins
Get per-plugin install + invocation usage for a given day, with pagination.
#### OrganizationAnalytics[Skills](http-beta-organization-analytics-skills.md)
##### [Get Skill Usage](platform-claude-com-http-beta-organization-analytics-skills-list.md)
GET/v1/organizations/analytics/skills
Get per-skill usage for a given day, with cursor-based pagination.
#### OrganizationAnalytics[Artifacts](http-beta-organization-analytics-artifacts.md)
##### [Get Artifact Activity](platform-claude-com-http-beta-organization-analytics-artifacts-list.md)
GET/v1/organizations/analytics/artifacts
Get artifact-creation activity for a given day, broken out by MIME type.
#### OrganizationAnalytics[Usage Report](http-beta-organization-analytics-usage-report.md)
##### [Get Token Usage Over Time](http-beta-organization-analytics-usage-report-list.md)
GET/v1/organizations/analytics/usage_report
Get token usage over time across a date range.
#### OrganizationAnalytics[User Usage Report](http-beta-organization-analytics-user-usage-report.md)
##### [Get Per-User Token Usage](http-beta-organization-analytics-user-usage-report-list.md)
GET/v1/organizations/analytics/user_usage_report
Get per-user token usage across a date range.
#### OrganizationAnalytics[Cost Report](http-beta-organization-analytics-cost-report.md)
##### [Get Cost Over Time](http-beta-organization-analytics-cost-report-list.md)
GET/v1/organizations/analytics/cost_report
Get cost in USD over time across a date range.
#### OrganizationAnalytics[User Cost Report](http-beta-organization-analytics-user-cost-report.md)
##### [Get Per-User Cost](http-beta-organization-analytics-user-cost-report-list.md)
GET/v1/organizations/analytics/user_cost_report
Get per-user cost in USD across a date range.
#### Organization[Spend Limits](https://platform.claude.com/docs/en/api/http/beta/organization/spend_limits)
##### [Set Spend Limit](https://platform.claude.com/docs/en/api/http/beta/organization/spend_limits/set)
POST/v1/organizations/spend_limits
Set a spend limit.
##### [Get Spend Limit](https://platform.claude.com/docs/en/api/http/beta/organization/spend_limits/retrieve)
GET/v1/organizations/spend_limits/{spend_limit_id}
Retrieve a spend limit by ID.
##### [Delete Spend Limit](https://platform.claude.com/docs/en/api/http/beta/organization/spend_limits/delete)
DELETE/v1/organizations/spend_limits/{spend_limit_id}
Delete a spend limit.
##### [List Spend Limits](https://platform.claude.com/docs/en/api/http/beta/organization/spend_limits/list)
GET/v1/organizations/spend_limits
List the organization's spend limits.
#### OrganizationSpend Limits[Effective](https://platform.claude.com/docs/en/api/http/beta/organization/spend_limits/effective)
##### [List Effective Spend Limits](https://platform.claude.com/docs/en/api/http/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 Limits[Increase Requests](https://platform.claude.com/docs/en/api/http/beta/organization/spend_limits/increase_requests)
##### [List Spend Limit Increase Requests](https://platform.claude.com/docs/en/api/http/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](https://platform.claude.com/docs/en/api/http/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](https://platform.claude.com/docs/en/api/http/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](https://platform.claude.com/docs/en/api/http/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.
#### Organization[RBAC Groups](https://platform.claude.com/docs/en/api/http/beta/organization/rbac_groups)
##### [Create RBAC Group](https://platform.claude.com/docs/en/api/http/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](https://platform.claude.com/docs/en/api/http/beta/organization/rbac_groups/list)
GET/v1/organizations/rbac_groups
List RBAC Groups in the Claude Enterprise tenant.
##### [Get RBAC Group](https://platform.claude.com/docs/en/api/http/beta/organization/rbac_groups/retrieve)
GET/v1/organizations/rbac_groups/{rbac_group_id}
Retrieve an RBAC Group by ID.
##### [Update RBAC Group](https://platform.claude.com/docs/en/api/http/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](https://platform.claude.com/docs/en/api/http/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 Groups[Members](https://platform.claude.com/docs/en/api/http/beta/organization/rbac_groups/members)
##### [List RBAC Group Members](https://platform.claude.com/docs/en/api/http/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](https://platform.claude.com/docs/en/api/http/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](https://platform.claude.com/docs/en/api/http/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.
#### Organization[RBAC Roles](https://platform.claude.com/docs/en/api/http/beta/organization/rbac_roles)
##### [List RBAC Roles](https://platform.claude.com/docs/en/api/http/beta/organization/rbac_roles/list)
GET/v1/organizations/rbac_roles
List RBAC Roles in the organization.
##### [Get RBAC Role](https://platform.claude.com/docs/en/api/http/beta/organization/rbac_roles/retrieve)
GET/v1/organizations/rbac_roles/{rbac_role_id}
Retrieve an RBAC Role by ID.
#### OrganizationRBAC Roles[Permissions](https://platform.claude.com/docs/en/api/http/beta/organization/rbac_roles/permissions)
##### [List RBAC Role Permissions](https://platform.claude.com/docs/en/api/http/beta/organization/rbac_roles/permissions/list)
GET/v1/organizations/rbac_roles/{rbac_role_id}/permissions
List the permissions an RBAC Role grants.
#### Organization[Plugins](https://platform.claude.com/docs/en/api/http/beta/organization/plugins)
##### [Create Plugin](https://platform.claude.com/docs/en/api/http/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](https://platform.claude.com/docs/en/api/http/beta/organization/plugins/retrieve)
GET/v1/organizations/plugins/{plugin_id}
Retrieve a Plugin by ID.
##### [Update Plugin](https://platform.claude.com/docs/en/api/http/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](https://platform.claude.com/docs/en/api/http/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](https://platform.claude.com/docs/en/api/http/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.
#### OrganizationPlugins[Versions](https://platform.claude.com/docs/en/api/http/beta/organization/plugins/versions)
##### [Create Plugin Version](https://platform.claude.com/docs/en/api/http/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](https://platform.claude.com/docs/en/api/http/beta/organization/plugins/versions/list)
GET/v1/organizations/plugins/{plugin_id}/versions
List a Plugin's versions, newest first.
##### [Get Plugin Version](https://platform.claude.com/docs/en/api/http/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](https://platform.claude.com/docs/en/api/http/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.
#### OrganizationPlugins[Installation Settings](https://platform.claude.com/docs/en/api/http/beta/organization/plugins/installation_settings)
##### [List Plugin Installation Settings](https://platform.claude.com/docs/en/api/http/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](https://platform.claude.com/docs/en/api/http/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](https://platform.claude.com/docs/en/api/http/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.
#### OrganizationPlugins[Shares](https://platform.claude.com/docs/en/api/http/beta/organization/plugins/shares)
##### [List Plugin Shares](https://platform.claude.com/docs/en/api/http/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.
#### Organization[Plugin Marketplaces](https://platform.claude.com/docs/en/api/http/beta/organization/plugin_marketplaces)
##### [List Plugin Marketplaces](https://platform.claude.com/docs/en/api/http/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](https://platform.claude.com/docs/en/api/http/beta/organization/plugin_marketplaces/retrieve)
GET/v1/organizations/plugin_marketplaces/{marketplace_id}
Retrieve a plugin marketplace by ID.
##### [Update Plugin Marketplace](https://platform.claude.com/docs/en/api/http/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](https://platform.claude.com/docs/en/api/http/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](https://platform.claude.com/docs/en/api/http/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.
#### Organization[Telemetry Destinations](https://platform.claude.com/docs/en/api/http/beta/organization/telemetry_destinations)
##### [Create a Telemetry Destination](https://platform.claude.com/docs/en/api/http/beta/organization/telemetry_destinations/create)
POST/v1/organizations/telemetry_destinations
Register an OpenTelemetry destination for the organization.
##### [List Telemetry Destinations](https://platform.claude.com/docs/en/api/http/beta/organization/telemetry_destinations/list)
GET/v1/organizations/telemetry_destinations
List the organization's destinations, newest first, optionally only those that cover given workspaces.
##### [Retrieve a Telemetry Destination](https://platform.claude.com/docs/en/api/http/beta/organization/telemetry_destinations/retrieve)
GET/v1/organizations/telemetry_destinations/{destination_id}
Read a destination's configuration, state, and most recent delivery results.
##### [Update a Telemetry Destination](https://platform.claude.com/docs/en/api/http/beta/organization/telemetry_destinations/update)
POST/v1/organizations/telemetry_destinations/{destination_id}
Change a telemetry destination's settings, its state, or which workspaces it covers.
##### [Delete a Telemetry Destination](https://platform.claude.com/docs/en/api/http/beta/organization/telemetry_destinations/delete)
DELETE/v1/organizations/telemetry_destinations/{destination_id}
Delete a destination and its workspace list.
##### [Test a Telemetry Destination](https://platform.claude.com/docs/en/api/http/beta/organization/telemetry_destinations/test)
POST/v1/organizations/telemetry_destinations/{destination_id}/test
Send one test span, named `anthropic.test`, to the destination with its registered headers, once and without retries, and report the destination's answer. The response is 200 whether or not the destination answered with a 2xx status: its `result` has the type `success`, or the type `failure` and the reason in `error`. The destination's configuration, `state` and `delivery_health` do not change. A disabled destination can be tested too. Wait 10 seconds between tests of one destination; a request that comes sooner may be answered with status 429.
#### OrganizationTelemetry Destinations[Workspaces](https://platform.claude.com/docs/en/api/http/beta/organization/telemetry_destinations/workspaces)
##### [List Telemetry Destination Workspaces](https://platform.claude.com/docs/en/api/http/beta/organization/telemetry_destinations/workspaces/list)
GET/v1/organizations/telemetry_destinations/{destination_id}/workspaces
List the workspaces on a destination's workspace list, newest entry first.
##### [Add a Telemetry Destination Workspace](https://platform.claude.com/docs/en/api/http/beta/organization/telemetry_destinations/workspaces/add)
POST/v1/organizations/telemetry_destinations/{destination_id}/workspaces/{workspace_id}
Add one workspace to a destination's workspace list.
##### [Remove a Telemetry Destination Workspace](https://platform.claude.com/docs/en/api/http/beta/organization/telemetry_destinations/workspaces/remove)
DELETE/v1/organizations/telemetry_destinations/{destination_id}/workspaces/{workspace_id}
Remove one workspace from a destination's workspace list.
#### Organization[Webhooks](https://platform.claude.com/docs/en/api/http/beta/organization/webhooks)
##### [Create Organization Webhook Endpoint](https://platform.claude.com/docs/en/api/http/beta/organization/webhooks/create)
POST/v1/organizations/webhooks
Create an organization webhook endpoint.
##### [List Organization Webhook Endpoints](https://platform.claude.com/docs/en/api/http/beta/organization/webhooks/list)
GET/v1/organizations/webhooks
List the organization's webhook endpoints.
##### [Get Organization Webhook Endpoint](https://platform.claude.com/docs/en/api/http/beta/organization/webhooks/retrieve)
GET/v1/organizations/webhooks/{webhook_endpoint_id}
Retrieve an organization webhook endpoint by ID.
##### [Update Organization Webhook Endpoint](https://platform.claude.com/docs/en/api/http/beta/organization/webhooks/update)
POST/v1/organizations/webhooks/{webhook_endpoint_id}
Update an organization webhook endpoint. Only the fields you send are changed.
##### [Delete Organization Webhook Endpoint](https://platform.claude.com/docs/en/api/http/beta/organization/webhooks/delete)
DELETE/v1/organizations/webhooks/{webhook_endpoint_id}
Delete an organization webhook endpoint.
##### [Regenerate Organization Webhook Endpoint Signing Secret](https://platform.claude.com/docs/en/api/http/beta/organization/webhooks/regenerate_signing_secret)
POST/v1/organizations/webhooks/{webhook_endpoint_id}/regenerate_signing_secret
Replace an organization webhook endpoint's signing secret. The old secret stops working immediately. The new secret is returned only in this response.
---
## Create Invite - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/invites/create
Path: 04-API-Reference/Admin/platform-claude-com-beta-organization-invites-create.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Finvites%2Fcreate)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Create Invite
List Invites
Get Invite
Delete Invite
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Invites](https://platform.claude.com/docs/en/api/http/beta/organization/invites)
# Create Invite
Copy page
cURL
POST/v1/organizations/invites
Invite a user to join the organization by email.
On plans that draw members from a finite pool of purchased seats, the invite automatically consumes a seat from the lowest tier with availability; there is no seat-tier parameter. When no seat is free the request fails with a 400 error rather than purchasing a seat.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
##### Body
email: string
Email of the User.
formatemail
role: "billing" or "claude_code_user" or "developer" or 2 more
Role for the invited User.
The accepted values depend on the organization type. Console and API organizations accept `user`, `developer`, `billing`, and `claude_code_user`; `admin` cannot be assigned through the API. Claude Enterprise organizations accept `user` and `managed`; inviting with the `managed` role requires the `write:rbac_groups` scope in addition to `write:members`.
One of the following:
"billing"
"claude_code_user"
"developer"
"managed"
"user"
rbac_group_ids: optional array of string
RBAC group IDs to assign to the User when the Invite is accepted. A non-empty array is accepted only for a Claude Enterprise organization with RBAC groups, and requires the key to carry the `write:rbac_groups` scope.
maxItems100
##### Returns
BetaOrganizationInvite object{ type: "invite", id, accepted_at, 6 more }
Create Invite
cURL
```python
curl https://api.anthropic.com/v1/organizations/invites \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY" \
-d '{
"email": "user@emaildomain.com",
"role": "user"
}'
```
Response 200
```python
{
"id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu",
"accepted_at": "2019-12-27T18:11:19.117Z",
"email": "user@emaildomain.com",
"expires_at": "2024-11-20T23:58:27.427722Z",
"invited_at": "2024-10-30T23:58:27.427722Z",
"rbac_group_ids": [
"string"
],
"role": "admin",
"status": "pending",
"type": "invite"
}
```
##### Returns Examples
Response 200
```python
{
"id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu",
"accepted_at": "2019-12-27T18:11:19.117Z",
"email": "user@emaildomain.com",
"expires_at": "2024-11-20T23:58:27.427722Z",
"invited_at": "2024-10-30T23:58:27.427722Z",
---
## Delete Invite - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/invites/delete
Path: 04-API-Reference/Admin/platform-claude-com-beta-organization-invites-delete.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Finvites%2Fdelete)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Create Invite
List Invites
Get Invite
Delete Invite
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Invites](https://platform.claude.com/docs/en/api/http/beta/organization/invites)
# Delete Invite
Copy page
cURL
DELETE/v1/organizations/invites/{invite_id}
Delete a pending invite.
##### Path parameters
invite_id: string
ID of the Invite.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
##### Returns
type: "invite_deleted"
Deleted object type.
For Invites, this is always `"invite_deleted"`.
defaultinvite_deleted
id: string
ID of the Invite.
Delete Invite
cURL
```python
curl https://api.anthropic.com/v1/organizations/invites/$INVITE_ID \
-X DELETE \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu",
"type": "invite_deleted"
}
```
##### Returns Examples
Response 200
```python
{
"id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu",
---
## Remove User - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/users/remove
Path: 04-API-Reference/Admin/platform-claude-com-beta-organization-users-remove.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fusers%2Fremove)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
List Users
Get User
Update User
Remove User
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Users](https://platform.claude.com/docs/en/api/http/beta/organization/users)
# Remove User
Copy page
cURL
DELETE/v1/organizations/users/{user_id}
Remove a member from the organization.
##### Path parameters
user_id: string
ID of the User.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
##### Returns
type: "user_deleted"
Deleted object type.
For Users, this is always `"user_deleted"`.
defaultuser_deleted
id: string
ID of the User.
Remove User
cURL
```python
curl https://api.anthropic.com/v1/organizations/users/$USER_ID \
-X DELETE \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"type": "user_deleted"
}
```
##### Returns Examples
Response 200
```python
{
"id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
---
## Update User - Claude API Reference
Source: https://platform.claude.com/docs/en/api/beta/organization/users/update
Path: 04-API-Reference/Admin/platform-claude-com-beta-organization-users-update.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fbeta%2Forganization%2Fusers%2Fupdate)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
List Users
Get User
Update User
Remove User
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Telemetry Destinations
Webhooks
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Delete User Profile
Create Enrollment URL
Action URLs
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
Compliance API
Activities
Organizations
Groups
Apps
Completions
Create a Text Completion Deprecated
OpenTelemetry
[Spans](../Endpoints/opentelemetry-spans.md)
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Users](https://platform.claude.com/docs/en/api/http/beta/organization/users)
# Update User
Copy page
cURL
POST/v1/organizations/users/{user_id}
Update a member's organization role.
##### Path parameters
user_id: string
ID of the User.
##### Headers
"anthropic-version": optional string
The version of the Claude API you want to use.
Read more about versioning and our version history [here](../Endpoints/versioning.md).
##### Body
role: "billing" or "claude_code_user" or "developer" or 2 more
New role for the User.
The accepted values depend on the organization type. Console and API organizations accept `user`, `developer`, `billing`, and `claude_code_user`; `admin` cannot be assigned through the API. Claude Enterprise organizations accept `user` and `managed`; changing a User's role to `managed` requires the `write:rbac_groups` scope in addition to `write:members`.
One of the following:
"billing"
"claude_code_user"
"developer"
"managed"
"user"
##### Returns
BetaOrganizationUser object{ type: "user", id, added_at, 3 more }
type: "user"
Object type.
For Users, this is always `"user"`.
defaultuser
id: string
ID of the User.
added_at: string
RFC 3339 datetime string indicating when the User joined the Organization.
formatdate-time
email: string
Email of the User.
name: string
Name of the User.
role: [BetaOrganizationRole](platform-claude-com-http-beta-organization.md#beta_organization_role)
Organization role of the User.
One of the following:
"admin"
"billing"
"claude_code_user"
"developer"
"managed"
"membership_admin"
"owner"
"primary_owner"
"user"
Update User
cURL
```python
curl https://api.anthropic.com/v1/organizations/users/$USER_ID \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY" \
-d '{
"role": "user"
}'
```
Response 200
```python
{
"id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"added_at": "2024-10-30T23:58:27.427722Z",
"email": "user@emaildomain.com",
"name": "Jane Doe",
"role": "admin",
"type": "user"
}
```
##### Returns Examples
Response 200
```python
{
"id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"added_at": "2024-10-30T23:58:27.427722Z",
"email": "user@emaildomain.com",
---
## Get Artifact Activity - Claude API Reference
Source: https://platform.claude.com/docs/en/api/http/beta/organization/analytics/artifacts/list
Path: 04-API-Reference/Admin/platform-claude-com-http-beta-organization-analytics-artifacts-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fhttp%2Fbeta%2Forganization%2Fanalytics%2Fartifacts%2Flist)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Summaries
Users
Apps
Connectors
Plugins
Skills
Artifacts
Get Artifact Activity
Usage Report
User Usage Report
Cost Report
User Cost Report
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Analytics](platform-claude-com-http-beta-organization-analytics.md)
5. [Artifacts](http-beta-organization-analytics-artifacts.md)
# Get Artifact Activity
GET/v1/organizations/analytics/artifacts
Get artifact-creation activity for a given day, broken out by MIME type.
Returns the full (`artifact_type`, `is_shared`) cube for the organization; `next_page` is null except for grouped queries, which paginate. The cube can be broken out per product, per member, or per RBAC group via `group_by[]`, and scoped via `filter[]`. Requires an API key with the `read:analytics` scope.
##### Query parameters
date: string
UTC date in YYYY-MM-DD format. The day to get artifact activity for. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day) and may be revised by a few percent over the following days. No earlier than 2026-01-01.
formatdate
filter: optional array of string
Filters as `dimension:value`, e.g. `filter[]=rbac_group_id:{id}`. Repeat the param for OR within a dimension and across dimensions for AND. Supported dimensions on this endpoint: `artifact_type`, `is_shared`, `product`, `rbac_group_id`, `user_id`. Value forms: `artifact_type` is a canonical artifact MIME type (e.g. `text/markdown`) or `other`; `is_shared` is `true` or `false`; `product` is `chat`, `claude_code`, or `cowork` (the surfaces that create artifacts); `rbac_group_id` takes the tagged id (`rbac_group_...`, as emitted in responses and by the spend-limits API) or a bare group UUID, and matches users who held the group at any point during each covered UTC day (time-of-usage attribution); `user_id` takes a tagged user id (`user_...`), as emitted in responses. An unsupported dimension returns 400. At most 100 entries.
maxItems100
group_by: optional array of "product" or "rbac_group_id" or "user_id"
Dimensions to break results out by: `product`, `user_id` and/or `rbac_group_id`. The ungrouped artifact-type cube is finite and returned in full; grouped queries multiply the cube and paginate via `next_page`. `product` takes the values `chat`, `claude_code`, or `cowork` (the surfaces that create artifacts). `rbac_group_id` attributes a user to every group they held at any point during the requested UTC day, so grouped rows are not an exclusive partition. At most 100 entries.
maxItems100
One of the following:
"product"
"rbac_group_id"
"user_id"
limit: optional number
Maximum rows to return (1-1000, default 100). The ungrouped artifact-type cube is finite and returned in full; `limit` is the page size only when `group_by[]` multiplies the cube.
minimum1
maximum1000
page: optional string
Opaque cursor from a previous response's `next_page` field. Only valid with `group_by[]` — the ungrouped cube is never paginated.
##### Returns
data: array of [BetaAnalyticsArtifactActivity](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_artifact_activity) { artifact_type, artifacts_created_count, distinct_user_count, 6 more }
artifact_type: string
Canonical artifact MIME type (e.g. `text/markdown`, `application/vnd.ant.react`, `image/svg+xml`), or `other`. Claude Code and Cowork artifacts report as `text/html`.
artifacts_created_count: number
Number of artifacts created in this bucket on the requested day
distinct_user_count: number
Number of distinct users who created artifacts in this bucket on the requested day
is_shared: boolean
Whether the artifacts in this bucket have ever been shared (a Claude Code / Cowork artifact is shared once anyone beyond its creator may open it: named members, the whole organization, or anyone with the link).
published_artifacts_created_count: number
Number of those artifacts that have been published (for Claude Code / Cowork artifacts: open to anyone with the link); never exceeds `artifacts_created_count`
product: optional string or null
Product that produced this row's activity: one of `chat`, `claude_code`, `cowork`, or `office_agent` (the canonical Cost & Usage product naming; an `office_agent` row's per-surface breakdown is in its `office_metrics`). On `/plugins` only `cowork` and `claude_code` occur (the only surfaces with plugin attribution); on `/artifacts` only `chat`, `claude_code`, and `cowork` occur (the surfaces that create artifacts); `/apps/chat/projects` does not support the product dimension (a `product` entry in `group_by[]` or `filter[]` there is rejected). Present only when the request grouped by `product`.
rbac_group_id: optional string or null
Tagged RBAC group identifier (`rbac_group_...`), matching the spend-limits API spelling. Present only when the request grouped by `rbac_group_id`.
rbac_group_name: optional string or null
Resolved RBAC group display name, alongside `rbac_group_id` when name resolution is available. Null if the group has been deleted or its name could not be resolved; `rbac_group_id` remains the stable key.
user_id: optional string or null
Tagged user identifier (e.g. `user_...`). Present only when the request grouped by `user_id`.
next_page: string or null
Cursor for the next page of a grouped query; always null for the ungrouped artifact-type cube, which is returned in full.
Get Artifact Activity
cURL
```python
curl https://api.anthropic.com/v1/organizations/analytics/artifacts \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"data": [
{
"artifact_type": "artifact_type",
"artifacts_created_count": 0,
"distinct_user_count": 0,
"is_shared": true,
"published_artifacts_created_count": 0,
"product": "product",
"rbac_group_id": "rbac_group_id",
"rbac_group_name": "rbac_group_name",
"user_id": "user_id"
}
],
"next_page": "next_page"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"artifact_type": "artifact_type",
"artifacts_created_count": 0,
"distinct_user_count": 0,
"is_shared": true,
"published_artifacts_created_count": 0,
"product": "product",
"rbac_group_id": "rbac_group_id",
"rbac_group_name": "rbac_group_name",
---
## Get Connector Usage - Claude API Reference
Source: https://platform.claude.com/docs/en/api/http/beta/organization/analytics/connectors/list
Path: 04-API-Reference/Admin/platform-claude-com-http-beta-organization-analytics-connectors-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fhttp%2Fbeta%2Forganization%2Fanalytics%2Fconnectors%2Flist)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Summaries
Users
Apps
Connectors
Get Connector Usage
Plugins
Skills
Artifacts
Usage Report
User Usage Report
Cost Report
User Cost Report
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Analytics](platform-claude-com-http-beta-organization-analytics.md)
5. [Connectors](http-beta-organization-analytics-connectors.md)
# Get Connector Usage
GET/v1/organizations/analytics/connectors
Get per-connector usage for a given day, with cursor-based pagination.
Returns connector usage metrics for the organization, sorted by connector name. Connector names are normalized from their various sources — for example, "Atlassian MCP server" and "mcp-atlassian" both appear as "atlassian". Use `group_by[]` to break usage out per member, per RBAC group, or per product surface, and `filter[]` to scope results; the parameter descriptions list the supported dimensions. Available to organizations on a Claude Enterprise plan. Requires an API key with the `read:analytics` scope.
##### Query parameters
date: optional string
UTC date in YYYY-MM-DD format. The day to get connector usage for. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day) and may be revised by a few percent over the following days. No earlier than 2026-01-01.
formatdate
ending_date: optional string
UTC date in YYYY-MM-DD format. End of the date range (exclusive); only valid with `starting_date`. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day), so this can be at most today — which is also the default when omitted, resolved once when the first page is served and reused for the rest of the pagination sequence. At most 366 days after `starting_date`.
formatdate
filter: optional array of string
Filters as `dimension:value`, e.g. `filter[]=rbac_group_id:{id}`. Repeat the param for OR within a dimension and across dimensions for AND. Supported dimensions on this endpoint: `connector_name`, `product`, `rbac_group_id`, `user_id`. Value forms: `connector_name` matches case-insensitively, a display name such as 'GitHub MCP' also matches its normalized stored form ('github'), and for rows whose `connector_name` is an opaque connector id the connector's display name (`connector_display_name`) also matches; `product` is one of `chat`, `claude_code`, `cowork`, or `office_agent`; `rbac_group_id` takes the tagged id (`rbac_group_...`, as emitted in responses and by the spend-limits API) or a bare group UUID, and matches users who held the group at any point during each covered UTC day (time-of-usage attribution); `user_id` takes a tagged user id (`user_...`), as emitted in responses. An unsupported dimension returns 400. At most 100 entries.
maxItems100
group_by: optional array of "product" or "rbac_group_id" or "user_id"
Dimensions to break results out by (e.g. `group_by[]=user_id`). Supported on this endpoint: `product`, `rbac_group_id`, `user_id`. Grouped rows carry the requested dimension values as additional fields and paginate like ungrouped responses via `next_page`; an unsupported dimension returns 400. `rbac_group_id` attributes a user to every group they held at any point during each covered UTC day, so grouped rows are not an exclusive partition and can sum above org-level totals. At most 100 entries.
maxItems100
One of the following:
"product"
"rbac_group_id"
"user_id"
limit: optional number
Number of results per page (1-1000, default 100).
minimum1
maximum1000
order: optional "asc" or "desc"
Sort direction: `asc` or `desc`. Defaults to `asc` for the endpoint's sort column and to `desc` when `order_by` names a metric (a top-N ranking). Applies to `order_by`, or to the endpoint's default sort field when `order_by` is omitted.
One of the following:
"asc"
"desc"
order_by: optional string
Sort field. Restricted to the endpoint's sort column plus its rankable metrics (metrics default to descending; a few metrics rank in date-range mode only, per the endpoint's documented orderable set).
page: optional string
Opaque cursor from a previous response's `next_page` field.
starting_date: optional string
UTC date in YYYY-MM-DD format. Start of a date range (inclusive). Enables rollup mode: one row per entity aggregated over the whole range — addable counters are summed across days, and a distinct count is never summed where summing could double-count (a field's range value is recomputed exactly over the window, approximate via HLL with typical error under 2%, null, or — for the creation-event counts, whose per-day values cannot overlap — a per-day sum that is itself exact; each field's own description says which). Use either `date` or `starting_date`, not both. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day) and may be revised by a few percent over the following days. No earlier than 2026-01-01.
formatdate
##### Returns
data: array of [BetaAnalyticsConnectorActivity](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_connector_activity) { chat_metrics, claude_code_metrics, connector_name, 13 more }
chat_metrics: [BetaAnalyticsConnectorChatMetrics](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_connector_chat_metrics) { distinct_conversation_connector_used_count }
Claude.ai activity metrics for a single connector on a given day.
distinct_conversation_connector_used_count: number or null
Number of distinct conversations in which the connector was used. Approximate (HLL, typical error \<2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.
claude_code_metrics: [BetaAnalyticsConnectorClaudeCodeMetrics](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_connector_claude_code_metrics) { distinct_session_connector_used_count }
Claude Code activity metrics for a single connector on a given day.
distinct_session_connector_used_count: number or null
Number of distinct Claude Code sessions in which the connector was used. Approximate (HLL, typical error \<2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.
connector_name: string
Name of the connector. Some rows carry an opaque connector id here instead of a readable name; `connector_display_name` holds the resolved name for those rows.
cowork_metrics: [BetaAnalyticsConnectorCoworkMetrics](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_connector_cowork_metrics) { distinct_session_connector_used_count }
Cowork activity metrics for a single connector on a given day.
distinct_session_connector_used_count: number or null
Number of distinct Cowork sessions in which the connector was used. Approximate (HLL, typical error \<2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.
distinct_user_count: number
Number of distinct users who used the connector on the requested day, or, in date-range mode, over the requested window — recomputed as an exact distinct count over the window's per-member daily rows, never a sum of per-day values.
office_metrics: [BetaAnalyticsConnectorOfficeMetrics](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_connector_office_metrics) { excel, outlook, powerpoint, word }
Office Agent activity metrics for a single connector on a given day, broken out by Office product.
connector_display_name: optional string or null
Human-readable display name for rows whose `connector_name` is an opaque connector id rather than a readable name, resolved at request time from the organization's connectors (including connectors that have since been removed). `connector_name` remains the row's stable key for sorting and pagination, and `filter[]=connector_name:{value}` also matches these rows by display name. Display names are not unique, and the same connector's claude.ai usage can appear under a separate row with a readable `connector_name`. Null when `connector_name` is already a readable name, when the id cannot be resolved to one of the organization's connectors, or when display-name resolution is not enabled for this organization.
individual_auth_distinct_user_count: optional number or null
Number of distinct users whose use of this connector on the requested day ran on their own individual credential, connected through their own consent flow. Companion bucket to `managed_auth_distinct_user_count`, which carries the measurement, attribution, and null rules. Users whose requests used no stored credential count in neither bucket.
managed_auth_distinct_user_count: optional number or null
Number of distinct users whose use of this connector on the requested day ran on Enterprise Managed Auth (an organization-managed credential provisioned through the organization's identity provider), read from the token record each request used. Null, never 0, when managed-auth reporting is not enabled for the organization, the value cannot be attributed to the row, no credentialed requests and no managed-token mint events (a managed credential being provisioned for a user's use of the connector) were observed that day, or the day predates 2026-07-01, the first day the backing data exists (forward-only data, no backfill). When credentialed requests or mint events were observed and attributed, both managed-auth fields populate, reporting 0 for a bucket with no users; the two counts are independent, not a partition — a user whose requests that day used both kinds of credential counts in both. Mint events carry user but not surface attribution, so they count as observed auth activity on `user_id` and `rbac_group_id` cuts — attributed to the user the credential was provisioned for — but never on a cut that references `product` (group or filter). Date-range rollup mode (`starting_date`/`ending_date`) computes both fields exactly over the window — distinct users with at least one qualifying day — when the whole window starts on or after 2026-07-01, with the null-versus-0 and mint-event rules applying with the window in place of the day; a range starting earlier reports every managed-auth field as null, never a partial-window value.
product: optional string or null
Product that produced this row's activity: one of `chat`, `claude_code`, `cowork`, or `office_agent` (the canonical Cost & Usage product naming; an `office_agent` row's per-surface breakdown is in its `office_metrics`). On `/plugins` only `cowork` and `claude_code` occur (the only surfaces with plugin attribution); on `/artifacts` only `chat`, `claude_code`, and `cowork` occur (the surfaces that create artifacts); `/apps/chat/projects` does not support the product dimension (a `product` entry in `group_by[]` or `filter[]` there is rejected). Present only when the request grouped by `product`.
rbac_group_id: optional string or null
Tagged RBAC group identifier (`rbac_group_...`), matching the spend-limits API spelling. Present only when the request grouped by `rbac_group_id`.
rbac_group_name: optional string or null
Resolved RBAC group display name, alongside `rbac_group_id` when name resolution is available. Null if the group has been deleted or its name could not be resolved; `rbac_group_id` remains the stable key.
read_call_count: optional number or null
Number of connector tool calls on the requested day whose trusted read-only annotation marked them read-only. Call count, not distinct users. Every call recorded on a classified surface lands in exactly one of `read_call_count`, `write_call_count`, or `unclassified_call_count`, so the three sum to the day's classified calls. Classification is forward-only per surface: claude.ai from 2026-06-01, Claude Code from 2026-05-30, Claude in Office from 2026-05-29, Cowork from 2026-06-02 (Cowork clients predating annotation forwarding land in `unclassified_call_count`). Null, never 0, when the value cannot be stated: the read/write split is not enabled for this organization, or the day predates 2026-05-29. For a date-range total, sum the per-day values, but treat a window that extends before 2026-05-29 as null rather than summing only its covered days — date-range rollup mode (`starting_date`/`ending_date`) applies both rules server-side.
unclassified_call_count: optional number or null
Number of connector tool calls on the requested day with no trusted read-only annotation — the annotation is optional in the MCP spec and is discarded when connector access controls are active, so unclassified calls are common. This field shows how much of the day's classified activity the read/write split actually covers. Call count, not distinct users. One of the three call-classification buckets; see `read_call_count` for the per-surface data-start dates, null conditions, and date-range guidance.
user_id: optional string or null
Tagged user identifier (e.g. `user_...`). Present only when the request grouped by `user_id`.
write_call_count: optional number or null
Number of connector tool calls on the requested day whose trusted read-only annotation marked them not read-only. Call count, not distinct users. One of the three call-classification buckets; see `read_call_count` for the per-surface data-start dates, null conditions, and date-range guidance.
next_page: string or null
Opaque cursor for the next page, or null if no more results
Get Connector Usage
cURL
```python
curl https://api.anthropic.com/v1/organizations/analytics/connectors \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"data": [
{
"chat_metrics": {
"distinct_conversation_connector_used_count": 0
},
"claude_code_metrics": {
"distinct_session_connector_used_count": 0
},
"connector_name": "connector_name",
"cowork_metrics": {
"distinct_session_connector_used_count": 0
},
"distinct_user_count": 0,
"office_metrics": {
"excel": {
"distinct_session_connector_used_count": 0
},
"outlook": {
"distinct_session_connector_used_count": 0
},
"powerpoint": {
"distinct_session_connector_used_count": 0
},
"word": {
"distinct_session_connector_used_count": 0
}
},
"connector_display_name": "connector_display_name",
"individual_auth_distinct_user_count": 0,
"managed_auth_distinct_user_count": 0,
"product": "product",
"rbac_group_id": "rbac_group_id",
"rbac_group_name": "rbac_group_name",
"read_call_count": 0,
"unclassified_call_count": 0,
"user_id": "user_id",
"write_call_count": 0
}
],
"next_page": "next_page"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"chat_metrics": {
"distinct_conversation_connector_used_count": 0
},
"claude_code_metrics": {
"distinct_session_connector_used_count": 0
},
"connector_name": "connector_name",
"cowork_metrics": {
"distinct_session_connector_used_count": 0
},
"distinct_user_count": 0,
"office_metrics": {
"excel": {
"distinct_session_connector_used_count": 0
},
"outlook": {
"distinct_session_connector_used_count": 0
},
"powerpoint": {
"distinct_session_connector_used_count": 0
},
"word": {
"distinct_session_connector_used_count": 0
}
},
"connector_display_name": "connector_display_name",
"individual_auth_distinct_user_count": 0,
"managed_auth_distinct_user_count": 0,
"product": "product",
"rbac_group_id": "rbac_group_id",
"rbac_group_name": "rbac_group_name",
---
## Get Plugin Usage - Claude API Reference
Source: https://platform.claude.com/docs/en/api/http/beta/organization/analytics/plugins/list
Path: 04-API-Reference/Admin/platform-claude-com-http-beta-organization-analytics-plugins-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fhttp%2Fbeta%2Forganization%2Fanalytics%2Fplugins%2Flist)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Summaries
Users
Apps
Connectors
Plugins
Get Plugin Usage
Skills
Artifacts
Usage Report
User Usage Report
Cost Report
User Cost Report
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Analytics](platform-claude-com-http-beta-organization-analytics.md)
5. [Plugins](platform-claude-com-http-beta-organization-analytics-plugins.md)
# Get Plugin Usage
GET/v1/organizations/analytics/plugins
Get per-plugin install + invocation usage for a given day, with pagination.
Returns plugin usage metrics for the organization across Cowork and Claude Code, sorted by plugin name. The `plugin_name` value `third-party` is an aggregate bucket, not a plugin: it collects plugin activity, from either surface, for which the reporting client did not provide a plugin name — so an organization's own plugins can contribute both to their own named rows and to this bucket. Use `group_by[]` to break usage out per member, per RBAC group, or per product surface (Cowork / Claude Code), and `filter[]` to scope results; the parameter descriptions list the supported dimensions. Requires an API key with the `read:analytics` scope. `starting_date` / `ending_date` select range-rollup mode like `/skills`.
##### Query parameters
date: optional string
UTC date in YYYY-MM-DD format. The day to get plugin usage for. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day) and may be revised by a few percent over the following days. No earlier than 2026-01-01.
formatdate
ending_date: optional string
UTC date in YYYY-MM-DD format. End of the date range (exclusive); only valid with `starting_date`. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day), so this can be at most today — which is also the default when omitted, resolved once when the first page is served and reused for the rest of the pagination sequence. At most 366 days after `starting_date`.
formatdate
filter: optional array of string
Filters as `dimension:value`, e.g. `filter[]=rbac_group_id:{id}`. Repeat the param for OR within a dimension and across dimensions for AND. Supported dimensions on this endpoint: `plugin_name`, `product`, `rbac_group_id`, `user_id`. Value forms: `plugin_name` matches case-insensitively; `product` is `claude_code` or `cowork` (the only surfaces with plugin attribution); `rbac_group_id` takes the tagged id (`rbac_group_...`, as emitted in responses and by the spend-limits API) or a bare group UUID, and matches users who held the group at any point during each covered UTC day (time-of-usage attribution); `user_id` takes a tagged user id (`user_...`), as emitted in responses. An unsupported dimension returns 400. At most 100 entries.
maxItems100
group_by: optional array of "product" or "rbac_group_id" or "user_id"
Dimensions to break results out by (e.g. `group_by[]=user_id`). Supported on this endpoint: `product`, `rbac_group_id`, `user_id`. On this endpoint `product` takes the values `claude_code` or `cowork` only (the surfaces with plugin attribution). Grouped rows carry the requested dimension values as additional fields and paginate like ungrouped responses via `next_page`; an unsupported dimension returns 400. `rbac_group_id` attributes a user to every group they held at any point during each covered UTC day, so grouped rows are not an exclusive partition and can sum above org-level totals. At most 100 entries.
maxItems100
One of the following:
"product"
"rbac_group_id"
"user_id"
limit: optional number
Number of results per page (1-1000, default 100).
minimum1
maximum1000
order: optional "asc" or "desc"
Sort direction: `asc` or `desc`. Defaults to `asc` for the endpoint's sort column and to `desc` when `order_by` names a metric (a top-N ranking). Applies to `order_by`, or to the endpoint's default sort field when `order_by` is omitted.
One of the following:
"asc"
"desc"
order_by: optional string
Sort field. Restricted to the endpoint's sort column plus its rankable metrics (metrics default to descending; a few metrics rank in date-range mode only, per the endpoint's documented orderable set).
page: optional string
Opaque cursor from a previous response's `next_page` field.
starting_date: optional string
UTC date in YYYY-MM-DD format. Start of a date range (inclusive). Enables rollup mode: one row per entity aggregated over the whole range — addable counters are summed across days, and a distinct count is never summed where summing could double-count (a field's range value is recomputed exactly over the window, approximate via HLL with typical error under 2%, null, or — for the creation-event counts, whose per-day values cannot overlap — a per-day sum that is itself exact; each field's own description says which). Use either `date` or `starting_date`, not both. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day) and may be revised by a few percent over the following days. No earlier than 2026-01-01.
formatdate
##### Returns
data: array of [BetaAnalyticsPluginActivity](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_plugin_activity) { claude_code_metrics, cowork_metrics, distinct_user_count, 8 more }
claude_code_metrics: [BetaAnalyticsPluginClaudeCodeMetrics](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_plugin_claude_code_metrics) { distinct_session_plugin_used_count }
Claude Code activity metrics for a single plugin on a given day.
distinct_session_plugin_used_count: number or null
Number of distinct Claude Code sessions in which the plugin was invoked. Null on aggregated rows where a distinct count cannot be computed.
cowork_metrics: [BetaAnalyticsPluginCoworkMetrics](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_plugin_cowork_metrics) { distinct_session_plugin_used_count }
Cowork activity metrics for a single plugin on a given day.
distinct_session_plugin_used_count: number or null
Number of distinct Cowork sessions in which the plugin was invoked. Null on aggregated rows where a distinct count cannot be computed.
distinct_user_count: number
Number of distinct users with recorded install or invocation activity for the plugin on the requested day (install-only users count), or, in date-range mode, over the requested window — recomputed as an exact distinct count over the window's per-member daily rows, never a sum of per-day values.
install_count: number or null
Number of distinct users who installed the plugin on the requested day, or, in date-range mode, over the requested window — recomputed as an exact distinct count over the window's per-member daily rows, never a sum of per-day values.
invocation_count: number
Number of plugin invocations on the requested day
plugin_name: string
Name of the plugin
plugin_id: optional string or null
Stable plugin identifier when available (e.g. `serena@claude-plugins-official`). Null for third-party Claude Code plugins (redacted at the source) and Cowork slash commands that carry only a hashed id.
product: optional string or null
Product that produced this row's activity: one of `chat`, `claude_code`, `cowork`, or `office_agent` (the canonical Cost & Usage product naming; an `office_agent` row's per-surface breakdown is in its `office_metrics`). On `/plugins` only `cowork` and `claude_code` occur (the only surfaces with plugin attribution); on `/artifacts` only `chat`, `claude_code`, and `cowork` occur (the surfaces that create artifacts); `/apps/chat/projects` does not support the product dimension (a `product` entry in `group_by[]` or `filter[]` there is rejected). Present only when the request grouped by `product`.
rbac_group_id: optional string or null
Tagged RBAC group identifier (`rbac_group_...`), matching the spend-limits API spelling. Present only when the request grouped by `rbac_group_id`.
rbac_group_name: optional string or null
Resolved RBAC group display name, alongside `rbac_group_id` when name resolution is available. Null if the group has been deleted or its name could not be resolved; `rbac_group_id` remains the stable key.
user_id: optional string or null
Tagged user identifier (e.g. `user_...`). Present only when the request grouped by `user_id`.
next_page: string or null
Opaque cursor for the next page, or null if no more results
Get Plugin Usage
cURL
```python
curl https://api.anthropic.com/v1/organizations/analytics/plugins \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"data": [
{
"claude_code_metrics": {
"distinct_session_plugin_used_count": 0
},
"cowork_metrics": {
"distinct_session_plugin_used_count": 0
},
"distinct_user_count": 0,
"install_count": 0,
"invocation_count": 0,
"plugin_name": "plugin_name",
"plugin_id": "plugin_id",
"product": "product",
"rbac_group_id": "rbac_group_id",
"rbac_group_name": "rbac_group_name",
"user_id": "user_id"
}
],
"next_page": "next_page"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"claude_code_metrics": {
"distinct_session_plugin_used_count": 0
},
"cowork_metrics": {
"distinct_session_plugin_used_count": 0
},
"distinct_user_count": 0,
"install_count": 0,
"invocation_count": 0,
"plugin_name": "plugin_name",
"plugin_id": "plugin_id",
"product": "product",
"rbac_group_id": "rbac_group_id",
"rbac_group_name": "rbac_group_name",
---
## Plugins - Claude API Reference
Source: https://platform.claude.com/docs/en/api/http/beta/organization/analytics/plugins
Path: 04-API-Reference/Admin/platform-claude-com-http-beta-organization-analytics-plugins.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fhttp%2Fbeta%2Forganization%2Fanalytics%2Fplugins)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Summaries
Users
Apps
Connectors
Plugins
Get Plugin Usage
Skills
Artifacts
Usage Report
User Usage Report
Cost Report
User Cost Report
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Analytics](platform-claude-com-http-beta-organization-analytics.md)
# Plugins
##### [Get Plugin Usage](platform-claude-com-http-beta-organization-analytics-plugins-list.md)
GET/v1/organizations/analytics/plugins
Get per-plugin install + invocation usage for a given day, with pagination.
---
## Get Skill Usage - Claude API Reference
Source: https://platform.claude.com/docs/en/api/http/beta/organization/analytics/skills/list
Path: 04-API-Reference/Admin/platform-claude-com-http-beta-organization-analytics-skills-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fhttp%2Fbeta%2Forganization%2Fanalytics%2Fskills%2Flist)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Summaries
Users
Apps
Connectors
Plugins
Skills
Get Skill Usage
Artifacts
Usage Report
User Usage Report
Cost Report
User Cost Report
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Analytics](platform-claude-com-http-beta-organization-analytics.md)
5. [Skills](http-beta-organization-analytics-skills.md)
# Get Skill Usage
GET/v1/organizations/analytics/skills
Get per-skill usage for a given day, with cursor-based pagination.
Returns skill usage metrics for the organization, sorted by skill name. Use `group_by[]` to break usage out per member, per RBAC group, or per product surface, and `filter[]` to scope results; the parameter descriptions list the supported dimensions. Available to organizations on a Claude Enterprise plan. Requires an API key with the `read:analytics` scope.
##### Query parameters
date: optional string
UTC date in YYYY-MM-DD format. The day to get skill usage for. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day) and may be revised by a few percent over the following days. No earlier than 2026-01-01.
formatdate
ending_date: optional string
UTC date in YYYY-MM-DD format. End of the date range (exclusive); only valid with `starting_date`. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day), so this can be at most today — which is also the default when omitted, resolved once when the first page is served and reused for the rest of the pagination sequence. At most 366 days after `starting_date`.
formatdate
filter: optional array of string
Filters as `dimension:value`, e.g. `filter[]=rbac_group_id:{id}`. Repeat the param for OR within a dimension and across dimensions for AND. Supported dimensions on this endpoint: `product`, `rbac_group_id`, `share_status`, `skill_name`, `user_id`. Value forms: `product` is one of `chat`, `claude_code`, `cowork`, or `office_agent`; `rbac_group_id` takes the tagged id (`rbac_group_...`, as emitted in responses and by the spend-limits API) or a bare group UUID, and matches users who held the group at any point during each covered UTC day (time-of-usage attribution); `share_status` is one of `organization`, `private`, or `public`; `skill_name` matches case-insensitively; `user_id` takes a tagged user id (`user_...`), as emitted in responses. An unsupported dimension returns 400. At most 100 entries.
maxItems100
group_by: optional array of "product" or "rbac_group_id" or "user_id"
Dimensions to break results out by (e.g. `group_by[]=user_id`). Supported on this endpoint: `product`, `rbac_group_id`, `user_id`. Grouped rows carry the requested dimension values as additional fields and paginate like ungrouped responses via `next_page`; an unsupported dimension returns 400. `rbac_group_id` attributes a user to every group they held at any point during each covered UTC day, so grouped rows are not an exclusive partition and can sum above org-level totals. At most 100 entries.
maxItems100
One of the following:
"product"
"rbac_group_id"
"user_id"
limit: optional number
Number of results per page (1-1000, default 100).
minimum1
maximum1000
order: optional "asc" or "desc"
Sort direction: `asc` or `desc`. Defaults to `asc` for the endpoint's sort column and to `desc` when `order_by` names a metric (a top-N ranking). Applies to `order_by`, or to the endpoint's default sort field when `order_by` is omitted.
One of the following:
"asc"
"desc"
order_by: optional string
Sort field. Restricted to the endpoint's sort column plus its rankable metrics (metrics default to descending; a few metrics rank in date-range mode only, per the endpoint's documented orderable set).
page: optional string
Opaque cursor from a previous response's `next_page` field.
starting_date: optional string
UTC date in YYYY-MM-DD format. Start of a date range (inclusive). Enables rollup mode: one row per entity aggregated over the whole range — addable counters are summed across days, and a distinct count is never summed where summing could double-count (a field's range value is recomputed exactly over the window, approximate via HLL with typical error under 2%, null, or — for the creation-event counts, whose per-day values cannot overlap — a per-day sum that is itself exact; each field's own description says which). Use either `date` or `starting_date`, not both. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day) and may be revised by a few percent over the following days. No earlier than 2026-01-01.
formatdate
##### Returns
data: array of [BetaAnalyticsSkillActivity](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_skill_activity) { chat_metrics, claude_code_metrics, cowork_metrics, 14 more }
chat_metrics: [BetaAnalyticsSkillChatMetrics](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_skill_chat_metrics) { distinct_conversation_skill_used_count }
Claude.ai activity metrics for a single skill on a given day.
distinct_conversation_skill_used_count: number or null
Number of distinct conversations in which the skill was used. A skill counts as used only when it is explicitly activated — the model (or the user, via the skill's slash command) invokes it, reading its instructions into context as part of that activation. Skills that are merely installed or listed as available, or whose content reaches the context without an activation (preloaded, hook-injected, or read as a plain file), are not counted. Approximate (HLL, typical error \<2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.
claude_code_metrics: [BetaAnalyticsSkillClaudeCodeMetrics](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_skill_claude_code_metrics) { distinct_session_skill_used_count }
Claude Code activity metrics for a single skill on a given day.
distinct_session_skill_used_count: number or null
Number of distinct Claude Code sessions in which the skill was used. A skill counts as used only when it is explicitly activated — the model (or the user, via the skill's slash command) invokes it, reading its instructions into context as part of that activation. Skills that are merely installed or listed as available, or whose content reaches the context without an activation (preloaded, hook-injected, or read as a plain file), are not counted. Approximate (HLL, typical error \<2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.
cowork_metrics: [BetaAnalyticsSkillCoworkMetrics](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_skill_cowork_metrics) { distinct_session_skill_used_count }
Cowork activity metrics for a single skill on a given day.
distinct_session_skill_used_count: number or null
Number of distinct Cowork sessions in which the skill was used. A skill counts as used only when it is explicitly activated — the model (or the user, via the skill's slash command) invokes it, reading its instructions into context as part of that activation. Skills that are merely installed or listed as available, or whose content reaches the context without an activation (preloaded, hook-injected, or read as a plain file), are not counted. Approximate (HLL, typical error \<2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.
distinct_user_count: number
Number of distinct users who used the skill on the requested day, or, in date-range mode, over the requested window — recomputed as an exact distinct count over the window's per-member daily rows, never a sum of per-day values. A skill counts as used only when it is explicitly activated — the model (or the user, via the skill's slash command) invokes it, reading its instructions into context as part of that activation. Skills that are merely installed or listed as available, or whose content reaches the context without an activation (preloaded, hook-injected, or read as a plain file), are not counted.
office_metrics: [BetaAnalyticsSkillOfficeMetrics](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_skill_office_metrics) { excel, outlook, powerpoint, word }
Office Agent activity metrics for a single skill on a given day, broken out by Office product.
skill_name: string
Name of the skill
attributed_list_price: optional string or null
List-price (rate-card) value of the member requests attributed to this skill, as a decimal string in the minor unit of `currency` (cents for USD), from Claude Code, Cowork, and Office Agent request-level attribution — the value of requests that involved the skill, not the skill's incremental cost. Unlike `estimated_overage_spend` this reflects usage value regardless of how it was funded — seat-covered usage counts — but it is undiscounted and does not tie to billed spend or the organization's spend reporting. claude.ai chat usage carries no request-level attribution and contributes nothing: the field is null on `chat` product rows and on `office_agent` product cuts dated before 2026-06-18 (the Office Agent attribution data-start), and on ungrouped rows it covers the Claude Code + Cowork + Office Agent share only (null when no attributable usage exists). Also null under the same conditions as `estimated_overage_spend` (spend reporting not enabled for this organization, `office_agent` product cuts before the 2026-06-18 data-start). "0" means attributable usage existed but none was attributed to this skill. Addable across days: date-range rollup mode returns the window's sum. On `group_by[]` and `filter[]` shapes both amounts can total below the ungrouped value for the same skill over the same date or range: spend attributed to a member–skill pair with no counted usage on that day is excluded from those cuts.
currency: optional string or null
Currency for this row's monetary fields (`estimated_overage_spend` and `attributed_list_price`), as an uppercase ISO-4217 code. Always "USD" when either amount is populated; null whenever both amounts are null.
enable_count: optional number or null
Distinct accounts that enabled this skill on the requested day (claude.ai only — the skill analog of plugin `install_count`). The count is org-wide: null when enable reporting is not enabled for this organization, or when the request scopes to `user_id` / `rbac_group_id` / `product` via `group_by[]` or `filter[]` (an org-wide count would be misleading on per-cut rows). A distinct count, not an event count: summing across days double-counts members who enable the skill on more than one day, so it is also null in date-range rollup mode (`starting_date`/`ending_date`).
estimated_overage_spend: optional string or null
Estimated overage spend attributed to this skill, as a decimal string in the minor unit of `currency` (cents for USD; "1250" is \$12.50, fractional cents possible) — an allocation of each member's daily post-discount, pre-credit metered overage spend (the same cost basis as the organization's spend reporting and the Cost & Usage API, so per-skill figures are directly comparable; spend with no skill attribution — including any member-day without skill invocations — is not represented, so skill rows sum to at most those totals) across the skills the member used. Overage only: usage covered by included seat allowances bills nothing and allocates \$0 here — see `attributed_list_price` for the funding-independent usage-value companion. Claude Code, Cowork, and Office Agent spend use request-level skill attribution; claude.ai chat spend is approximated proportionally to skill-invoking messages. An estimate, not a billing number — and the cost of the requests/messages that involved the skill, not the skill's incremental cost (the same request would still have cost something without the skill active). "0" means no overage spend was attributed; null when spend reporting is not enabled for this organization, on `office_agent` product cuts dated before 2026-06-18 (the Office Agent attribution data-start). Addable across days: date-range rollup mode (`starting_date`/`ending_date`) returns the window's sum. With `group_by[]=user_id` each row carries the user's own attributed spend. On `group_by[]` and `filter[]` shapes both amounts can total below the ungrouped value for the same skill over the same date or range: spend attributed to a member–skill pair with no counted usage on that day is excluded from those cuts.
invocation_count: optional number or null
Total number of times this skill was invoked on the requested day (the skill analog of plugin `invocation_count`). Unlike `distinct_user_count` — which answers '# of users' — this is the true '# of uses'. A skill counts as used only when it is explicitly activated — the model (or the user, via the skill's slash command) invokes it, reading its instructions into context as part of that activation. Skills that are merely installed or listed as available, or whose content reaches the context without an activation (preloaded, hook-injected, or read as a plain file), are not counted. Null when invocation reporting is not enabled for this organization. Sum across a date range for total uses in the window — date-range rollup mode (`starting_date`/`ending_date`) returns this sum directly.
product: optional string or null
Product that produced this row's activity: one of `chat`, `claude_code`, `cowork`, or `office_agent` (the canonical Cost & Usage product naming; an `office_agent` row's per-surface breakdown is in its `office_metrics`). On `/plugins` only `cowork` and `claude_code` occur (the only surfaces with plugin attribution); on `/artifacts` only `chat`, `claude_code`, and `cowork` occur (the surfaces that create artifacts); `/apps/chat/projects` does not support the product dimension (a `product` entry in `group_by[]` or `filter[]` there is rejected). Present only when the request grouped by `product`.
rbac_group_id: optional string or null
Tagged RBAC group identifier (`rbac_group_...`), matching the spend-limits API spelling. Present only when the request grouped by `rbac_group_id`.
rbac_group_name: optional string or null
Resolved RBAC group display name, alongside `rbac_group_id` when name resolution is available. Null if the group has been deleted or its name could not be resolved; `rbac_group_id` remains the stable key.
share_status: optional "organization" or "private" or "public" or null
Skill share status (claude.ai only): one of `private`, `organization`, or `public`. Null for skills used only in Claude Code or Office (no per-skill share-status concept) and when share-status reporting is not yet available for the organization. Filterable via `filter[]=share_status:{value}`.
One of the following:
"organization"
"private"
"public"
skill_display_name: optional string or null
Human-readable display name for rows whose `skill_name` is an opaque skill id (user/organization skill types and plugin-delivered skills, whose user-defined names usage reports generally withhold). Organization-shared skills and skills delivered by the organization's own plugins (its plugin marketplaces and its library) resolve; plugin skill names are shown without their 'plugin:' prefix. The literal 'unknown' bucket row gets a fixed 'Unknown skill' label. For a member's own skill (private or personal-plugin) it is null, except when the skill's owner used it from Claude Code or Cowork in the requested period: then it shows the name that client reported at the time. Apart from that, the names of members' own skills are not disclosed to analytics-key holders. Also null for Anthropic-provided plugin skills (not resolved), for an organization skill or plugin whose name can no longer be found (for example, one since deleted), when `skill_name` is already a display name, or when display-name resolution is not enabled for this organization.
user_id: optional string or null
Tagged user identifier (e.g. `user_...`). Present only when the request grouped by `user_id`.
next_page: string or null
Opaque cursor for the next page, or null if no more results
Get Skill Usage
cURL
```python
curl https://api.anthropic.com/v1/organizations/analytics/skills \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"data": [
{
"chat_metrics": {
"distinct_conversation_skill_used_count": 0
},
"claude_code_metrics": {
"distinct_session_skill_used_count": 0
},
"cowork_metrics": {
"distinct_session_skill_used_count": 0
},
"distinct_user_count": 0,
"office_metrics": {
"excel": {
"distinct_session_skill_used_count": 0
},
"outlook": {
"distinct_session_skill_used_count": 0
},
"powerpoint": {
"distinct_session_skill_used_count": 0
},
"word": {
"distinct_session_skill_used_count": 0
}
},
"skill_name": "skill_name",
"attributed_list_price": "attributed_list_price",
"currency": "currency",
"enable_count": 0,
"estimated_overage_spend": "estimated_overage_spend",
"invocation_count": 0,
"product": "product",
"rbac_group_id": "rbac_group_id",
"rbac_group_name": "rbac_group_name",
"share_status": "organization",
"skill_display_name": "skill_display_name",
"user_id": "user_id"
}
],
"next_page": "next_page"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"chat_metrics": {
"distinct_conversation_skill_used_count": 0
},
"claude_code_metrics": {
"distinct_session_skill_used_count": 0
},
"cowork_metrics": {
"distinct_session_skill_used_count": 0
},
"distinct_user_count": 0,
"office_metrics": {
"excel": {
"distinct_session_skill_used_count": 0
},
"outlook": {
"distinct_session_skill_used_count": 0
},
"powerpoint": {
"distinct_session_skill_used_count": 0
},
"word": {
"distinct_session_skill_used_count": 0
}
},
"skill_name": "skill_name",
"attributed_list_price": "attributed_list_price",
"currency": "currency",
"enable_count": 0,
"estimated_overage_spend": "estimated_overage_spend",
"invocation_count": 0,
"product": "product",
"rbac_group_id": "rbac_group_id",
"rbac_group_name": "rbac_group_name",
"share_status": "organization",
"skill_display_name": "skill_display_name",
---
## List User Activity - Claude API Reference
Source: https://platform.claude.com/docs/en/api/http/beta/organization/analytics/users/list
Path: 04-API-Reference/Admin/platform-claude-com-http-beta-organization-analytics-users-list.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fhttp%2Fbeta%2Forganization%2Fanalytics%2Fusers%2Flist)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Summaries
Users
List User Activity
Apps
Connectors
Plugins
Skills
Artifacts
Usage Report
User Usage Report
Cost Report
User Cost Report
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Analytics](platform-claude-com-http-beta-organization-analytics.md)
5. [Users](platform-claude-com-http-beta-organization-analytics-users.md)
# List User Activity
GET/v1/organizations/analytics/users
Get per-user activity for a given day, with cursor-based pagination.
Returns activity metrics for each user in the organization, sorted by email address. Use `group_by[]` for per-RBAC-group aggregates, or `filter[]` to scope results to specific members, groups, or a chat project. Available to organizations on a Claude Enterprise plan. Requires an API key with the `read:analytics` scope.
##### Query parameters
date: optional string
UTC date in YYYY-MM-DD format. The day to get user activity for. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day) and may be revised by a few percent over the following days. No earlier than 2026-01-01.
formatdate
ending_date: optional string
UTC date in YYYY-MM-DD format. End of the date range (exclusive); only valid with `starting_date`. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day), so this can be at most today — which is also the default when omitted, resolved once when the first page is served and reused for the rest of the pagination sequence. At most 366 days after `starting_date`.
formatdate
filter: optional array of string
Filters as `dimension:value`, e.g. `filter[]=rbac_group_id:{id}`. Repeat the param for OR within a dimension and across dimensions for AND. Supported dimensions on this endpoint: `project_id`, `rbac_group_id`, `user_id`. Value forms: `project_id` takes a tagged project id (`claude_proj_...`) and scopes each member's row to their claude.ai chat activity within that project (it cannot be combined with `group_by[]` or an `rbac_group_id` filter); `rbac_group_id` takes the tagged id (`rbac_group_...`, as emitted in responses and by the spend-limits API) or a bare group UUID, and matches users who held the group at any point during each covered UTC day (time-of-usage attribution); `user_id` takes a tagged user id (`user_...`), as emitted in responses. An unsupported dimension returns 400. At most 100 entries.
maxItems100
group_by: optional array of "rbac_group_id"
Dimensions to break results out by (e.g. `group_by[]=rbac_group_id`). Supported on this endpoint: `rbac_group_id`. Rows are already per-member, so the one supported grouping aggregates them per RBAC group instead. Grouped rows carry the requested dimension values as additional fields and paginate like ungrouped responses via `next_page`; an unsupported dimension returns 400. `rbac_group_id` attributes a user to every group they held at any point during each covered UTC day, so grouped rows are not an exclusive partition and can sum above org-level totals. At most 100 entries.
maxItems100
limit: optional number
Number of results per page (1-1000, default 100).
minimum1
maximum1000
order: optional "asc" or "desc"
Sort direction: `asc` or `desc`. Defaults to `asc` for the endpoint's sort column and to `desc` when `order_by` names a metric (a top-N ranking). Applies to `order_by`, or to the endpoint's default sort field when `order_by` is omitted.
One of the following:
"asc"
"desc"
order_by: optional string
Sort field. Restricted to the endpoint's sort column plus its rankable metrics (metrics default to descending; a few metrics rank in date-range mode only, per the endpoint's documented orderable set).
page: optional string
Opaque cursor from a previous response's `next_page` field.
starting_date: optional string
UTC date in YYYY-MM-DD format. Start of a date range (inclusive). Enables rollup mode: one row per entity aggregated over the whole range — addable counters are summed across days, and a distinct count is never summed where summing could double-count (a field's range value is recomputed exactly over the window, approximate via HLL with typical error under 2%, null, or — for the creation-event counts, whose per-day values cannot overlap — a per-day sum that is itself exact; each field's own description says which). Use either `date` or `starting_date`, not both. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day) and may be revised by a few percent over the following days. No earlier than 2026-01-01.
formatdate
##### Returns
data: array of [BetaAnalyticsUserActivity](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_user_activity) { chat_metrics, claude_code_metrics, cowork_metrics, 9 more }
chat_metrics: [BetaAnalyticsChatMetrics](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_chat_metrics) { connectors_used_count, distinct_artifacts_created_count, distinct_connectors_used_count, 9 more }
Claude.ai activity metrics for a single user on a given day.
claude_code_metrics: [BetaAnalyticsClaudeCodeMetrics](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_claude_code_metrics) { core_metrics, tool_actions }
Claude Code activity metrics for a single user on a given day.
cowork_metrics: [BetaAnalyticsCoworkMetrics](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_cowork_metrics) { action_count, artifacts_created_count, connectors_used_count, 14 more }
Cowork activity metrics for a single user on a given day.
design_metrics: [BetaAnalyticsDesignMetrics](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_design_metrics) { distinct_projects_created_count, distinct_projects_used_count, distinct_session_count, message_count }
Claude Design activity metrics for a single user on a given day.
distinct_projects_created_count: number
Number of distinct Claude Design projects created. Exact in date-range mode: a creation belongs to exactly one day, so the per-day counts never overlap and their sum over the window is the exact count of distinct creations in it.
distinct_projects_used_count: number or null
Number of distinct Claude Design projects the user worked in. Approximate (HLL, typical error \<2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.
distinct_session_count: number or null
Number of distinct Claude Design sessions. Approximate (HLL, typical error \<2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.
message_count: number
Number of messages sent in Claude Design sessions
office_metrics: [BetaAnalyticsOfficeMetrics](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_office_metrics) { excel, outlook, powerpoint, word }
Office Agent activity metrics for a single user on a given day, broken out by Office product.
science_metrics: [BetaAnalyticsScienceMetrics](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_science_metrics) { delegation_count, distinct_session_count, message_count, 2 more }
Claude Science activity metrics for a single user on a given day.
delegation_count: number
Number of delegations (handoffs to a specialized agent) in Claude Science sessions
distinct_session_count: number or null
Number of distinct Claude Science sessions. Approximate (HLL, typical error \<2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.
message_count: number
Number of messages sent in Claude Science sessions
remote_compute_job_count: number
Number of remote compute jobs launched from Claude Science sessions
skills_used_count: number
Total number of skill invocations in Claude Science sessions
web_search_count: number
Number of web searches performed
distinct_user_count: optional number or null
Number of distinct active users represented by this row. Only set for grouped rollups (`group_by[]`); null for per-user rows. In date-range mode, recomputed as an exact distinct count of the group's active members over the requested window, never a sum of per-day values.
last_activity_date: optional string or null
Most recent UTC day (YYYY-MM-DD) on which the user had any counted activity, within the requested window: equal to the requested `date` in single-day mode, and to the latest active day from `starting_date` (inclusive) to `ending_date` (exclusive) in date-range rollup mode — never a day earlier than the window start. On filtered requests (`filter[]`) only days matching the filter count: with `filter[]=rbac_group_id:{id}` it is the last day the user was active while a member of that group, consistent with the row's other metrics. On grouped (`group_by[]`) rows it is the latest day any member of the group was active (the requested `date` in single-day mode). Omitted from the response while last-activity reporting is not enabled for this organization.
formatdate
rbac_group_id: optional string or null
Tagged RBAC group identifier (`rbac_group_...`), matching the spend-limits API spelling. Present only when the request grouped by `rbac_group_id`.
rbac_group_name: optional string or null
Resolved RBAC group display name, alongside `rbac_group_id` when name resolution is available. Null if the group has been deleted or its name could not be resolved; `rbac_group_id` remains the stable key.
user: optional [BetaAnalyticsUser](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_user) { type: "user", id, email_address } or null
The user this row describes. Null on rows aggregated across users.
type: "user"
Object type. Always `user`.
defaultuser
id: string
Tagged user identifier (e.g. `user_...`)
email_address: string
Email address of the user
next_page: string or null
Opaque cursor for the next page, or null if no more results
List User Activity
cURL
```python
curl https://api.anthropic.com/v1/organizations/analytics/users \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
Response 200
```python
{
"data": [
{
"chat_metrics": {
"connectors_used_count": 0,
"distinct_artifacts_created_count": 0,
"distinct_connectors_used_count": 0,
"distinct_conversation_count": 0,
"distinct_files_uploaded_count": 0,
"distinct_projects_created_count": 0,
"distinct_projects_used_count": 0,
"distinct_shared_artifacts_viewed_count": 0,
"distinct_skills_used_count": 0,
"message_count": 0,
"shared_conversations_viewed_count": 0,
"thinking_message_count": 0
},
"claude_code_metrics": {
"core_metrics": {
"artifacts_created_count": 0,
"commit_count": 0,
"distinct_session_count": 0,
"lines_of_code": {
"added_count": 0,
"removed_count": 0
},
"pull_request_count": 0
},
"tool_actions": {
"edit_tool": {
"accepted_count": 0,
"rejected_count": 0
},
"multi_edit_tool": {
"accepted_count": 0,
"rejected_count": 0
},
"notebook_edit_tool": {
"accepted_count": 0,
"rejected_count": 0
},
"write_tool": {
"accepted_count": 0,
"rejected_count": 0
}
}
},
"cowork_metrics": {
"action_count": 0,
"artifacts_created_count": 0,
"connectors_used_count": 0,
"dispatch_turn_count": 0,
"distinct_connectors_used_count": 0,
"distinct_session_count": 0,
"distinct_skills_used_count": 0,
"message_count": 0,
"skills_used_count": 0,
"distinct_plugins_used_count": 0,
"edit_tool_count": 0,
"file_edit_count": 0,
"multi_edit_tool_count": 0,
"notebook_edit_tool_count": 0,
"plugins_used_count": 0,
"sessions_with_file_edits_count": 0,
"write_tool_count": 0
},
"design_metrics": {
"distinct_projects_created_count": 0,
"distinct_projects_used_count": 0,
"distinct_session_count": 0,
"message_count": 0
},
"office_metrics": {
"excel": {
"connectors_used_count": 0,
"distinct_connectors_used_count": 0,
"distinct_session_count": 0,
"distinct_skills_used_count": 0,
"message_count": 0,
"skills_used_count": 0
},
"outlook": {
"connectors_used_count": 0,
"distinct_connectors_used_count": 0,
"distinct_session_count": 0,
"distinct_skills_used_count": 0,
"message_count": 0,
"skills_used_count": 0
},
"powerpoint": {
"connectors_used_count": 0,
"distinct_connectors_used_count": 0,
"distinct_session_count": 0,
"distinct_skills_used_count": 0,
"message_count": 0,
"skills_used_count": 0
},
"word": {
"connectors_used_count": 0,
"distinct_connectors_used_count": 0,
"distinct_session_count": 0,
"distinct_skills_used_count": 0,
"message_count": 0,
"skills_used_count": 0
}
},
"science_metrics": {
"delegation_count": 0,
"distinct_session_count": 0,
"message_count": 0,
"remote_compute_job_count": 0,
"skills_used_count": 0
},
"web_search_count": 0,
"distinct_user_count": 0,
"last_activity_date": "2019-12-27",
"rbac_group_id": "rbac_group_id",
"rbac_group_name": "rbac_group_name",
"user": {
"id": "id",
"email_address": "email_address",
"type": "user"
}
}
],
"next_page": "next_page"
}
```
##### Returns Examples
Response 200
```python
{
"data": [
{
"chat_metrics": {
"connectors_used_count": 0,
"distinct_artifacts_created_count": 0,
"distinct_connectors_used_count": 0,
"distinct_conversation_count": 0,
"distinct_files_uploaded_count": 0,
"distinct_projects_created_count": 0,
"distinct_projects_used_count": 0,
"distinct_shared_artifacts_viewed_count": 0,
"distinct_skills_used_count": 0,
"message_count": 0,
"shared_conversations_viewed_count": 0,
"thinking_message_count": 0
},
"claude_code_metrics": {
"core_metrics": {
"artifacts_created_count": 0,
"commit_count": 0,
"distinct_session_count": 0,
"lines_of_code": {
"added_count": 0,
"removed_count": 0
},
"pull_request_count": 0
},
"tool_actions": {
"edit_tool": {
"accepted_count": 0,
"rejected_count": 0
},
"multi_edit_tool": {
"accepted_count": 0,
"rejected_count": 0
},
"notebook_edit_tool": {
"accepted_count": 0,
"rejected_count": 0
},
"write_tool": {
"accepted_count": 0,
"rejected_count": 0
}
}
},
"cowork_metrics": {
"action_count": 0,
"artifacts_created_count": 0,
"connectors_used_count": 0,
"dispatch_turn_count": 0,
"distinct_connectors_used_count": 0,
"distinct_session_count": 0,
"distinct_skills_used_count": 0,
"message_count": 0,
"skills_used_count": 0,
"distinct_plugins_used_count": 0,
"edit_tool_count": 0,
"file_edit_count": 0,
"multi_edit_tool_count": 0,
"notebook_edit_tool_count": 0,
"plugins_used_count": 0,
"sessions_with_file_edits_count": 0,
"write_tool_count": 0
},
"design_metrics": {
"distinct_projects_created_count": 0,
"distinct_projects_used_count": 0,
"distinct_session_count": 0,
"message_count": 0
},
"office_metrics": {
"excel": {
"connectors_used_count": 0,
"distinct_connectors_used_count": 0,
"distinct_session_count": 0,
"distinct_skills_used_count": 0,
"message_count": 0,
"skills_used_count": 0
},
"outlook": {
"connectors_used_count": 0,
"distinct_connectors_used_count": 0,
"distinct_session_count": 0,
"distinct_skills_used_count": 0,
"message_count": 0,
"skills_used_count": 0
},
"powerpoint": {
"connectors_used_count": 0,
"distinct_connectors_used_count": 0,
"distinct_session_count": 0,
"distinct_skills_used_count": 0,
"message_count": 0,
"skills_used_count": 0
},
"word": {
"connectors_used_count": 0,
"distinct_connectors_used_count": 0,
"distinct_session_count": 0,
"distinct_skills_used_count": 0,
"message_count": 0,
"skills_used_count": 0
}
},
"science_metrics": {
"delegation_count": 0,
"distinct_session_count": 0,
"message_count": 0,
"remote_compute_job_count": 0,
"skills_used_count": 0
},
"web_search_count": 0,
"distinct_user_count": 0,
"last_activity_date": "2019-12-27",
"rbac_group_id": "rbac_group_id",
"rbac_group_name": "rbac_group_name",
"user": {
"id": "id",
"email_address": "email_address",
---
## Users - Claude API Reference
Source: https://platform.claude.com/docs/en/api/http/beta/organization/analytics/users
Path: 04-API-Reference/Admin/platform-claude-com-http-beta-organization-analytics-users.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fhttp%2Fbeta%2Forganization%2Fanalytics%2Fusers)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Summaries
Users
List User Activity
Apps
Connectors
Plugins
Skills
Artifacts
Usage Report
User Usage Report
Cost Report
User Cost Report
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
4. [Analytics](platform-claude-com-http-beta-organization-analytics.md)
# Users
##### [List User Activity](platform-claude-com-http-beta-organization-analytics-users-list.md)
GET/v1/organizations/analytics/users
Get per-user activity for a given day, with cursor-based pagination.
---
## Analytics - Claude API Reference
Source: https://platform.claude.com/docs/en/api/http/beta/organization/analytics
Path: 04-API-Reference/Admin/platform-claude-com-http-beta-organization-analytics.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fhttp%2Fbeta%2Forganization%2Fanalytics)
SearchCtrlK
Include beta APIsThe API you’re viewing is only available in beta
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Summaries
Users
Apps
Connectors
Plugins
Skills
Artifacts
Usage Report
User Usage Report
Cost Report
User Cost Report
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
3. [Organization](platform-claude-com-http-beta-organization.md)
# Analytics
##### Models
BetaAnalyticsArtifactActivity object{ artifact_type, artifacts_created_count, distinct_user_count, 6 more }
Artifact-creation activity for one (`artifact_type`, `is_shared`) bucket on a given day.
Artifacts form a small finite cube — the canonical MIME type (8 values incl. `other`) crossed with shared-vs-private — so the response is the full set of non-empty buckets, not a ranked/paginated list. Claude Code and Cowork artifacts report under `text/html` and are counted from 2026-08-17 onward; earlier days contain claude.ai chat artifacts only. With `group_by[]=product` / `user_id` / `rbac_group_id` each row is further split by the flat group keys and counts are scoped to that cut.
BetaAnalyticsChatMetrics object{ connectors_used_count, distinct_artifacts_created_count, distinct_connectors_used_count, 9 more }
Claude.ai activity metrics for a single user on a given day.
BetaAnalyticsClaudeCodeMetrics object{ core_metrics, tool_actions }
Claude Code activity metrics for a single user on a given day.
BetaAnalyticsClaudeTagCategory = "dm" or "engaged" or "monitoring" or 2 more
One of the following:
"dm"
"engaged"
"monitoring"
"proactive"
"scheduled"
BetaAnalyticsConnectorActivity object{ chat_metrics, claude_code_metrics, connector_name, 13 more }
Per-connector activity data for a given day.
BetaAnalyticsConnectorChatMetrics object{ distinct_conversation_connector_used_count }
Claude.ai activity metrics for a single connector on a given day.
distinct_conversation_connector_used_count: number or null
Number of distinct conversations in which the connector was used. Approximate (HLL, typical error \<2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.
BetaAnalyticsConnectorClaudeCodeMetrics object{ distinct_session_connector_used_count }
Claude Code activity metrics for a single connector on a given day.
distinct_session_connector_used_count: number or null
Number of distinct Claude Code sessions in which the connector was used. Approximate (HLL, typical error \<2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.
BetaAnalyticsConnectorCoworkMetrics object{ distinct_session_connector_used_count }
Cowork activity metrics for a single connector on a given day.
distinct_session_connector_used_count: number or null
Number of distinct Cowork sessions in which the connector was used. Approximate (HLL, typical error \<2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.
BetaAnalyticsConnectorOfficeMetrics object{ excel, outlook, powerpoint, word }
Office Agent activity metrics for a single connector on a given day, broken out by Office product.
BetaAnalyticsConnectorOfficeProductMetrics object{ distinct_session_connector_used_count }
Office Agent activity metrics for a single connector on a given day within one Office product.
distinct_session_connector_used_count: number or null
Number of distinct Office Agent sessions in which the connector was used. Approximate (HLL, typical error \<2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.
BetaAnalyticsContextWindow = "0-200k" or "200k-1M"
One of the following:
"0-200k"
"200k-1M"
BetaAnalyticsCoreCodeMetrics object{ artifacts_created_count, commit_count, distinct_session_count, 2 more }
Core Claude Code activity metrics for a single user on a given day.
artifacts_created_count: number
Number of artifacts created in Claude Code sessions: an artifact counts once, on the day a session first saves it. Counted from 2026-08-17; 0 on earlier days. Exact in date-range mode: a creation belongs to exactly one day, so the per-day counts never overlap and their sum over the window is the exact count of distinct creations in it.
commit_count: number
Number of commits made via Claude Code
distinct_session_count: number or null
Number of distinct Claude Code sessions. On aggregated rows and in date-range mode: summed per-day distinct counts. A session essentially never spans a UTC day, so the sum is in practice the true distinct count.
lines_of_code: [BetaAnalyticsLinesOfCode](platform-claude-com-http-beta-organization-analytics.md#beta_analytics_lines_of_code) { added_count, removed_count }
Lines of code added and removed via Claude Code.
added_count: number
Lines of code added
removed_count: number
Lines of code removed
pull_request_count: number
Number of pull requests created via Claude Code
BetaAnalyticsCostBucketedResult object{ amount, claude_tag_category, claude_tag_user_id, 12 more }
BetaAnalyticsCostReportTimeBucket object{ ending_at, results, starting_at }
BetaAnalyticsCostType = "code_execution" or "tokens" or "web_search"
One of the following:
"code_execution"
"tokens"
"web_search"
BetaAnalyticsCostUsersItem object{ actor, amount, claude_tag_category, 15 more }
BetaAnalyticsCoworkMetrics object{ action_count, artifacts_created_count, connectors_used_count, 14 more }
Cowork activity metrics for a single user on a given day.
BetaAnalyticsDesignMetrics object{ distinct_projects_created_count, distinct_projects_used_count, distinct_session_count, message_count }
Claude Design activity metrics for a single user on a given day.
distinct_projects_created_count: number
Number of distinct Claude Design projects created. Exact in date-range mode: a creation belongs to exactly one day, so the per-day counts never overlap and their sum over the window is the exact count of distinct creations in it.
distinct_projects_used_count: number or null
Number of distinct Claude Design projects the user worked in. Approximate (HLL, typical error \<2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.
distinct_session_count: number or null
Number of distinct Claude Design sessions. Approximate (HLL, typical error \<2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.
message_count: number
Number of messages sent in Claude Design sessions
BetaAnalyticsInferenceGeoFilter = "global" or "not_available" or "us"
One of the following:
"global"
"not_available"
"us"
BetaAnalyticsLinesOfCode object{ added_count, removed_count }
Lines of code added and removed via Claude Code.
added_count: number
Lines of code added
removed_count: number
Lines of code removed
BetaAnalyticsOfficeMetrics object{ excel, outlook, powerpoint, word }
Office Agent activity metrics for a single user on a given day, broken out by Office product.
BetaAnalyticsOfficeProductMetrics object{ connectors_used_count, distinct_connectors_used_count, distinct_session_count, 3 more }
Office Agent activity metrics for a single user on a given day within one Office product.
connectors_used_count: number
Number of MCP connector invocations
distinct_connectors_used_count: number or null
Number of distinct MCP connectors used. Approximate (HLL, typical error \<2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.
distinct_session_count: number or null
Number of distinct Office Agent sessions. Approximate (HLL, typical error \<2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.
distinct_skills_used_count: number or null
Number of distinct skills used. Approximate (HLL, typical error \<2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.
message_count: number
Number of messages sent
skills_used_count: number
Number of skill invocations
BetaAnalyticsPluginActivity object{ claude_code_metrics, cowork_metrics, distinct_user_count, 8 more }
Per-plugin install + invocation activity for a given day.
With `group_by[]=user_id` / `rbac_group_id` / `product` (`cowork` / `claude_code` only on this endpoint) each row is one (plugin, user), (plugin, group), or (plugin, product) cut: the flat `user_id` / `rbac_group_id` / `product` keys carry the cut and the counts are scoped to it.
BetaAnalyticsPluginClaudeCodeMetrics object{ distinct_session_plugin_used_count }
Claude Code activity metrics for a single plugin on a given day.
distinct_session_plugin_used_count: number or null
Number of distinct Claude Code sessions in which the plugin was invoked. Null on aggregated rows where a distinct count cannot be computed.
BetaAnalyticsPluginCoworkMetrics object{ distinct_session_plugin_used_count }
Cowork activity metrics for a single plugin on a given day.
distinct_session_plugin_used_count: number or null
Number of distinct Cowork sessions in which the plugin was invoked. Null on aggregated rows where a distinct count cannot be computed.
BetaAnalyticsProductFilter = "chat" or "claude-tag" or "claude_code" or 4 more
Publicly documented product surfaces. `claude-tag` is Claude Tag, the Claude product in Slack.
One of the following:
"chat"
"claude-tag"
"claude_code"
"claude_design"
"claude_in_chrome"
"cowork"
"office_agent"
BetaAnalyticsProjectActivity object{ distinct_user_count, message_count, project_id, 8 more }
Per-project activity data for a given day.
BetaAnalyticsScienceMetrics object{ delegation_count, distinct_session_count, message_count, 2 more }
Claude Science activity metrics for a single user on a given day.
delegation_count: number
Number of delegations (handoffs to a specialized agent) in Claude Science sessions
distinct_session_count: number or null
Number of distinct Claude Science sessions. Approximate (HLL, typical error \<2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.
message_count: number
Number of messages sent in Claude Science sessions
remote_compute_job_count: number
Number of remote compute jobs launched from Claude Science sessions
skills_used_count: number
Total number of skill invocations in Claude Science sessions
BetaAnalyticsServerToolUse object{ web_search_requests }
web_search_requests: number
The number of web search requests made.
BetaAnalyticsSingleDayActivitySummary object{ assigned_seat_count, cowork_daily_active_user_count, cowork_monthly_active_user_count, 26 more }
Per-day entry in the /summaries response.
BetaAnalyticsSkillActivity object{ chat_metrics, claude_code_metrics, cowork_metrics, 14 more }
Per-skill activity data for a given day.
BetaAnalyticsSkillChatMetrics object{ distinct_conversation_skill_used_count }
Claude.ai activity metrics for a single skill on a given day.
distinct_conversation_skill_used_count: number or null
Number of distinct conversations in which the skill was used. A skill counts as used only when it is explicitly activated — the model (or the user, via the skill's slash command) invokes it, reading its instructions into context as part of that activation. Skills that are merely installed or listed as available, or whose content reaches the context without an activation (preloaded, hook-injected, or read as a plain file), are not counted. Approximate (HLL, typical error \<2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.
BetaAnalyticsSkillClaudeCodeMetrics object{ distinct_session_skill_used_count }
Claude Code activity metrics for a single skill on a given day.
distinct_session_skill_used_count: number or null
Number of distinct Claude Code sessions in which the skill was used. A skill counts as used only when it is explicitly activated — the model (or the user, via the skill's slash command) invokes it, reading its instructions into context as part of that activation. Skills that are merely installed or listed as available, or whose content reaches the context without an activation (preloaded, hook-injected, or read as a plain file), are not counted. Approximate (HLL, typical error \<2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.
BetaAnalyticsSkillCoworkMetrics object{ distinct_session_skill_used_count }
Cowork activity metrics for a single skill on a given day.
distinct_session_skill_used_count: number or null
Number of distinct Cowork sessions in which the skill was used. A skill counts as used only when it is explicitly activated — the model (or the user, via the skill's slash command) invokes it, reading its instructions into context as part of that activation. Skills that are merely installed or listed as available, or whose content reaches the context without an activation (preloaded, hook-injected, or read as a plain file), are not counted. Approximate (HLL, typical error \<2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.
BetaAnalyticsSkillOfficeMetrics object{ excel, outlook, powerpoint, word }
Office Agent activity metrics for a single skill on a given day, broken out by Office product.
BetaAnalyticsSkillOfficeProductMetrics object{ distinct_session_skill_used_count }
Office Agent activity metrics for a single skill on a given day within one Office product.
distinct_session_skill_used_count: number or null
Number of distinct Office Agent sessions in which the skill was used. A skill counts as used only when it is explicitly activated — the model (or the user, via the skill's slash command) invokes it, reading its instructions into context as part of that activation. Skills that are merely installed or listed as available, or whose content reaches the context without an activation (preloaded, hook-injected, or read as a plain file), are not counted. Approximate (HLL, typical error \<2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.
BetaAnalyticsTokenType = "cache_creation.ephemeral_1h_input_tokens" or "cache_creation.ephemeral_5m_input_tokens" or "cache_read_input_tokens" or 2 more
One of the following:
"cache_creation.ephemeral_1h_input_tokens"
"cache_creation.ephemeral_5m_input_tokens"
"cache_read_input_tokens"
"output_tokens"
"uncached_input_tokens"
BetaAnalyticsToolActionCounts object{ accepted_count, rejected_count }
Accepted/rejected counts for a single Claude Code tool type.
accepted_count: number
Number of tool proposals accepted
rejected_count: number
Number of tool proposals rejected
BetaAnalyticsToolActions object{ edit_tool, multi_edit_tool, notebook_edit_tool, write_tool }
Per-tool accepted/rejected counts for Claude Code file modification tools.
BetaAnalyticsUsageBucketedResult object{ cache_creation, cache_read_input_tokens, claude_tag_category, 12 more }
BetaAnalyticsUsageReportTimeBucket object{ ending_at, results, starting_at }
BetaAnalyticsUsageUsersItem object{ actor, cache_creation, cache_read_input_tokens, 16 more }
BetaAnalyticsUser object{ type: "user", id, email_address }
A user in the organization, identified by tagged id and email address.
type: "user"
Object type. Always `user`.
defaultuser
id: string
Tagged user identifier (e.g. `user_...`)
email_address: string
Email address of the user
BetaAnalyticsUserActivity object{ chat_metrics, claude_code_metrics, cowork_metrics, 9 more }
Per-user activity data for a given day.
BetaAnalyticsUserActor object{ type: "user_actor", deleted, email, 3 more }
type: "user_actor"
Actor type. Always `"user_actor"`.
deleted: boolean
True when the account has been deleted, or when the user is no longer a member of the organization or its associated organizations (for example, their membership was removed or they were deprovisioned via your identity provider). `email_address` stays populated for removed users and is null when the account has been deleted. `name` follows the rules described on that field. The `user_id` is still populated for reconciliation.
email_address: string or null
The user's email address, including for users who are no longer members of the organization or its associated organizations. Null when the account has been deleted (check `deleted`) and for system-minted service accounts, which have no person's mailbox behind them (check `name`).
name: string or null
The user's full name. Null when the user has not set a name. Returns `"Deleted User"` when the account itself has been deleted, or when the user is no longer a member of the organization or its associated organizations and the organization has chosen to hide the names of removed users. Otherwise, the name stays populated for removed users. Rows for system-minted service accounts render the service name (for example, `"Claude Security"` for usage by Anthropic's security-patching service) or null.
user_id: string
Tagged user ID.
email: string or nullDeprecated
Deprecated: use `email_address`, which carries the same value.
#### Analytics[Summaries](http-beta-organization-analytics-summaries.md)
##### [Get Activity Summaries](http-beta-organization-analytics-summaries-list.md)
GET/v1/organizations/analytics/summaries
Get organization-wide activity summaries for a date range.
#### Analytics[Users](platform-claude-com-http-beta-organization-analytics-users.md)
##### [List User Activity](platform-claude-com-http-beta-organization-analytics-users-list.md)
GET/v1/organizations/analytics/users
Get per-user activity for a given day, with cursor-based pagination.
#### AnalyticsAppsChat[Projects](http-beta-organization-analytics-apps-chat-projects.md)
##### [Get Chat Project Usage](http-beta-organization-analytics-apps-chat-projects-list.md)
GET/v1/organizations/analytics/apps/chat/projects
Get per-project activity for a given day, with cursor-based pagination.
#### Analytics[Connectors](http-beta-organization-analytics-connectors.md)
##### [Get Connector Usage](platform-claude-com-http-beta-organization-analytics-connectors-list.md)
GET/v1/organizations/analytics/connectors
Get per-connector usage for a given day, with cursor-based pagination.
#### Analytics[Plugins](platform-claude-com-http-beta-organization-analytics-plugins.md)
##### [Get Plugin Usage](platform-claude-com-http-beta-organization-analytics-plugins-list.md)
GET/v1/organizations/analytics/plugins
Get per-plugin install + invocation usage for a given day, with pagination.
#### Analytics[Skills](http-beta-organization-analytics-skills.md)
##### [Get Skill Usage](platform-claude-com-http-beta-organization-analytics-skills-list.md)
GET/v1/organizations/analytics/skills
Get per-skill usage for a given day, with cursor-based pagination.
#### Analytics[Artifacts](http-beta-organization-analytics-artifacts.md)
##### [Get Artifact Activity](platform-claude-com-http-beta-organization-analytics-artifacts-list.md)
GET/v1/organizations/analytics/artifacts
Get artifact-creation activity for a given day, broken out by MIME type.
#### Analytics[Usage Report](http-beta-organization-analytics-usage-report.md)
##### [Get Token Usage Over Time](http-beta-organization-analytics-usage-report-list.md)
GET/v1/organizations/analytics/usage_report
Get token usage over time across a date range.
#### Analytics[User Usage Report](http-beta-organization-analytics-user-usage-report.md)
##### [Get Per-User Token Usage](http-beta-organization-analytics-user-usage-report-list.md)
GET/v1/organizations/analytics/user_usage_report
Get per-user token usage across a date range.
#### Analytics[Cost Report](http-beta-organization-analytics-cost-report.md)
##### [Get Cost Over Time](http-beta-organization-analytics-cost-report-list.md)
GET/v1/organizations/analytics/cost_report
Get cost in USD over time across a date range.
#### Analytics[User Cost Report](http-beta-organization-analytics-user-cost-report.md)
##### [Get Per-User Cost](http-beta-organization-analytics-user-cost-report-list.md)
GET/v1/organizations/analytics/user_cost_report
Get per-user cost in USD across a date range.
---
## Organization - Claude API Reference
Source: https://platform.claude.com/docs/en/api/http/beta/organization
Path: 04-API-Reference/Admin/platform-claude-com-http-beta-organization.md
- [Managed Agents](../Other/managed-agents-overview.md)
- [Admin](../Other/manage-claude-admin-api.md)
- Resources
- [Best practices](../About/about-claude-use-case-guides-overview.md)
- [Models & pricing](../../20-Models/about-claude-models-overview.md)
- [SDKs, CLI, and libraries](../Other/cli-sdks-libraries-overview.md)
- [Claude API skill](../Agents-Tools/agents-and-tools-agent-skills-claude-api-skill.md)
- [Release notes](../../20-Models/release-notes-overview.md)
[API reference](../Endpoints/overview.md)
[Console](../Other/playground.md)[Log in](https://platform.claude.com/login?returnTo=%2Fdocs%2Fen%2Fapi%2Fhttp%2Fbeta%2Forganization)
SearchCtrlK
Include beta APIs
Using the API
[Features overview](../Endpoints/overview.md)[Beta headers](../Endpoints/beta-headers.md)[Errors](../Endpoints/errors.md)
Messages
Create a Message
Count tokens in a Message
Batches
Managed Agents
Agents
Environments
Sessions
Deployments
Deployment Runs
Vaults
Memory Stores
Dreams
Files
Upload File
List Files
Download File
Get File Metadata
Delete File
Models
List Models
Get a Model
Organization
Get Current Organization
API Keys
External Keys
Federation
Invites
Service Accounts
Users
Workspaces
Rate Limits
Compliance Settings
Usage Report
Cost Report
MCP Tunnels
Analytics
Spend Limits
RBAC Groups
RBAC Roles
Plugins
Plugin Marketplaces
Skills
Create Skill
List Skills
Get Skill
Delete Skill
Versions
Tunnels
Create Tunnel
Get Tunnel
List Tunnels
Archive Tunnel
Reveal Tunnel Token
Rotate Tunnel Token
Certificates
User Profiles
Create User Profile
List User Profiles
Get User Profile
Update User Profile
Create Enrollment URL
Compliance API
Activities
Organizations
Groups
Apps
Code
Completions
Create a Text Completion
Support & configuration
[Rate limits](../Endpoints/rate-limits.md)[Service tiers](../Endpoints/service-tiers.md)[IAM actions (Claude Platform on AWS)](../Endpoints/claude-platform-on-aws-iam-actions.md)[Versions](../Endpoints/versioning.md)[IP addresses](../Endpoints/ip-addresses.md)[Supported regions](../Endpoints/supported-regions.md)
Claude Code
[Trigger a routine](../Endpoints/claude-code-routines-fire.md)
[Console](../Other/playground.md)
Copy page
cURL
1. [API reference](../Endpoints/http.md)
2. [Beta](../Endpoints/platform-claude-com-http-beta.md)
# Organization
##### [Get Current Organization](http-beta-organization-retrieve.md)
GET/v1/organizations/me
Retrieve information about the organization associated with the authenticated API key.
##### Models
BetaOrganization object{ type: "organization", id, name }
type: "organization"
Object type.
For Organizations, this is always `"organization"`.
defaultorganization
id: string
ID of the Organization.
formatuuid
name: string
Name of the Organization.
BetaOrganizationRole = "admin" or "billing" or "claude_code_user" or 6 more
One of the following:
"admin"
"billing"
"claude_code_user"
"developer"
"managed"
"membership_admin"
"owner"
"primary_owner"
"user"
#### Organization[API Keys](https://platform.claude.com/docs/en/api/http/beta/organization/api_keys)
##### [List API Keys](https://platform.claude.com/docs/en/api/http/beta/organization/api_keys/list)
GET/v1/organizations/api_keys
##### [Retrieve API Key (Admin API)](https://platform.claude.com/docs/en/api/http/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](../Other/playground.md) in the Claude Console.
##### [Update API Key](https://platform.claude.com/docs/en/api/http/beta/organization/api_keys/update)
POST/v1/organizations/api_keys/{api_key_id}
#### Organization[External Keys](https://platform.claude.com/docs/en/api/http/beta/organization/external_keys)
##### [Create External Key](https://platform.claude.com/docs/en/api/http/beta/organization/external_keys/create)
POST/v1/organizations/external_keys
Create an external key config owned by the caller's organization.
##### [List External Keys](https://platform.claude.com/docs/en/api/http/beta/organization/external_keys/list)
GET/v1/organizations/external_keys
List external key configs in the caller's organization.
##### [Get External Key](https://platform.claude.com/docs/en/api/http/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](https://platform.claude.com/docs/en/api/http/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](https://platform.claude.com/docs/en/api/http/beta/organization/external_keys/delete)
DELETE/v1/organizations/external_keys/{external_key_id}
Delete an external key config.
##### [Validate External Key](https://platform.claude.com/docs/en/api/http/beta/organization/external_keys/validate)
POST/v1/organizations/external_keys/{external_key_id}/validate
Validate an external key config against the customer's KMS.
#### OrganizationFederation[Issuers](https://platform.claude.com/docs/en/api/http/beta/organization/federation/issuers)
##### [Create Federation Issuer](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [List Federation Issuers](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [Get Federation Issuer](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [Update Federation Issuer](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [Archive Federation Issuer](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
#### OrganizationFederation[Rules](https://platform.claude.com/docs/en/api/http/beta/organization/federation/rules)
##### [Create Federation Rule](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [List Federation Rules](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [Get Federation Rule](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [Update Federation Rule](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [Archive Federation Rule](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
#### OrganizationFederationRules[Workspaces](https://platform.claude.com/docs/en/api/http/beta/organization/federation/rules/workspaces)
##### [Add Federation Rule Workspace](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [List Federation Rule Workspaces](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [Remove Federation Rule Workspace](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
#### Organization[Invites](https://platform.claude.com/docs/en/api/http/beta/organization/invites)
##### [Create Invite](https://platform.claude.com/docs/en/api/http/beta/organization/invites/create)
POST/v1/organizations/invites
Invite a user to join the organization by email.
##### [List Invites](https://platform.claude.com/docs/en/api/http/beta/organization/invites/list)
GET/v1/organizations/invites
List the organization's invites.
##### [Get Invite](https://platform.claude.com/docs/en/api/http/beta/organization/invites/retrieve)
GET/v1/organizations/invites/{invite_id}
Retrieve an invite by ID.
##### [Delete Invite](https://platform.claude.com/docs/en/api/http/beta/organization/invites/delete)
DELETE/v1/organizations/invites/{invite_id}
Delete a pending invite.
#### Organization[Service Accounts](https://platform.claude.com/docs/en/api/http/beta/organization/service_accounts)
##### [Create Service Account](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [List Service Accounts](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [Get Service Account](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [Update Service Account](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [Archive Service Account](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
#### OrganizationService Accounts[Workspaces](https://platform.claude.com/docs/en/api/http/beta/organization/service_accounts/workspaces)
##### [Add Workspace To Service Account](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [List Workspaces For Service Account](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [Remove Workspace From Service Account](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
#### Organization[Users](https://platform.claude.com/docs/en/api/http/beta/organization/users)
##### [List Users](https://platform.claude.com/docs/en/api/http/beta/organization/users/list)
GET/v1/organizations/users
List the organization's members.
##### [Get User](https://platform.claude.com/docs/en/api/http/beta/organization/users/retrieve)
GET/v1/organizations/users/{user_id}
Retrieve a member of the organization by user ID.
##### [Update User](https://platform.claude.com/docs/en/api/http/beta/organization/users/update)
POST/v1/organizations/users/{user_id}
Update a member's organization role.
##### [Remove User](https://platform.claude.com/docs/en/api/http/beta/organization/users/remove)
DELETE/v1/organizations/users/{user_id}
Remove a member from the organization.
#### Organization[Workspaces](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces)
##### [List Workspaces](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces/list)
GET/v1/organizations/workspaces
##### [Create Workspace](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces/create)
POST/v1/organizations/workspaces
##### [Get Workspace](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces/retrieve)
GET/v1/organizations/workspaces/{workspace_id}
##### [Update Workspace](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces/update)
POST/v1/organizations/workspaces/{workspace_id}
##### [Archive Workspace](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces/archive)
POST/v1/organizations/workspaces/{workspace_id}/archive
#### OrganizationWorkspaces[Rate Limits](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces/rate_limits)
##### [List Workspace Rate Limits](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces/rate_limits/list)
GET/v1/organizations/workspaces/{workspace_id}/rate_limits
List a workspace's rate limits.
#### OrganizationWorkspaces[Members](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces/members)
##### [List Workspace Members](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces/members/list)
GET/v1/organizations/workspaces/{workspace_id}/members
##### [Create Workspace Member](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces/members/add)
POST/v1/organizations/workspaces/{workspace_id}/members
##### [Get Workspace Member](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces/members/retrieve)
GET/v1/organizations/workspaces/{workspace_id}/members/{user_id}
##### [Update Workspace Member](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces/members/update)
POST/v1/organizations/workspaces/{workspace_id}/members/{user_id}
##### [Delete Workspace Member](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces/members/remove)
DELETE/v1/organizations/workspaces/{workspace_id}/members/{user_id}
#### OrganizationWorkspaces[Service Accounts](https://platform.claude.com/docs/en/api/http/beta/organization/workspaces/service_accounts)
##### [List Service Account Workspace Members](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [Create Service Account Workspace Member](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [Get Service Account Workspace Member](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [Update Service Account Workspace Member](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
##### [Delete Service Account Workspace Member](https://platform.claude.com/docs/en/api/http/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](../Other/manage-claude-wif-admin-api.md).
#### Organization[Rate Limits](https://platform.claude.com/docs/en/api/http/beta/organization/rate_limits)
##### [List Organization Rate Limits](https://platform.claude.com/docs/en/api/http/beta/organization/rate_limits/list)
GET/v1/organizations/rate_limits
List Messages API rate limits for your organization.
#### Organization[Compliance Settings](https://platform.claude.com/docs/en/api/http/beta/organization/compliance_settings)
##### [Get Compliance Settings](https://platform.claude.com/docs/en/api/http/beta/organization/compliance_settings/retrieve)
GET/v1/organizations/compliance_settings
Retrieve your organization's Compliance Settings.
##### [Update Compliance Settings](https://platform.claude.com/docs/en/api/http/beta/organization/compliance_settings/update)
POST/v1/organizations/compliance_settings
Update your organization's Compliance Settings.
#### Organization[Usage Report](https://platform.claude.com/docs/en/api/http/beta/organization/usage_report)
##### [Get Messages Usage Report](https://platform.claude.com/docs/en/api/http/beta/organization/usage_report/retrieve_messages)
GET/v1/organizations/usage_report/messages
##### [Get Claude Code Usage Report](https://platform.claude.com/docs/en/api/http/beta/organization/usage_report/retrieve_claude_code)
GET/v1/organizations/usage_report/claude_code
Retrieve daily aggregated usage metrics for Claude Code users. Enables organizations to analyze developer productivity and build custom dashboards.
#### Organization[Cost Report](https://platform.claude.com/docs/en/api/http/beta/organization/cost_report)
##### [Get Cost Report](https://platform.claude.com/docs/en/api/http/beta/organization/cost_report/retrieve)
GET/v1/organizations/cost_report
#### Organization[MCP Tunnels](https://platform.claude.com/docs/en/api/http/beta/organization/mcp_tunnels)
##### [List Tunnels](https://platform.claude.com/docs/en/api/http/beta/organization/mcp_tunnels/list)
Deprecated
GET/v1/organizations/tunnels
**Deprecated.** This Admin API endpoint is superseded by `/v1/tunnels` on the Claude API and will be removed after a migration window. New integrations should use [`/v1/tunnels`](../Endpoints/http-beta-tunnels.md) with the `anthropic-beta: mcp-tunnels-2026-06-22` header and a WIF token carrying the `workspace:manage_tunnels` scope. Existing integrations continue to work with the `mcp-tunnels-2026-05-19` header and `org:manage_tunnels` scope during the migration window.
##### [Get Tunnel](https://platform.claude.com/docs/en/api/http/beta/organization/mcp_tunnels/retrieve)
Deprecated
GET/v1/organizations/tunnels/{tunnel_id}
**Deprecated.** This Admin API endpoint is superseded by `/v1/tunnels` on the Claude API and will be removed after a migration window. New integrations should use [`/v1/tunnels`](../Endpoints/http-beta-tunnels.md) with the `anthropic-beta: mcp-tunnels-2026-06-22` header and a WIF token carrying the `workspace:manage_tunnels` scope. Existing integrations continue to work with the `mcp-tunnels-2026-05-19` header and `org:manage_tunnels` scope during the migration window.
##### [Archive Tunnel](https://platform.claude.com/docs/en/api/http/beta/organization/mcp_tunnels/archive)
Deprecated
POST/v1/organizations/tunnels/{tunnel_id}/archive
**Deprecated.** This Admin API endpoint is superseded by `/v1/tunnels` on the Claude API and will be removed after a migration window. New integrations should use [`/v1/tunnels`](../Endpoints/http-beta-tunnels.md) with the `anthropic-beta: mcp-tunnels-2026-06-22` header and a WIF token carrying the `workspace:manage_tunnels` scope. Existing integrations continue to work with the `mcp-tunnels-2026-05-19` header and `org:manage_tunnels` scope during the migration window.
##### [Reveal Tunnel Token](https://platform.claude.com/docs/en/api/http/beta/organization/mcp_tunnels/reveal_token)
Deprecated
POST/v1/organizations/tunnels/{tunnel_id}/reveal_token
**Deprecated.** This Admin API endpoint is superseded by `/v1/tunnels` on the Claude API and will be removed after a migration window. New integrations should use [`/v1/tunnels`](../Endpoints/http-beta-tunnels.md) with the `anthropic-beta: mcp-tunnels-2026-06-22` header and a WIF token carrying the `workspace:manage_tunnels` scope. Existing integrations continue to work with the `mcp-tunnels-2026-05-19` header and `org:manage_tunnels` scope during the migration window.
##### [Rotate Tunnel Token](https://platform.claude.com/docs/en/api/http/beta/organization/mcp_tunnels/rotate_token)
Deprecated
POST/v1/organizations/tunnels/{tunnel_id}/rotate_token
**Deprecated.** This Admin API endpoint is superseded by `/v1/tunnels` on the Claude API and will be removed after a migration window. New integrations should use [`/v1/tunnels`](../Endpoints/http-beta-tunnels.md) with the `anthropic-beta: mcp-tunnels-2026-06-22` header and a WIF token carrying the `workspace:manage_tunnels` scope. Existing integrations continue to work with the `mcp-tunnels-2026-05-19` header and `org:manage_tunnels` scope during the migration window.
#### OrganizationMCP Tunnels[Tunnel Certificates](https://platform.claude.com/docs/en/api/http/beta/organization/mcp_tunnels/tunnel_certificates)
##### [Create Tunnel Certificate](https://platform.claude.com/docs/en/api/http/beta/organization/mcp_tunnels/tunnel_certificates/create)
Deprecated
POST/v1/organizations/tunnels/{tunnel_id}/certificates
**Deprecated.** This Admin API endpoint is superseded by `/v1/tunnels` on the Claude API and will be removed after a migration window. New integrations should use [`/v1/tunnels`](../Endpoints/http-beta-tunnels.md) with the `anthropic-beta: mcp-tunnels-2026-06-22` header and a WIF token carrying the `workspace:manage_tunnels` scope. Existing integrations continue to work with the `mcp-tunnels-2026-05-19` header and `org:manage_tunnels` scope during the migration window.
##### [List Tunnel Certificates](https://platform.claude.com/docs/en/api/http/beta/organization/mcp_tunnels/tunnel_certificates/list)
Deprecated
GET/v1/organizations/tunnels/{tunnel_id}/certificates
**Deprecated.** This Admin API endpoint is superseded by `/v1/tunnels` on the Claude API and will be removed after a migration window. New integrations should use [`/v1/tunnels`](../Endpoints/http-beta-tunnels.md) with the `anthropic-beta: mcp-tunnels-2026-06-22` header and a WIF token carrying the `workspace:manage_tunnels` scope. Existing integrations continue to work with the `mcp-tunnels-2026-05-19` header and `org:manage_tunnels` scope during the migration window.
##### [Get Tunnel Certificate](https://platform.claude.com/docs/en/api/http/beta/organization/mcp_tunnels/tunnel_certificates/retrieve)
Deprecated
GET/v1/organizations/tunnels/{tunnel_id}/certificates/{certificate_id}
**Deprecated.** This Admin API endpoint is superseded by `/v1/tunnels` on the Claude API and will be removed after a migration window. New integrations should use [`/v1/tunnels`](../Endpoints/http-beta-tunnels.md) with the `anthropic-beta: mcp-tunnels-2026-06-22` header and a WIF token carrying the `workspace:manage_tunnels` scope. Existing integrations continue to work with the `mcp-tunnels-2026-05-19` header and `org:manage_tunnels` scope during the migration window.
##### [Archive Tunnel Certificate](https://platform.claude.com/docs/en/api/http/beta/organization/mcp_tunnels/tunnel_certificates/archive)
Deprecated
POST/v1/organizations/tunnels/{tunnel_id}/certificates/{certificate_id}/archive
**Deprecated.** This Admin API endpoint is superseded by `/v1/tunnels` on the Claude API and will be removed after a migration window. New integrations should use [`/v1/tunnels`](../Endpoints/http-beta-tunnels.md) with the `anthropic-beta: mcp-tunnels-2026-06-22` header and a WIF token carrying the `workspace:manage_tunnels` scope. Existing integrations continue to work with the `mcp-tunnels-2026-05-19` header and `org:manage_tunnels` scope during the migration window.
#### OrganizationAnalytics[Summaries](http-beta-organization-analytics-summaries.md)
##### [Get Activity Summaries](http-beta-organization-analytics-summaries-list.md)
GET/v1/organizations/analytics/summaries
Get organization-wide activity summaries for a date range.
#### OrganizationAnalytics[Users](platform-claude-com-http-beta-organization-analytics-users.md)
##### [List User Activity](platform-claude-com-http-beta-organization-analytics-users-list.md)
GET/v1/organizations/analytics/users
Get per-user activity for a given day, with cursor-based pagination.
#### OrganizationAnalyticsAppsChat[Projects](http-beta-organization-analytics-apps-chat-projects.md)
##### [Get Chat Project Usage](http-beta-organization-analytics-apps-chat-projects-list.md)
GET/v1/organizations/analytics/apps/chat/projects
Get per-project activity for a given day, with cursor-based pagination.
#### OrganizationAnalytics[Connectors](http-beta-organization-analytics-connectors.md)
##### [Get Connector Usage](platform-claude-com-http-beta-organization-analytics-connectors-list.md)
GET/v1/organizations/analytics/connectors
Get per-connector usage for a given day, with cursor-based pagination.
#### OrganizationAnalytics[Plugins](platform-claude-com-http-beta-organization-analytics-plugins.md)
##### [Get Plugin Usage](platform-claude-com-http-beta-organization-analytics-plugins-list.md)
GET/v1/organizations/analytics/plugins
Get per-plugin install + invocation usage for a given day, with pagination.
#### OrganizationAnalytics[Skills](http-beta-organization-analytics-skills.md)
##### [Get Skill Usage](platform-claude-com-http-beta-organization-analytics-skills-list.md)
GET/v1/organizations/analytics/skills
Get per-skill usage for a given day, with cursor-based pagination.
#### OrganizationAnalytics[Artifacts](http-beta-organization-analytics-artifacts.md)
##### [Get Artifact Activity](platform-claude-com-http-beta-organization-analytics-artifacts-list.md)
GET/v1/organizations/analytics/artifacts
Get artifact-creation activity for a given day, broken out by MIME type.
#### OrganizationAnalytics[Usage Report](http-beta-organization-analytics-usage-report.md)
##### [Get Token Usage Over Time](http-beta-organization-analytics-usage-report-list.md)
GET/v1/organizations/analytics/usage_report
Get token usage over time across a date range.
#### OrganizationAnalytics[User Usage Report](http-beta-organization-analytics-user-usage-report.md)
##### [Get Per-User Token Usage](http-beta-organization-analytics-user-usage-report-list.md)
GET/v1/organizations/analytics/user_usage_report
Get per-user token usage across a date range.
#### OrganizationAnalytics[Cost Report](http-beta-organization-analytics-cost-report.md)
##### [Get Cost Over Time](http-beta-organization-analytics-cost-report-list.md)
GET/v1/organizations/analytics/cost_report
Get cost in USD over time across a date range.
#### OrganizationAnalytics[User Cost Report](http-beta-organization-analytics-user-cost-report.md)
##### [Get Per-User Cost](http-beta-organization-analytics-user-cost-report-list.md)
GET/v1/organizations/analytics/user_cost_report
Get per-user cost in USD across a date range.
#### Organization[Spend Limits](https://platform.claude.com/docs/en/api/http/beta/organization/spend_limits)
##### [Set Spend Limit](https://platform.claude.com/docs/en/api/http/beta/organization/spend_limits/set)
POST/v1/organizations/spend_limits
Set a spend limit.
##### [Get Spend Limit](https://platform.claude.com/docs/en/api/http/beta/organization/spend_limits/retrieve)
GET/v1/organizations/spend_limits/{spend_limit_id}
Retrieve a spend limit by ID.
##### [Delete Spend Limit](https://platform.claude.com/docs/en/api/http/beta/organization/spend_limits/delete)
DELETE/v1/organizations/spend_limits/{spend_limit_id}
Delete a spend limit.
##### [List Spend Limits](https://platform.claude.com/docs/en/api/http/beta/organization/spend_limits/list)
GET/v1/organizations/spend_limits
List the organization's spend limits.
#### OrganizationSpend Limits[Effective](https://platform.claude.com/docs/en/api/http/beta/organization/spend_limits/effective)
##### [List Effective Spend Limits](https://platform.claude.com/docs/en/api/http/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 Limits[Increase Requests](https://platform.claude.com/docs/en/api/http/beta/organization/spend_limits/increase_requests)
##### [List Spend Limit Increase Requests](https://platform.claude.com/docs/en/api/http/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](https://platform.claude.com/docs/en/api/http/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](https://platform.claude.com/docs/en/api/http/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](https://platform.claude.com/docs/en/api/http/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.
#### Organization[RBAC Groups](https://platform.claude.com/docs/en/api/http/beta/organization/rbac_groups)
##### [Create RBAC Group](https://platform.claude.com/docs/en/api/http/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](https://platform.claude.com/docs/en/api/http/beta/organization/rbac_groups/list)
GET/v1/organizations/rbac_groups
List RBAC Groups in the Claude Enterprise tenant.
##### [Get RBAC Group](https://platform.claude.com/docs/en/api/http/beta/organization/rbac_groups/retrieve)
GET/v1/organizations/rbac_groups/{rbac_group_id}
Retrieve an RBAC Group by ID.
##### [Update RBAC Group](https://platform.claude.com/docs/en/api/http/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](https://platform.claude.com/docs/en/api/http/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 Groups[Members](https://platform.claude.com/docs/en/api/http/beta/organization/rbac_groups/members)
##### [List RBAC Group Members](https://platform.claude.com/docs/en/api/http/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](https://platform.claude.com/docs/en/api/http/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](https://platform.claude.com/docs/en/api/http/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.
#### Organization[RBAC Roles](https://platform.claude.com/docs/en/api/http/beta/organization/rbac_roles)
##### [List RBAC Roles](https://platform.claude.com/docs/en/api/http/beta/organization/rbac_roles/list)
GET/v1/organizations/rbac_roles
List RBAC Roles in the organization.
##### [Get RBAC Role](https://platform.claude.com/docs/en/api/http/beta/organization/rbac_roles/retrieve)
GET/v1/organizations/rbac_roles/{rbac_role_id}
Retrieve an RBAC Role by ID.
#### OrganizationRBAC Roles[Permissions](https://platform.claude.com/docs/en/api/http/beta/organization/rbac_roles/permissions)
##### [List RBAC Role Permissions](https://platform.claude.com/docs/en/api/http/beta/organization/rbac_roles/permissions/list)
GET/v1/organizations/rbac_roles/{rbac_role_id}/permissions
List the permissions an RBAC Role grants.
#### Organization[Plugins](https://platform.claude.com/docs/en/api/http/beta/organization/plugins)
##### [Create Plugin](https://platform.claude.com/docs/en/api/http/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](https://platform.claude.com/docs/en/api/http/beta/organization/plugins/retrieve)
GET/v1/organizations/plugins/{plugin_id}
Retrieve a Plugin by ID.
##### [Update Plugin](https://platform.claude.com/docs/en/api/http/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](https://platform.claude.com/docs/en/api/http/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](https://platform.claude.com/docs/en/api/http/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.
#### OrganizationPlugins[Versions](https://platform.claude.com/docs/en/api/http/beta/organization/plugins/versions)
##### [Create Plugin Version](https://platform.claude.com/docs/en/api/http/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](https://platform.claude.com/docs/en/api/http/beta/organization/plugins/versions/list)
GET/v1/organizations/plugins/{plugin_id}/versions
List a Plugin's versions, newest first.
##### [Get Plugin Version](https://platform.claude.com/docs/en/api/http/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](https://platform.claude.com/docs/en/api/http/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.
#### OrganizationPlugins[Installation Settings](https://platform.claude.com/docs/en/api/http/beta/organization/plugins/installation_settings)
##### [List Plugin Installation Settings](https://platform.claude.com/docs/en/api/http/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](https://platform.claude.com/docs/en/api/http/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](https://platform.claude.com/docs/en/api/http/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.
#### OrganizationPlugins[Shares](https://platform.claude.com/docs/en/api/http/beta/organization/plugins/shares)
##### [List Plugin Shares](https://platform.claude.com/docs/en/api/http/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.
#### Organization[Plugin Marketplaces](https://platform.claude.com/docs/en/api/http/beta/organization/plugin_marketplaces)
##### [List Plugin Marketplaces](https://platform.claude.com/docs/en/api/http/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](https://platform.claude.com/docs/en/api/http/beta/organization/plugin_marketplaces/retrieve)
GET/v1/organizations/plugin_marketplaces/{marketplace_id}
Retrieve a plugin marketplace by ID.
##### [Update Plugin Marketplace](https://platform.claude.com/docs/en/api/http/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](https://platform.claude.com/docs/en/api/http/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](https://platform.claude.com/docs/en/api/http/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.