Workflows

Get the workflow run history

get/v4/workflows/{workflowId}/history

Request

  • Base URL: https://api.kadoa.com
  • URL: https://api.kadoa.com/v4/workflows/{workflowId}/history
  • Auth: API key in header x-api-key

Path parameters

workflowIdstring required

The unique identifier of the workflow whose runs history is to be retrieved

Query parameters

pageinteger

Page number, 1-based (default 1)

limitinteger

Maximum number of runs per page (default 25, min 1, max 1000)

runIdstring

Look up one run belonging to this workflow, independently of pagination

status'success' | 'failed' | 'in_progress'

Filter runs by outcome. success maps to FINISHED, failed maps to FAILED, in_progress maps to RUNNING.

Response

History of workflow runs

workflowIdstring

Unique identifier of the workflow

totalCountinteger

Total number of workflow runs matching the query (across all pages)

Changes

No recorded changes to this operation across all 1 revision of this API.