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
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.
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="
}