## List Deployments

`DeploymentListPageResponse Beta.Deployments.List(DeploymentListParams?parameters, CancellationTokencancellationToken = default)`

**get** `/v1/deployments`

List Deployments

### Parameters

- `DeploymentListParams parameters`

  - `string agentID`

    Query param: Filter by agent ID.

  - `DateTimeOffset createdAtGte`

    Query param: Return deployments created at or after this time (inclusive).

  - `DateTimeOffset createdAtLte`

    Query param: Return deployments created at or before this time (inclusive).

  - `Boolean includeArchived`

    Query param: When true, includes archived deployments. Default: false (exclude archived).

  - `Int limit`

    Query param: Maximum results per page. Default 20, maximum 100.

  - `string page`

    Query param: Opaque pagination cursor.

  - `BetaManagedAgentsDeploymentStatus status`

    Query param: Filter by status: active or paused. Omit for both. To include archived deployments, use include_archived instead; the two cannot be combined.

  - `IReadOnlyList<AnthropicBeta> betas`

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

    - `"message-batches-2024-09-24"MessageBatches2024_09_24`

    - `"prompt-caching-2024-07-31"PromptCaching2024_07_31`

    - `"computer-use-2024-10-22"ComputerUse2024_10_22`

    - `"computer-use-2025-01-24"ComputerUse2025_01_24`

    - `"pdfs-2024-09-25"Pdfs2024_09_25`

    - `"token-counting-2024-11-01"TokenCounting2024_11_01`

    - `"token-efficient-tools-2025-02-19"TokenEfficientTools2025_02_19`

    - `"output-128k-2025-02-19"Output128k2025_02_19`

    - `"files-api-2025-04-14"FilesApi2025_04_14`

    - `"mcp-client-2025-04-04"McpClient2025_04_04`

    - `"mcp-client-2025-11-20"McpClient2025_11_20`

    - `"dev-full-thinking-2025-05-14"DevFullThinking2025_05_14`

    - `"interleaved-thinking-2025-05-14"InterleavedThinking2025_05_14`

    - `"code-execution-2025-05-22"CodeExecution2025_05_22`

    - `"extended-cache-ttl-2025-04-11"ExtendedCacheTtl2025_04_11`

    - `"context-1m-2025-08-07"Context1m2025_08_07`

    - `"context-management-2025-06-27"ContextManagement2025_06_27`

    - `"model-context-window-exceeded-2025-08-26"ModelContextWindowExceeded2025_08_26`

    - `"skills-2025-10-02"Skills2025_10_02`

    - `"fast-mode-2026-02-01"FastMode2026_02_01`

    - `"output-300k-2026-03-24"Output300k2026_03_24`

    - `"user-profiles-2026-03-24"UserProfiles2026_03_24`

    - `"advisor-tool-2026-03-01"AdvisorTool2026_03_01`

    - `"managed-agents-2026-04-01"ManagedAgents2026_04_01`

    - `"cache-diagnosis-2026-04-07"CacheDiagnosis2026_04_07`

    - `"thinking-token-count-2026-05-13"ThinkingTokenCount2026_05_13`

    - `"server-side-fallback-2026-06-01"ServerSideFallback2026_06_01`

    - `"fallback-credit-2026-06-01"FallbackCredit2026_06_01`

### Returns

- `class DeploymentListPageResponse:`

  Paginated list of deployments.

  - `required IReadOnlyList<BetaManagedAgentsDeployment> Data`

    List of deployments.

    - `required string ID`

      Unique identifier for this deployment.

    - `required BetaManagedAgentsAgentReference Agent`

      A resolved agent reference with a concrete version.

      - `required string ID`

      - `required Type Type`

        - `"agent"Agent`

      - `required Int Version`

    - `required DateTimeOffset? ArchivedAt`

      A timestamp in RFC 3339 format

    - `required DateTimeOffset CreatedAt`

      A timestamp in RFC 3339 format

    - `required string? Description`

      Description of what the deployment does.

    - `required string EnvironmentID`

      ID of the `environment` where sessions run.

    - `required IReadOnlyList<BetaManagedAgentsDeploymentInitialEvent> InitialEvents`

      Events sent to each session immediately after creation.

      - `class BetaManagedAgentsDeploymentUserMessageEvent:`

        A user message sent to the session.

        - `required IReadOnlyList<Content> Content`

          Array of content blocks for the user message.

          - `class BetaManagedAgentsTextBlock:`

            Regular text content.

            - `required string Text`

              The text content.

            - `required Type Type`

              - `"text"Text`

          - `class BetaManagedAgentsImageBlock:`

            Image content specified directly as base64 data or as a reference via a URL.

            - `required Source Source`

              Union type for image source variants.

              - `class BetaManagedAgentsBase64ImageSource:`

                Base64-encoded image data.

                - `required string Data`

                  Base64-encoded image data.

                - `required string MediaType`

                  MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp").

                - `required Type Type`

                  - `"base64"Base64`

              - `class BetaManagedAgentsUrlImageSource:`

                Image referenced by URL.

                - `required Type Type`

                  - `"url"Url`

                - `required string Url`

                  URL of the image to fetch.

              - `class BetaManagedAgentsFileImageSource:`

                Image referenced by file ID.

                - `required string FileID`

                  ID of a previously uploaded file.

                - `required Type Type`

                  - `"file"File`

            - `required Type Type`

              - `"image"Image`

          - `class BetaManagedAgentsDocumentBlock:`

            Document content, either specified directly as base64 data, as text, or as a reference via a URL.

            - `required Source Source`

              Union type for document source variants.

              - `class BetaManagedAgentsBase64DocumentSource:`

                Base64-encoded document data.

                - `required string Data`

                  Base64-encoded document data.

                - `required string MediaType`

                  MIME type of the document (e.g., "application/pdf").

                - `required Type Type`

                  - `"base64"Base64`

              - `class BetaManagedAgentsPlainTextDocumentSource:`

                Plain text document content.

                - `required string Data`

                  The plain text content.

                - `required MediaType MediaType`

                  MIME type of the text content. Must be "text/plain".

                  - `"text/plain"TextPlain`

                - `required Type Type`

                  - `"text"Text`

              - `class BetaManagedAgentsUrlDocumentSource:`

                Document referenced by URL.

                - `required Type Type`

                  - `"url"Url`

                - `required string Url`

                  URL of the document to fetch.

              - `class BetaManagedAgentsFileDocumentSource:`

                Document referenced by file ID.

                - `required string FileID`

                  ID of a previously uploaded file.

                - `required Type Type`

                  - `"file"File`

            - `required Type Type`

              - `"document"Document`

            - `string? Context`

              Additional context about the document for the model.

            - `string? Title`

              The title of the document.

        - `required Type Type`

          - `"user.message"UserMessage`

      - `class BetaManagedAgentsDeploymentUserDefineOutcomeEvent:`

        An outcome the agent should work toward. The agent begins work on receipt.

        - `required string Description`

          What the agent should produce. This is the task specification.

        - `required Rubric Rubric`

          Rubric for grading the quality of an outcome.

          - `class BetaManagedAgentsFileRubric:`

            Rubric referenced by a file uploaded via the Files API.

            - `required string FileID`

              ID of the rubric file.

            - `required Type Type`

              - `"file"File`

          - `class BetaManagedAgentsTextRubric:`

            Rubric content provided inline as text.

            - `required string Content`

              Rubric content. Plain text or markdown — the grader treats it as freeform text.

            - `required Type Type`

              - `"text"Text`

        - `required Type Type`

          - `"user.define_outcome"UserDefineOutcome`

        - `Int? MaxIterations`

          Eval→revision cycles before giving up. Default 3, max 20.

      - `class BetaManagedAgentsDeploymentSystemMessageEvent:`

        Privileged context for the accompanying turn and all subsequent turns, appended to the session's system context as a `role: "system"` turn rather than replacing the top-level system prompt.

        - `required IReadOnlyList<BetaManagedAgentsSystemContentBlock> Content`

          System content blocks to append. Text-only.

          - `required string Text`

            The text content.

          - `required Type Type`

            - `"text"Text`

        - `required Type Type`

          - `"system.message"SystemMessage`

    - `required IReadOnlyDictionary<string, string> Metadata`

      Arbitrary key-value metadata. Maximum 16 pairs.

    - `required string Name`

      Human-readable name.

    - `required BetaManagedAgentsDeploymentPausedReason? PausedReason`

      Why a deployment is paused. Non-null exactly when `status` is `paused`.

      - `class BetaManagedAgentsManualDeploymentPausedReason:`

        The caller invoked the pause endpoint on the deployment.

        - `required Type Type`

          - `"manual"Manual`

      - `class BetaManagedAgentsErrorDeploymentPausedReason:`

        A scheduled fire recorded a failed run whose error auto-pauses the deployment.

        - `required BetaManagedAgentsDeploymentPausedReasonError Error`

          The error that triggered an auto-pause. Matches the failed run's `error.type`.

          - `class BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError:`

            The deployment's environment was archived.

            - `required Type Type`

              - `"environment_archived_error"EnvironmentArchivedError`

          - `class BetaManagedAgentsAgentArchivedDeploymentPausedReasonError:`

            The deployment's agent was archived.

            - `required Type Type`

              - `"agent_archived_error"AgentArchivedError`

          - `class BetaManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError:`

            The deployment's environment no longer exists.

            - `required Type Type`

              - `"environment_not_found_error"EnvironmentNotFoundError`

          - `class BetaManagedAgentsVaultNotFoundDeploymentPausedReasonError:`

            A vault referenced by the deployment no longer exists.

            - `required Type Type`

              - `"vault_not_found_error"VaultNotFoundError`

          - `class BetaManagedAgentsFileNotFoundDeploymentPausedReasonError:`

            A file resource referenced by the deployment no longer exists.

            - `required Type Type`

              - `"file_not_found_error"FileNotFoundError`

          - `class BetaManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError:`

            A referenced resource no longer exists and its kind was not reported.

            - `required Type Type`

              - `"session_resource_not_found_error"SessionResourceNotFoundError`

          - `class BetaManagedAgentsWorkspaceArchivedDeploymentPausedReasonError:`

            The deployment's workspace was archived.

            - `required Type Type`

              - `"workspace_archived_error"WorkspaceArchivedError`

          - `class BetaManagedAgentsOrganizationDisabledDeploymentPausedReasonError:`

            The deployment's organization is disabled.

            - `required Type Type`

              - `"organization_disabled_error"OrganizationDisabledError`

          - `class BetaManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError:`

            A memory store referenced by the deployment is archived.

            - `required Type Type`

              - `"memory_store_archived_error"MemoryStoreArchivedError`

          - `class BetaManagedAgentsSkillNotFoundDeploymentPausedReasonError:`

            A skill referenced by the deployment's agent no longer exists.

            - `required Type Type`

              - `"skill_not_found_error"SkillNotFoundError`

          - `class BetaManagedAgentsVaultArchivedDeploymentPausedReasonError:`

            A vault referenced by the deployment is archived.

            - `required Type Type`

              - `"vault_archived_error"VaultArchivedError`

          - `class BetaManagedAgentsUnknownDeploymentPausedReasonError:`

            An unrecognized error auto-paused the deployment. A fallback variant; matches a run whose `error.type` is `unknown_error`.

            - `required Type Type`

              - `"unknown_error"UnknownError`

          - `class BetaManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonError:`

            The deployment configures resources, but its environment is self-hosted and cannot mount them.

            - `required Type Type`

              - `"self_hosted_resources_unsupported_error"SelfHostedResourcesUnsupportedError`

          - `class BetaManagedAgentsMcpEgressBlockedDeploymentPausedReasonError:`

            An MCP server host used by the deployment's agent is blocked by the environment's network policy.

            - `required Type Type`

              - `"mcp_egress_blocked_error"McpEgressBlockedError`

        - `required Type Type`

          - `"error"Error`

    - `required IReadOnlyList<BetaManagedAgentsSessionResourceConfig> Resources`

      Resources attached to sessions created from this deployment. Echoes the input minus write-only credentials.

      - `class BetaManagedAgentsGitHubRepositoryResourceConfig:`

        A GitHub repository mounted into each session's container. The authorization token is write-only and never returned.

        - `required Type Type`

          - `"github_repository"GitHubRepository`

        - `required string Url`

          Github URL of the repository

        - `Checkout? Checkout`

          Branch or commit to check out. Defaults to the repository's default branch.

          - `class BetaManagedAgentsBranchCheckout:`

            - `required string Name`

              Branch name to check out.

            - `required Type Type`

              - `"branch"Branch`

          - `class BetaManagedAgentsCommitCheckout:`

            - `required string Sha`

              Full commit SHA to check out.

            - `required Type Type`

              - `"commit"Commit`

        - `string? MountPath`

          Mount path in the container. Defaults to `/workspace/<repo-name>`.

      - `class BetaManagedAgentsFileResourceConfig:`

        A file mounted into each session's container.

        - `required string FileID`

          ID of a previously uploaded file.

        - `required Type Type`

          - `"file"File`

        - `string? MountPath`

          Mount path in the container. Defaults to `/mnt/session/uploads/<file_id>`.

      - `class BetaManagedAgentsMemoryStoreResourceConfig:`

        A memory store attached to each session created from this deployment.

        - `required string MemoryStoreID`

          The memory store ID (memstore_...). Must belong to the caller's organization and workspace.

        - `required Type Type`

          - `"memory_store"MemoryStore`

        - `Access? Access`

          Access mode for an attached memory store.

          - `"read_write"ReadWrite`

          - `"read_only"ReadOnly`

        - `string? Instructions`

          Per-attachment guidance for the agent on how to use this store. Rendered into the memory section of the system prompt. Max 4096 chars.

    - `required BetaManagedAgentsSchedule? Schedule`

      5-field POSIX cron schedule with computed runtime timestamps.

      - `required string Expression`

        5-field POSIX cron expression: minute hour day-of-month month day-of-week (e.g., "0 9 * * 1-5" for weekdays at 9am). Day-of-week is 0-7 where 0 and 7 both mean Sunday. Extended cron syntax - seconds or year fields, and the special characters L, W, #, and ? - is not supported, nor are predefined shortcuts (@daily).

      - `required string Timezone`

        IANA timezone identifier (e.g., "America/Los_Angeles", "UTC").

      - `required Type Type`

        - `"cron"Cron`

      - `DateTimeOffset? LastRunAt`

        A timestamp in RFC 3339 format

      - `IReadOnlyList<DateTimeOffset> UpcomingRunsAt`

        Up to 5 timestamps of upcoming cron occurrences. Non-empty for active and paused deployments (reflects what the schedule would do if unpaused); empty once the deployment is archived (`archived_at` set). Each fire is offset by a small per-schedule jitter, so a run will actually start at or shortly after its listed time.

    - `required BetaManagedAgentsDeploymentStatus Status`

      Lifecycle status of a deployment.

      - `"active"Active`

      - `"paused"Paused`

    - `required Type Type`

      - `"deployment"Deployment`

    - `required DateTimeOffset UpdatedAt`

      A timestamp in RFC 3339 format

    - `required IReadOnlyList<string> VaultIds`

      Vault IDs supplying stored credentials for sessions created from this deployment.

  - `string? NextPage`

    Opaque cursor for the next page. Null when no more results.

### Example

```csharp
DeploymentListParams parameters = new();

var page = await client.Beta.Deployments.List(parameters);
await foreach (var item in page.Paginate())
{
    Console.WriteLine(item);
}
```

#### Response

```json
{
  "data": [
    {
      "id": "id",
      "agent": {
        "id": "agent_011CZkYqphY8vELVzwCUpqiQ",
        "type": "agent",
        "version": 1
      },
      "archived_at": "2019-12-27T18:11:19.117Z",
      "created_at": "2019-12-27T18:11:19.117Z",
      "description": "description",
      "environment_id": "environment_id",
      "initial_events": [
        {
          "content": [
            {
              "text": "Where is my order #1234?",
              "type": "text"
            }
          ],
          "type": "user.message"
        }
      ],
      "metadata": {
        "foo": "string"
      },
      "name": "name",
      "paused_reason": {
        "type": "manual"
      },
      "resources": [
        {
          "type": "github_repository",
          "url": "url",
          "checkout": {
            "name": "main",
            "type": "branch"
          },
          "mount_path": "mount_path"
        }
      ],
      "schedule": {
        "expression": "x",
        "timezone": "x",
        "type": "cron",
        "last_run_at": "2019-12-27T18:11:19.117Z",
        "upcoming_runs_at": [
          "2019-12-27T18:11:19.117Z"
        ]
      },
      "status": "active",
      "type": "deployment",
      "updated_at": "2019-12-27T18:11:19.117Z",
      "vault_ids": [
        "string"
      ]
    }
  ],
  "next_page": "next_page"
}
```
