ANanthropics

List Workspaces

Changed on
get/v1/organizations/workspaces

Request

  • Base URL
    https://api.anthropic.com
  • Auth
    none declared

Query parameters

include_archivedboolean

Whether to include Workspaces that have been archived in the response

include_defaultboolean

Whether to include the organization's default Workspace in the response

ids[]string[]

Only the Workspaces with these IDs, at most 100. include_archived and include_default still apply, and IDs of Workspaces the caller can't list are left out.

before_idstring

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.

limitinteger

Number of items to return per page.

Defaults to 20. Ranges from 1 to 1000.

Headers

anthropic-versionstring

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"
      },
      "user_profile_id": "uprof_01SDCCSbTxrXDpWc1phhtcfK"
    }
  ]
}

Changes