List Executions

POST /v2/workflow/executions/list

List Executions

cURL

curl --request POST \
  --url https://api.velt.dev/v2/workflow/executions/list \
  --header 'Content-Type: application/json' \
  --header 'x-velt-api-key: <x-velt-api-key>' \
  --header 'x-velt-auth-token: <x-velt-auth-token>' \
  --data '
{
  "data": {
    "definitionId": "<string>",
    "status": "<string>",
    "pageSize": 123,
    "cursor": "<string>"
  }
}
'

{
  "result": {
    "items": [],
    "nextCursor": "eyJvZmZzZXQiOjEwMH0=",
    "hasMore": true
  }
}

Use this API to paginate through workflow executions. Filter by definitionId and/or status.

Endpoint

POST https://api.velt.dev/v2/workflow/executions/list

Headers

x-velt-api-key · string · required

Your API key.

x-velt-auth-token · string · required

Your Auth Token.

Body

Params

data · object · required

Show properties

definitionId · string

Filter by definition.

status · string

Filter by status. One of: pending / running / completed / failed / cancelled.

pageSize · integer

1–500.

cursor · string

Pass back the previous response’s nextCursor.

List Executions does not accept organizationId or documentId filters in v1. To narrow the result by scope, filter on the returned ExecutionView.steps[].metadata client-side, or paginate with a tighter definitionId filter.

Example Requests

List running executions for a definition

{
  "data": {
    "definitionId": "marketing-copy-approval",
    "status": "running",
    "pageSize": 50
  }
}

Paginate

{
  "data": {
    "pageSize": 50,
    "cursor": "eyJvZmZzZXQiOjEwMH0="
  }
}

Response

Success Response

{
  "result": {
    "items": [ /* ExecutionView[] */ ],
    "nextCursor": "eyJvZmZzZXQiOjEwMH0=",
    "hasMore": true
  }
}

Failure Response

{
  "error": {
    "message": "ERROR_MESSAGE",
    "status": "INVALID_ARGUMENT"
  }
}

{
  "result": {
    "items": [],
    "nextCursor": "eyJvZmZzZXQiOjEwMH0=",
    "hasMore": true
  }
}