List Deployments

get/v1/deployments?beta=true

Query parameters

limitinteger

Maximum results per page. Default 20, maximum 100.

pagestring

Opaque pagination cursor.

agent_idstring

Filter by agent ID.

status'active' | 'paused'

Lifecycle status of a deployment.

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

created_at[gte]string date-time

A timestamp in RFC 3339 format

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

created_at[lte]string date-time

A timestamp in RFC 3339 format

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

include_archivedboolean

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

Headers

x-api-keystring
anthropic-versionstring
anthropic-betastring

Response

Successful response (OK)

next_pagestring nullable

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

Example response

{
  "data": [
    {
      "type": "deployment",
      "id": "depl_011CZkZcDH3vPqd7xnEfwTai",
      "name": "Daily order report",
      "description": "Compiles yesterday's orders into a report every weekday morning.",
      "agent": {
        "type": "agent",
        "id": "agent_011CZkYpogX7uDKUyvBTophP",
        "version": 1
      },
      "environment_id": "env_011CZkZ9X2dpNyB7HsEFoRfW",
      "vault_ids": [
        "vlt_011CZkZDLs7fYzm1hXNPeRjv"
      ],
      "initial_events": [
        {
          "type": "user.message",
          "content": [
            {
              "type": "text",
              "text": "Compile yesterday's orders into report.md."
            }
          ]
        }
      ],
      "resources": [],
      "metadata": {},
      "schedule": {
        "type": "cron",
        "expression": "0 9 * * 1-5",
        "timezone": "America/Los_Angeles",
        "last_run_at": "2026-03-16T16:00:09Z",
        "upcoming_runs_at": [
          "2026-03-17T16:00:00Z",
          "2026-03-18T16:00:00Z"
        ]
      },
      "status": "active",
      "paused_reason": null,
      "created_at": "2026-03-15T10:00:00Z",
      "updated_at": "2026-03-15T10:00:00Z",
      "archived_at": null
    }
  ],
  "next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo="
}

Changes

Changed in 3 of the 67 revisions of this API.915

  • d2b230555b7f812See the full diff
    • response property data/items/description list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • response property data/items/initial_events/items/oneOf[BetaManagedAgentsDeploymentUserDefineOutcomeEvent]/max_iterations list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • response property data/items/initial_events/items/oneOf[BetaManagedAgentsDeploymentUserMessageEvent]/content/items/oneOf[BetaManagedAgentsDocumentBlock]/context list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • response property data/items/initial_events/items/oneOf[BetaManagedAgentsDeploymentUserMessageEvent]/content/items/oneOf[BetaManagedAgentsDocumentBlock]/title list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • response property data/items/resources/items/oneOf[BetaManagedAgentsFileResourceConfig]/mount_path list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • response property data/items/resources/items/oneOf[BetaManagedAgentsGitHubRepositoryResourceConfig]/mount_path list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • response property data/items/resources/items/oneOf[BetaManagedAgentsMemoryStoreResourceConfig]/instructions list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • response property next_page list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • removed BetaManagedAgentsBudget from the data/items/budget response property allOf list for the response status 200

      response-property-all-of-removed

    • removed BetaManagedAgentsDeploymentPausedReason from the data/items/paused_reason response property allOf list for the response status 200

      response-property-all-of-removed

    • removed BetaManagedAgentsMountMode from the data/items/resources/items/oneOf[BetaManagedAgentsMemoryStoreResourceConfig]/access response property allOf list for the response status 200

      response-property-all-of-removed

    • removed BetaManagedAgentsRepositoryCheckout from the data/items/resources/items/oneOf[BetaManagedAgentsGitHubRepositoryResourceConfig]/checkout response property allOf list for the response status 200

      response-property-all-of-removed

    • removed BetaManagedAgentsSchedule from the data/items/schedule response property allOf list for the response status 200

      response-property-all-of-removed

    • removed BetaTimestamp from the data/items/archived_at response property allOf list for the response status 200

      response-property-all-of-removed

    • added BetaManagedAgentsBudget subschema #2 to the data/items/budget response property anyOf list for the response status 200

      response-property-any-of-added

    • added BetaManagedAgentsDeploymentPausedReason subschema #2 to the data/items/paused_reason response property anyOf list for the response status 200

      response-property-any-of-added

    • added BetaManagedAgentsMountMode subschema #2 to the data/items/resources/items/oneOf[BetaManagedAgentsMemoryStoreResourceConfig]/access response property anyOf list for the response status 200

      response-property-any-of-added

    • added BetaManagedAgentsRepositoryCheckout subschema #2 to the data/items/resources/items/oneOf[BetaManagedAgentsGitHubRepositoryResourceConfig]/checkout response property anyOf list for the response status 200

      response-property-any-of-added

    • added BetaManagedAgentsSchedule subschema #2 to the data/items/schedule response property anyOf list for the response status 200

      response-property-any-of-added

    • added BetaTimestamp subschema #2 to the data/items/archived_at response property anyOf list for the response status 200

      response-property-any-of-added

    • added BetaManagedAgentsRedactedBlock to the data/items/initial_events/items/oneOf[BetaManagedAgentsDeploymentUserMessageEvent]/content/items/ response property oneOf list for the response status 200

      response-property-one-of-added

    • added the optional property data/items/budget to the response with the 200 status

      response-optional-property-added

    • added redacted discriminator mapping keys to the data/items/initial_events/items/oneOf[BetaManagedAgentsDeploymentUserMessageEvent]/content/items/ response property for the response status 200

      response-property-discriminator-mapping-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • endpoint added

      endpoint-added