Archive Workspace

post/v1/organizations/workspaces/{workspace_id}/archive

Archive Workspace

Path ParametersExpand Collapse

workspace_id: string

ID of the Workspace.

ReturnsExpand Collapse

Workspace = object { id, archived_at, created_at, 3 more }

id: string

ID of the Workspace.

archived_at: string

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

formatdate-time

created_at: string

RFC 3339 datetime string indicating when the Workspace was created.

formatdate-time

display_color: string

Hex color code representing the Workspace in the Anthropic Console.

name: string

Name of the Workspace.

type: "workspace"

Object type.

For Workspaces, this is always "workspace".

Accepts one of the following:

"workspace"

Archive Workspace

cURL

curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/archive \
    -X POST \
    -H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY"

{
  "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ",
  "archived_at": "2024-11-01T23:59:27.427722Z",
  "created_at": "2024-10-30T23:58:27.427722Z",
  "display_color": "#6C5BB9",
  "name": "Workspace Name",
  "type": "workspace"
}

Returns Examples

{
  "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ",
  "archived_at": "2024-11-01T23:59:27.427722Z",
  "created_at": "2024-10-30T23:58:27.427722Z",
  "display_color": "#6C5BB9",
  "name": "Workspace Name",
  "type": "workspace"
}

Archive Workspace

post/v1/organizations/workspaces/{workspace_id}/archive

Archive Workspace

Path ParametersExpand Collapse

workspace_id: string

ID of the Workspace.

ReturnsExpand Collapse

Workspace = object { id, archived_at, created_at, 3 more }

id: string

ID of the Workspace.

archived_at: string

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

formatdate-time

created_at: string

RFC 3339 datetime string indicating when the Workspace was created.

formatdate-time

display_color: string

Hex color code representing the Workspace in the Anthropic Console.

name: string

Name of the Workspace.

type: "workspace"

Object type.

For Workspaces, this is always "workspace".

Accepts one of the following:

"workspace"

Archive Workspace

cURL

curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/archive \
    -X POST \
    -H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY"

{
  "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ",
  "archived_at": "2024-11-01T23:59:27.427722Z",
  "created_at": "2024-10-30T23:58:27.427722Z",
  "display_color": "#6C5BB9",
  "name": "Workspace Name",
  "type": "workspace"
}

Returns Examples

{
  "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ",
  "archived_at": "2024-11-01T23:59:27.427722Z",
  "created_at": "2024-10-30T23:58:27.427722Z",
  "display_color": "#6C5BB9",
  "name": "Workspace Name",
  "type": "workspace"
}

Archive Workspace

Path ParametersExpand Collapse

ReturnsExpand Collapse

Archive Workspace

Returns Examples

Products

Features

Models

Solutions

Claude Developer Platform

Learn

Company

Help and security

Terms and policies

Archive Workspace

Path ParametersExpand Collapse

ReturnsExpand Collapse

Archive Workspace

Returns Examples

Products

Features

Models

Solutions

Claude Developer Platform

Learn

Company

Help and security

Terms and policies