Sign in

List Workspaces

get/v1/organizations/workspaces?beta=true

Query parameters

include_archivedboolean

Whether to include Workspaces that have been archived in the response

Whether to include Workspaces that have been archived in the response

before_idstring

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

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

after_idstring

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

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

limitinteger

Number of items to return per page.

Defaults to 20. Ranges from 1 to 1000.

Number of items to return per page.

Defaults to 20. Ranges from 1 to 1000.

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

first_idstring nullable required

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

has_moreboolean required

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

last_idstring nullable required

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

Example response

{
  "data": [
    {
      "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