Skip to main content
POST
/
executions
/
list
List executions
curl --request POST \
  --url https://api.kaizenautomation.com/executions/list \
  --header 'Content-Type: application/json' \
  --data '{
  "status": "InProgress",
  "loginId": "<string>",
  "search": "<string>",
  "batch": "<string>",
  "workflowId": "<string>",
  "tagFilters": [
    "<string>"
  ]
}'
{
  "executions": [
    {
      "id": "<string>",
      "workflow": {
        "id": "<string>",
        "name": "<string>"
      },
      "batch": {
        "id": "<string>",
        "name": "<string>"
      },
      "logins": [
        {
          "id": "<string>",
          "name": "<string>"
        }
      ],
      "authentications": [
        {
          "browserSessionId": "<string>",
          "status": "<string>",
          "liveViewUrl": "<string>"
        }
      ],
      "contextAuthentications": [
        {
          "contextAuthenticationId": "<string>",
          "loginSummary": {
            "loginId": "<string>",
            "name": "<string>",
            "isManual": true
          },
          "authenticationStatus": "Unauthenticated"
        }
      ],
      "startTime": "2023-11-07T05:31:56Z",
      "status": "InProgress",
      "params": {},
      "name": "<string>",
      "parentExecutionId": "<string>",
      "truncatedParams": "<string>"
    }
  ],
  "total": 123
}

Body

application/json

Request parameters for listing executions

status
enum<string>

Filter executions by status

Available options:
InProgress,
Completed,
Enqueued,
Failed,
Paused
loginId
string

Filter executions by login external ID

Search executions by execution ID or parameters

batch
string

Filter executions by batch external ID

workflowId
string

Filter executions by workflow external ID

tagFilters
string[]

Filter executions by workflow tag external IDs (workflows must have all specified tags)

Response

Executions retrieved successfully

List of executions

executions
(Active Execution (In Progress or Paused) · object | Enqueued Execution · object | Completed Execution Summary · object | Failed Execution Summary · object)[]
required
  • Active Execution (In Progress or Paused)
  • Enqueued Execution
  • Active Execution (In Progress or Paused)
  • Completed Execution Summary
  • Failed Execution Summary
total
number
required

Total number of executions matching the filter criteria