Sign in

Get Workspace

get/v1/organizations/workspaces/{workspace_id}?beta=true

Path parameters

workspace_idstring required

ID of the Workspace.

ID of the Workspace.

Headers

x-api-keystring

Your unique Admin API key for authentication.

This key is required in the header of all Admin API requests, to authenticate your account and access Anthropic's services. Get your Admin API key through the Console.

Your unique Admin API key for authentication.

This key is required in the header of all Admin API requests, to authenticate your account and access Anthropic's services. Get your Admin API key through the Console.

anthropic-versionstring

The version of the Claude API you want to use.

Read more about versioning and our version history here.

The version of the Claude API you want to use.

Read more about versioning and our version history here.

Response

Successful Response

archived_atstring date-time nullable required

RFC 3339 datetime string indicating when the Workspace was archived, or null if the Workspace is not archived.

compartment_idstring required

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_atstring date-time required

RFC 3339 datetime string indicating when the Workspace was created.

display_colorstring required

Hex color code representing the Workspace in the Anthropic Console.

external_key_idstring nullable required

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.

idstring required

ID of the Workspace.

namestring required

Name of the Workspace.

tagsobject required

User-defined tags as string key-value pairs. Keys may not begin with anthropic.

type'workspace' required

Object type.

For Workspaces, this is always "workspace".

Example response

{
  "archived_at": "2024-11-01T23:59:27.427722Z",
  "compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c",
  "created_at": "2024-10-30T23:58:27.427722Z",
  "display_color": "#6C5BB9",
  "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK",
  "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ",
  "name": "Workspace Name",
  "tags": {
    "env": "prod",
    "team": "platform"
  }
}

Changes

Changed in 1 of the 68 revisions of this API.1