Beta › Organization › Workspaces
List Workspaces
GET /v1/organizations/workspaces
List Workspaces
Query parameters
after_id: optional stringID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object.
before_id: optional stringID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object.
include_archived: optional booleanWhether to include Workspaces that have been archived in the response
default: false
limit: optional numberNumber of items to return per page.
Defaults to
20. Ranges from1to1000.default: 20, maximum: 1000, minimum: 1
Returns
data: array of BetaWorkspacetype: "workspace"Object type.
For Workspaces, this is always
"workspace".default: workspace
id: stringID of the Workspace.
archived_at: string or nullRFC 3339 datetime string indicating when the Workspace was archived, or
nullif the Workspace is not archived.format: date-time
compartment_id: stringIdentifier 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: stringRFC 3339 datetime string indicating when the Workspace was created.
format: date-time
data_residency: BetaDataResidencyData residency configuration.
allowed_inference_geos: array of string or "unrestricted"Permitted inference geo values. 'unrestricted' means all geos are allowed.
Geos = array of stringUnrestricted = "unrestricted"
default_inference_geo: stringDefault inference geo applied when requests omit the parameter.
workspace_geo: stringGeographic region for workspace data storage. Immutable after creation.
display_color: stringHex color code representing the Workspace in the Anthropic Console.
external_key_id: string or nullID 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_idstays the same.name: stringName of the Workspace.
tags: map[string]User-defined tags as string key-value pairs. Keys may not begin with
anthropic.
first_id: string or nullFirst ID in the
datalist. Can be used as thebefore_idfor the previous page.has_more: booleanIndicates if there are more results in the requested page direction.
last_id: string or nullLast ID in the
datalist. Can be used as theafter_idfor the next page.
Example
curl https://api.anthropic.com/v1/organizations/workspaces \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"Response (200)
{
"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"
}Create Workspace
POST /v1/organizations/workspaces
Create Workspace
Headers
"anthropic-beta": optional array of AnthropicBetaOptional header to specify the beta version(s) you want to use.
string"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more"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"
Body parameters
name: stringName of the Workspace.
maxLength: 40, minLength: 1
data_residency: optional BetaDataResidencyCreateConfig or nullData residency configuration for the workspace. If omitted, defaults to
workspace_geo: "us",allowed_inference_geos: "unrestricted", anddefault_inference_geo: "global".allowed_inference_geos: optional array of BetaAllowedInferenceGeo or "unrestricted" or nullPermitted 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.
Geos = array of BetaAllowedInferenceGeo"global""us"
Unrestricted = "unrestricted"
default_inference_geo: optional "global" or "us" or nullDefault inference geo applied when requests omit the parameter. Defaults to 'global' if omitted. Must be a member of
allowed_inference_geosunlessallowed_inference_geosis"unrestricted"."global""us"
workspace_geo: optional "us" or nullGeographic region for workspace data storage. Immutable after creation. Defaults to 'us' if omitted.
display_color: optional string or nullHex color code representing the Workspace in the Anthropic Console.
maxLength: 7, pattern: ^#[0-9A-Fa-f]{6}$
external_key_id: optional string or nullID 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_idstays the same.tags: optional map[string] or nullUser-defined tags as string key-value pairs. Keys may not begin with
anthropic.
Returns
BetaWorkspace objecttype: "workspace"Object type.
For Workspaces, this is always
"workspace".default: workspace
id: stringID of the Workspace.
archived_at: string or nullRFC 3339 datetime string indicating when the Workspace was archived, or
nullif the Workspace is not archived.format: date-time
compartment_id: stringIdentifier 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: stringRFC 3339 datetime string indicating when the Workspace was created.
format: date-time
data_residency: BetaDataResidencyData residency configuration.
allowed_inference_geos: array of string or "unrestricted"Permitted inference geo values. 'unrestricted' means all geos are allowed.
Geos = array of stringUnrestricted = "unrestricted"
default_inference_geo: stringDefault inference geo applied when requests omit the parameter.
workspace_geo: stringGeographic region for workspace data storage. Immutable after creation.
display_color: stringHex color code representing the Workspace in the Anthropic Console.
external_key_id: string or nullID 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_idstays the same.name: stringName of the Workspace.
tags: map[string]User-defined tags as string key-value pairs. Keys may not begin with
anthropic.
Example
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)
{
"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"
}Get Workspace
GET /v1/organizations/workspaces/\{workspace_id\}
Get Workspace
Path parameters
workspace_id: stringID of the Workspace.
Returns
BetaWorkspace objecttype: "workspace"Object type.
For Workspaces, this is always
"workspace".default: workspace
id: stringID of the Workspace.
archived_at: string or nullRFC 3339 datetime string indicating when the Workspace was archived, or
nullif the Workspace is not archived.format: date-time
compartment_id: stringIdentifier 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: stringRFC 3339 datetime string indicating when the Workspace was created.
format: date-time
data_residency: BetaDataResidencyData residency configuration.
allowed_inference_geos: array of string or "unrestricted"Permitted inference geo values. 'unrestricted' means all geos are allowed.
Geos = array of stringUnrestricted = "unrestricted"
default_inference_geo: stringDefault inference geo applied when requests omit the parameter.
workspace_geo: stringGeographic region for workspace data storage. Immutable after creation.
display_color: stringHex color code representing the Workspace in the Anthropic Console.
external_key_id: string or nullID 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_idstays the same.name: stringName of the Workspace.
tags: map[string]User-defined tags as string key-value pairs. Keys may not begin with
anthropic.
Example
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)
{
"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"
}Update Workspace
POST /v1/organizations/workspaces/\{workspace_id\}
Update Workspace
Path parameters
workspace_id: string
Body parameters
data_residency: optional BetaDataResidencyUpdateConfig or nullData residency configuration for the workspace.
allowed_inference_geos: optional array of BetaAllowedInferenceGeo or "unrestricted" or nullPermitted inference geo values. Use 'unrestricted' to allow all geos, or a list of specific geos.
Geos = array of BetaAllowedInferenceGeo"global""us"
Unrestricted = "unrestricted"
default_inference_geo: optional "global" or "us" or nullDefault inference geo applied when requests omit the parameter. Must be a member of
allowed_inference_geosunlessallowed_inference_geosis"unrestricted"."global""us"
display_color: optional stringHex color code representing the Workspace in the Anthropic Console.
maxLength: 7, pattern: ^#[0-9A-Fa-f]{6}$
external_key_id: optional stringID 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_idstays the same.name: optional stringName of the Workspace.
maxLength: 40, minLength: 1
tags: optional map[string] or nullUser-defined tags as string key-value pairs. Keys may not begin with
anthropic.
Returns
BetaWorkspace objecttype: "workspace"Object type.
For Workspaces, this is always
"workspace".default: workspace
id: stringID of the Workspace.
archived_at: string or nullRFC 3339 datetime string indicating when the Workspace was archived, or
nullif the Workspace is not archived.format: date-time
compartment_id: stringIdentifier 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: stringRFC 3339 datetime string indicating when the Workspace was created.
format: date-time
data_residency: BetaDataResidencyData residency configuration.
allowed_inference_geos: array of string or "unrestricted"Permitted inference geo values. 'unrestricted' means all geos are allowed.
Geos = array of stringUnrestricted = "unrestricted"
default_inference_geo: stringDefault inference geo applied when requests omit the parameter.
workspace_geo: stringGeographic region for workspace data storage. Immutable after creation.
display_color: stringHex color code representing the Workspace in the Anthropic Console.
external_key_id: string or nullID 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_idstays the same.name: stringName of the Workspace.
tags: map[string]User-defined tags as string key-value pairs. Keys may not begin with
anthropic.
Example
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)
{
"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"
}Archive Workspace
POST /v1/organizations/workspaces/\{workspace_id\}/archive
Archive Workspace
Path parameters
workspace_id: string
Returns
BetaWorkspace objecttype: "workspace"Object type.
For Workspaces, this is always
"workspace".default: workspace
id: stringID of the Workspace.
archived_at: string or nullRFC 3339 datetime string indicating when the Workspace was archived, or
nullif the Workspace is not archived.format: date-time
compartment_id: stringIdentifier 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: stringRFC 3339 datetime string indicating when the Workspace was created.
format: date-time
data_residency: BetaDataResidencyData residency configuration.
allowed_inference_geos: array of string or "unrestricted"Permitted inference geo values. 'unrestricted' means all geos are allowed.
Geos = array of stringUnrestricted = "unrestricted"
default_inference_geo: stringDefault inference geo applied when requests omit the parameter.
workspace_geo: stringGeographic region for workspace data storage. Immutable after creation.
display_color: stringHex color code representing the Workspace in the Anthropic Console.
external_key_id: string or nullID 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_idstays the same.name: stringName of the Workspace.
tags: map[string]User-defined tags as string key-value pairs. Keys may not begin with
anthropic.
Example
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)
{
"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"
}