Claude Platform Docs

List Workspaces

$client->beta->organization->workspaces->list(?string afterID, ?string beforeID, ?bool includeArchived, ?int limit): Page<Workspace>
GET/v1/organizations/workspaces

List Workspaces

Parameters
afterID?:optional string

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

beforeID?:optional string

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

includeArchived?:optional bool

Whether to include Workspaces that have been archived in the response

defaultfalse
limit?:optional int

Number of items to return per page.

Defaults to 20. Ranges from 1 to 1000.

default20
Returns
class Workspace { $type = 'workspace'; $id; $archivedAt; /* 7 more */ }
List Workspaces
<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

$client = new Client(apiKey: 'my-anthropic-api-key');

$page = $client->beta->organization->workspaces->list(
  afterID: 'after_id', beforeID: 'before_id', includeArchived: true, limit: 1
);

var_dump($page);
Returns Examples
Response 200
{
  "data": [
    {
      "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ",
      "archived_at": "2024-11-01T23:59:27.427722Z",
      "compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c",
      "created_at": "2024-10-30T23:58:27.427722Z",
      "data_residency": {
        "allowed_inference_geos": "unrestricted",
        "default_inference_geo": "global",
        "workspace_geo": "us"
      },
      "display_color": "#6C5BB9",
      "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK",
      "name": "Workspace Name",
      "tags": {
        "env": "prod",
        "team": "platform"
      },
      "type": "workspace"
    }
  ],
  "first_id": "first_id",
  "has_more": true,
  "last_id": "last_id"
}