List Deployments
Query parameters
Maximum results per page. Default 20, maximum 100.
Opaque pagination cursor.
Filter by agent ID.
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.
A timestamp in RFC 3339 format
Return deployments created at or after this time (inclusive).
A timestamp in RFC 3339 format
Return deployments created at or before this time (inclusive).
When true, includes archived deployments. Default: false (exclude archived).
Headers
Response
Successful response (OK)
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
- ▲
response property
data/items/descriptionlist-of-types was widened by adding typesnullto media typeapplication/jsonof response200response-property-list-of-types-widened
- ▲
response property
data/items/initial_events/items/oneOf[BetaManagedAgentsDeploymentUserDefineOutcomeEvent]/max_iterationslist-of-types was widened by adding typesnullto media typeapplication/jsonof response200response-property-list-of-types-widened
- ▲
response property
data/items/initial_events/items/oneOf[BetaManagedAgentsDeploymentUserMessageEvent]/content/items/oneOf[BetaManagedAgentsDocumentBlock]/contextlist-of-types was widened by adding typesnullto media typeapplication/jsonof response200response-property-list-of-types-widened
- ▲
response property
data/items/initial_events/items/oneOf[BetaManagedAgentsDeploymentUserMessageEvent]/content/items/oneOf[BetaManagedAgentsDocumentBlock]/titlelist-of-types was widened by adding typesnullto media typeapplication/jsonof response200response-property-list-of-types-widened
- ▲
response property
data/items/resources/items/oneOf[BetaManagedAgentsFileResourceConfig]/mount_pathlist-of-types was widened by adding typesnullto media typeapplication/jsonof response200response-property-list-of-types-widened
- ▲
response property
data/items/resources/items/oneOf[BetaManagedAgentsGitHubRepositoryResourceConfig]/mount_pathlist-of-types was widened by adding typesnullto media typeapplication/jsonof response200response-property-list-of-types-widened
- ▲
response property
data/items/resources/items/oneOf[BetaManagedAgentsMemoryStoreResourceConfig]/instructionslist-of-types was widened by adding typesnullto media typeapplication/jsonof response200response-property-list-of-types-widened
- ▲
response property
next_pagelist-of-types was widened by adding typesnullto media typeapplication/jsonof response200response-property-list-of-types-widened
- ○
removed
BetaManagedAgentsBudgetfrom thedata/items/budgetresponse propertyallOflist for the response status200response-property-all-of-removed
- ○
removed
BetaManagedAgentsDeploymentPausedReasonfrom thedata/items/paused_reasonresponse propertyallOflist for the response status200response-property-all-of-removed
- ○
removed
BetaManagedAgentsMountModefrom thedata/items/resources/items/oneOf[BetaManagedAgentsMemoryStoreResourceConfig]/accessresponse propertyallOflist for the response status200response-property-all-of-removed
- ○
removed
BetaManagedAgentsRepositoryCheckoutfrom thedata/items/resources/items/oneOf[BetaManagedAgentsGitHubRepositoryResourceConfig]/checkoutresponse propertyallOflist for the response status200response-property-all-of-removed
- ○
removed
BetaManagedAgentsSchedulefrom thedata/items/scheduleresponse propertyallOflist for the response status200response-property-all-of-removed
- ○
removed
BetaTimestampfrom thedata/items/archived_atresponse propertyallOflist for the response status200response-property-all-of-removed
- ○
added
BetaManagedAgentsBudgetsubschema #2to thedata/items/budgetresponse propertyanyOflist for the response status200response-property-any-of-added
- ○
added
BetaManagedAgentsDeploymentPausedReasonsubschema #2to thedata/items/paused_reasonresponse propertyanyOflist for the response status200response-property-any-of-added
- ○
added
BetaManagedAgentsMountModesubschema #2to thedata/items/resources/items/oneOf[BetaManagedAgentsMemoryStoreResourceConfig]/accessresponse propertyanyOflist for the response status200response-property-any-of-added
- ○
added
BetaManagedAgentsRepositoryCheckoutsubschema #2to thedata/items/resources/items/oneOf[BetaManagedAgentsGitHubRepositoryResourceConfig]/checkoutresponse propertyanyOflist for the response status200response-property-any-of-added
- ○
added
BetaManagedAgentsSchedulesubschema #2to thedata/items/scheduleresponse propertyanyOflist for the response status200response-property-any-of-added
- ○
added
BetaTimestampsubschema #2to thedata/items/archived_atresponse propertyanyOflist for the response status200response-property-any-of-added
- ▲
- ▲
added
BetaManagedAgentsRedactedBlockto thedata/items/initial_events/items/oneOf[BetaManagedAgentsDeploymentUserMessageEvent]/content/items/response propertyoneOflist for the response status200response-property-one-of-added
- ○
added the optional property
data/items/budgetto the response with the200statusresponse-optional-property-added
- ○
added
redacteddiscriminator mapping keys to thedata/items/initial_events/items/oneOf[BetaManagedAgentsDeploymentUserMessageEvent]/content/items/response property for the response status200response-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
- ○