Deployments.ai Docs
Workflows

List workflow executions

GET /v1/workflow-executions · SDK listWorkflowExecutions · CLI deployments workflow-execution list

GET
/v1/workflow-executions

Requires workflows:read.

Authorization

headerAuthorizationBearer <token>

Opaque bearer credential scoped to one service account and tenant.

Query Parameters

cursor?string

Opaque cursor returned by the previous page.

Length1 <= length <= 4096
limit?integer

Maximum number of resources to return.

Range1 <= value <= 100
status?string

Only return workflow executions in this status.

Value in"queued""running""waiting-for-agent""waiting-for-tool""waiting-for-approval""waiting-for-delivery""completed""failed""canceling""canceled"

Header Parameters

x-deployments-environment?string

Required with a platform bearer JWT, where the three tenant headers select an environment the caller can access through active organization membership. Optional with an API key; when supplied, it must match the key's tenant.

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$
x-deployments-organization?string

Required with a platform bearer JWT, where the three tenant headers select an environment the caller can access through active organization membership. Optional with an API key; when supplied, it must match the key's tenant.

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$
x-deployments-project?string

Required with a platform bearer JWT, where the three tenant headers select an environment the caller can access through active organization membership. Optional with an API key; when supplied, it must match the key's tenant.

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$

Response Body

ListWorkflowExecutionsResponse

application/json
  1. response
items*array<>
nextCursor?|null|null
curl -X GET "https://example.com/v1/workflow-executions"
{  "items": [    {      "environmentId": "string",      "organizationId": "string",      "projectId": "string",      "completedAt": "2019-08-24T14:15:22Z",      "createdAt": "2019-08-24T14:15:22Z",      "currentStepAttempt": 0,      "currentStepId": "string",      "id": "string",      "startedAt": "2019-08-24T14:15:22Z",      "status": "queued",      "updatedAt": "2019-08-24T14:15:22Z",      "version": 0,      "workflowContentHash": "string",      "workflowDefinitionId": "string",      "workflowReleaseId": "string",      "workflowReleaseNumber": 1,      "workspaceId": "string"    }  ],  "nextCursor": "string"}