Claude Platform Docs

List Environments

GET/v1/environments

List environments with pagination support.

Query parameters
include_archived: optional boolean

Include archived environments in the response

defaultfalse
limit: optional number

Maximum number of environments to return

default20
minimum1
maximum1000
page: optional string

Opaque cursor from previous response for pagination. Pass the next_page value from the previous response.

Headers
"anthropic-version": optional string

The version of the Claude API you want to use.

Read more about versioning and our version history here.

"anthropic-beta": optional array of AnthropicBeta

Optional header to specify the beta version(s) you want to use.

One of the following:
string
"computer-use-2024-10-22"
"computer-use-2025-01-24"
"output-128k-2025-02-19"
"mcp-client-2025-04-04"
"mcp-client-2025-11-20"
"dev-full-thinking-2025-05-14"
"interleaved-thinking-2025-05-14"
"code-execution-2025-05-22"
"context-1m-2025-08-07"
"context-management-2025-06-27"
"model-context-window-exceeded-2025-08-26"
"fast-mode-2026-02-01"
"output-300k-2026-03-24"
"user-profiles-2026-03-24"
"user-profiles-2026-08-18"
"user-profiles-2026-09-04"
"advisor-tool-2026-03-01"
"managed-agents-2026-04-01"
"dreaming-2026-04-21"
"thinking-token-count-2026-05-13"
"server-side-fallback-2026-06-01"
"server-side-fallback-2026-07-01"
"fallback-credit-2026-06-01"
"fallback-credit-2026-07-01"
"agent-memory-2026-07-22"
"mid-conversation-tool-changes-2026-07-01"
"compact-2026-01-12"
"computer-use-2025-11-24"
"mcp-tunnels-2026-06-22"
"structured-outputs-2025-11-13"
"task-budgets-2026-03-13"
"thinking-display-updates-2026-08-18"
"mid-conversation-output-config-2026-07-01"
"thinking-binding-controls-2026-08-01"
"mid-conversation-system-clear-at-2026-08-21"
"compact-2026-09-04"
"inline-tools-2026-09-15"
"mcp-client-2026-09-15"
"ce-plugins-2026-09-01"
"spend-limit-reads-2026-09-26"
"telemetry-destinations-2026-08-11"
"webhooks-2026-10-07"
"admin-user-sign-out-2026-10-08"
"message-threads-2026-08-12"
"analytics-usage-cost-2026-08-24"
"experimental-claude-tag-2026-10-21"
"user-profiles-billing-2026-10-01"
"message-batches-2024-09-24"⁠Deprecated
This value is no longer needed. Remove it from your requests.
"prompt-caching-2024-07-31"⁠Deprecated
This value is no longer needed. Remove it from your requests.
"pdfs-2024-09-25"⁠Deprecated
This value is no longer needed. Remove it from your requests.
"token-counting-2024-11-01"⁠Deprecated
This value is no longer needed. Remove it from your requests.
"token-efficient-tools-2025-02-19"⁠Deprecated
This value is no longer needed. Remove it from your requests.
"files-api-2025-04-14"⁠Deprecated
Sending this value selects the beta response shapes. Removing it moves you to the current shapes, so follow the migration steps: https://platform.claude.com/docs/en/build-with-claude/files#migrate-from-files-api-2025-04-14
"extended-cache-ttl-2025-04-11"⁠Deprecated
This value is no longer needed. Remove it from your requests.
"skills-2025-10-02"⁠Deprecated
Sending this value selects the beta response shapes. Removing it moves you to the current shapes, so follow the migration steps: https://platform.claude.com/docs/en/build-with-claude/skills-guide#migrate-from-skills-2025-10-02
"cache-diagnosis-2026-04-07"⁠Deprecated
This value is no longer needed. Remove it from your requests.
"ce-user-management-2026-07-13"⁠Deprecated
This value is no longer needed. Remove it from your requests.
"anthropic-workspace-id": optional string

Optional header to select the Workspace for this request. The value is a Workspace ID (for example, wrkspc_011CZkZaBF1tNoB5wlCeusgy).

Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

Returns
data: array of BetaEnvironment { type: "environment", id, archived_at, 7 more }

List of environments.

type: "environment"

The type of object (always 'environment')

defaultenvironment
id: string

Environment identifier (e.g., 'env_...')

archived_at: string or null

RFC 3339 timestamp when environment was archived, or null if not archived

Environment configuration (either Anthropic Cloud or self-hosted)

One of the following:
BetaCloudConfig object{ type: "cloud", networking, packages }

cloud environment configuration.

BetaSelfHostedConfig object{ type: "self_hosted" }⁠

Configuration for self-hosted environments.

type: "self_hosted"

Environment type

created_at: string

RFC 3339 timestamp when environment was created

description: string or null

User-provided description for the environment; null when unset

metadata: map[string]

User-provided metadata key-value pairs

name: string

Human-readable name for the environment

updated_at: string

RFC 3339 timestamp when environment was last updated

scope: optional "organization" or "account"⁠

The visibility scope for this environment. 'organization' means visible to all accounts. 'account' means visible only to the owning account.

One of the following:
"organization"
"account"
next_page: string or null

Token for fetching the next page of results. If null, there are no more results available. Pass this value to the page parameter in the next request.

Errors

Any method can also return the general HTTP errors.

Each code below is the value of error.details.error_code in the response body.

error code claude_code_key_creator_not_memberHTTP status 400

The API key belongs to the Claude Code workspace, and the user who created it is no longer a member of the organization or of that workspace.

error code organization_on_holdHTTP status 400

Anthropic has disabled the organization for trust and safety reasons. An organization disabled for any other reason, such as billing, does not get this code. appeal_url, when present, is where the organization can appeal.

List Environments
curl https://api.anthropic.com/v1/environments \
    -H 'anthropic-version: 2026-10-21' \
    -H 'anthropic-beta: managed-agents-2026-04-01' \
    -H "Authorization: Bearer $ANTHROPIC_API_KEY"
Returns Examples
Response 200
{
  "data": [
    {
      "id": "env_011CZkZ9X2dpNyB7HsEFoRfW",
      "archived_at": null,
      "config": {
        "networking": {
          "allow_mcp_servers": false,
          "allow_package_managers": true,
          "allowed_hosts": [
            "api.example.com"
          ],
          "type": "limited"
        },
        "packages": {
          "apt": [],
          "cargo": [],
          "gem": [],
          "go": [],
          "npm": [],
          "pip": [
            "pandas",
            "numpy"
          ],
          "type": "packages"
        },
        "type": "cloud"
      },
      "created_at": "2026-03-15T10:00:00Z",
      "description": "Python environment with data-analysis packages.",
      "metadata": {},
      "name": "python-data-analysis",
      "type": "environment",
      "updated_at": "2026-03-15T10:00:00Z",
      "scope": "organization"
    }
  ],
  "next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo="
}