Anthropic Knowledge Hub

List Workspaces ​

get /v1/organizations/workspaces

List Workspaces

Query Parameters ​

  • after_id: optional string

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

  • before_id: optional string

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

  • include_archived: optional boolean

    Whether to include Workspaces that have been archived in the response

  • limit: optional number

    Number of items to return per page.

    Defaults to 20. Ranges from 1 to 1000.

Returns ​

  • data: array of Workspace

    • 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.

    • created_at: string

      RFC 3339 datetime string indicating when the Workspace was created.

    • data_residency: object { allowed_inference_geos, default_inference_geo, workspace_geo }

      Data residency configuration.

      • allowed_inference_geos: array of string or "unrestricted"

        Permitted inference geo values. 'unrestricted' means all geos are allowed.

        • array of string

        • "unrestricted"

          • "unrestricted"

      • default_inference_geo: string

        Default inference geo applied when requests omit the parameter.

      • workspace_geo: string

        Geographic region for workspace data storage. Immutable after creation.

    • display_color: string

      Hex color code representing the Workspace in the Anthropic Console.

    • name: string

      Name of the Workspace.

    • tags: map[string]

      User-defined tags as string key-value pairs. Keys may not begin with anthropic.

    • type: "workspace"

      Object type.

      For Workspaces, this is always "workspace".

      • "workspace"

  • first_id: string

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

  • has_more: boolean

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

  • last_id: string

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

Example ​

http
curl https://api.anthropic.com/v1/organizations/workspaces \
    -H 'anthropic-version: 2023-06-01' \
    -H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY"

Response ​

json
{
  "data": [
    {
      "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ",
      "archived_at": "2024-11-01T23:59:27.427722Z",
      "created_at": "2024-10-30T23:58:27.427722Z",
      "data_residency": {
        "allowed_inference_geos": "unrestricted",
        "default_inference_geo": "default_inference_geo",
        "workspace_geo": "workspace_geo"
      },
      "display_color": "#6C5BB9",
      "name": "Workspace Name",
      "tags": {
        "env": "prod",
        "team": "platform"
      },
      "type": "workspace"
    }
  ],
  "first_id": "first_id",
  "has_more": true,
  "last_id": "last_id"
}