列出工作區

GET /v1/organizations/workspaces

cURL

cURL

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

200

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

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.

Query Parameters

include_archived · boolean · default: false

Whether to include Workspaces that have been archived in the response

before_id · string

ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object.

after_id · string

ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object.

limit · integer · default: 20

Number of items to return per page.

Defaults to 20. Ranges from 1 to 1000.

Required range: 1 <= x <= 1000

Response

200

application/json

Successful Response

data · Workspace · object[] · required

Show child attributes

first_id · string | null · required

First ID in the data list. Can be used as the before_id for the previous page.

has_more · boolean · required

Indicates if there are more results in the requested page direction.

last_id · string | null · required

Last ID in the data list. Can be used as the after_id for the next page.