Skip to main content
GET
/
workflows
/
v1
/
workflow-runs
Get Workflow Runs
curl --request GET \
  --url https://api-qa.interactly.ai/workflows/v1/workflow-runs \
  --header 'Authorization: Bearer <token>'
{
  "workflow_runs": [
    {
      "_id": "5eb7cf5a86d9755df3a6c593",
      "workflow_run": {
        "logical_id": "<string>",
        "workflow_id": "5eb7cf5a86d9755df3a6c593",
        "status": "not_started"
      },
      "team_id": "<string>",
      "created_by": "<string>",
      "updated_by": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 123
}

Authorizations

Authorization
string
header
required

Retrieve your API Key from Dashboard API Keys Section.

Query Parameters

filters
WorkflowRunFilter · object
required
size
integer
default:100

Number of items per page

Required range: x >= 1
page
integer
default:1

Page number

Required range: x >= 1
search
string | null

Search keywords

start
string<date-time> | null

Filter by start time (ISO 8601 format)

end
string<date-time> | null

Filter by end time (ISO 8601 format)

Response

Successful Response

Response model for a list of workflow runs. Contains a list of WorkflowRunsProjectionModel objects.

workflow_runs
WorkflowRunsProjectionModel · object[]

List of workflow runs

total
integer | null

Total number of workflow runs available without pagination.