List Workspaces
api/admin/workspaces/list
Nearest release: v2.1.245, published an hour after this site recorded the change. Shown because the two are within 24 hours of each other. Nothing here says the release caused the edit.
api/admin/workspaces/list Changed · +17 / -16 lines
# List Workspaces ## Query parameters ## Returns ## Example ### Response (200) ## List Workspaces ### Query Parameters ### Returns ### Example #### Response
---- -title: List Workspaces -url: https://platform.claude.com/docs/en/api/admin/workspaces/list ---- +# List Workspaces -## List Workspaces +**GET** `/v1/organizations/workspaces` -**get** `/v1/organizations/workspaces` - List Workspaces -### Query Parameters +## Query parameters - `after_id: optional string`
Whether to include Workspaces that have been archived in the response + default: false + - `limit: optional number` Number of items to return per page.
Defaults to `20`. Ranges from `1` to `1000`. -### Returns + default: 20, maximum: 1000, minimum: 1 +## Returns + - `data: array of Workspace` - `id: string`
RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived. + format: date-time + - `compartment_id: string` Identifier for this Workspace's encryption compartment. When you configure a
RFC 3339 datetime string indicating when the Workspace was created. - - `data_residency: object { allowed_inference_geos, default_inference_geo, workspace_geo }` + format: date-time + - `data_residency: object` + Data residency configuration. - `allowed_inference_geos: array of string or "unrestricted"`
- `"unrestricted"` - - `"unrestricted"` - - `default_inference_geo: string` Default inference geo applied when requests omit the parameter.
For Workspaces, this is always `"workspace"`. - - `"workspace"` + default: workspace - `first_id: string or null`
Last ID in the `data` list. Can be used as the `after_id` for the next page. -### Example +## Example -```http +```bash curl https://api.anthropic.com/v1/organizations/workspaces \ -H 'anthropic-version: 2023-06-01' \ -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" ``` -#### Response +### Response (200) ```json {