Get Workspace

GET /v1/organizations/workspaces/{workspace_id}

cURL

cURL

curl "https://api.anthropic.com/v1/organizations/workspaces/wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" \
  --header "anthropic-version: 2023-06-01" \
  --header "content-type: application/json" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY"

200

{
  "archived_at": "2024-11-01T23:59:27.427722Z",
  "created_at": "2023-11-07T05:31:56Z",
  "display_color": "<string>",
  "id": "<string>",
  "name": "<string>",
  "type": "workspace"
}

Headers

x-api-key · string · required

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-version · string · required

The version of the Claude API you want to use.

Read more about versioning and our version history here.

Path Parameters

workspace_id · string · required

ID of the Workspace.

Response

200

application/json

Successful Response

archived_at · string<date-time> | null · required

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

Example:

"2024-11-01T23:59:27.427722Z"

created_at · string<date-time> · required

RFC 3339 datetime string indicating when the Workspace was created.

Example:

"2024-10-30T23:58:27.427722Z"

display_color · string · required

Hex color code representing the Workspace in the Anthropic Console.

Example:

"#6C5BB9"

id · string · required

ID of the Workspace.

Example:

"wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"

name · string · required

Name of the Workspace.

Example:

"Workspace Name"

type · enum<string> · default: workspace · required

Object type.

For Workspaces, this is always "workspace".

Available options: workspace

Allowed value: "workspace"