INinteractly
Workflow Runs

Get Workflow Runs

Changed on

Endpoint to retrieve workflow runs for a specific workflow if workflow_id is provided. Else, all workflow runs for the team are retrieved.

get/workflows/v1/workflow-runs

Request

  • Base URL
    https://api-qa.interactly.ai
  • URL
    https://api-qa.interactly.ai/workflows/v1/workflow-runs
  • Auth
    HTTP bearer

Query parameters

logical_idstring nullable

Filter by logical ID

workflow_idstring
status'not_started' | 'started' | 'running' | 'failed' | 'completed' | 'paused' | 'waiting_for_user_input' | 'cancelled' | 'aborted_looping_risk'
version_numberinteger nullable

Filter by version number

source_workflow_run_idstring
source_turn_indexinteger nullable

Narrow source_workflow_run_id to one turn. Ignored on its own — a turn index means nothing without the run it belongs to.

copilot_runs_onlyboolean

Return Emily copilot conversations instead of customer workflow runs. Copilot runs are excluded from every other listing, so this is the only way to see them. Super-admins only — the endpoint refuses it for any other role.

{
  "workflow_id": "5eb7cf5a86d9755df3a6c593",
  "source_workflow_run_id": "5eb7cf5a86d9755df3a6c593"
}
sizeinteger

Number of items per page

pageinteger

Page number

searchstring nullable

Search keywords

startstring date-time nullable

Filter by start time (ISO 8601 format)

endstring date-time nullable

Filter by end time (ISO 8601 format)

Response

Successful Response

totalinteger nullable

Total number of workflow runs available without pagination.

Example response

{
  "workflow_runs": [
    {
      "_id": "5eb7cf5a86d9755df3a6c593",
      "workflow_run": {
        "workflow_id": "5eb7cf5a86d9755df3a6c593",
        "source_workflow_run_id": "5eb7cf5a86d9755df3a6c593"
      },
      "schedule_id": "5eb7cf5a86d9755df3a6c593"
    }
  ]
}

Changes

  • 777675c8a285Revision changes
    • info

      added the optional property // to the response with the status

  • 56acbffb4fcfRevision changes
    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status