latestOpenAPI 3.0.02026-08-137192110.1 KB

75294f591cc2

Orchestration Runs

List Orchestration Runs

List all Orchestration Runs in pages, sorted by due date in descending order (most recent first). Optionally filter by Orchestration ID.

get/orchestration_runs

Query parameters

starting_afterstring

Example:ewK8sDoLNI4CFR

The cursor to use in pagination. Use the value of the next_cursor field from the response of a previous list request.

limitinteger

The number of items to return in a single page.

orchestration_idstring

Example:3LIw2FdxoByya9

Filter runs by Orchestration ID.

Response

has_moreboolean required

Indicates whether there are more items to be fetched in the subsequent pages.

next_cursorstring

The cursor to use in pagination. Use this value as starting_after to get the next page.

Example response

{
  "has_more": true,
  "next_cursor": "VeN1GjhVIq1D9h",
  "data": [
    {
      "id": "ewK8sDoLNI4CFR",
      "orchestration_id": "3LIw2FdxoByya9",
      "status": "COMPLETED",
      "due_at": "2024-01-01T00:00:00.000Z",
      "started_at": "2024-01-01T00:00:05.000Z",
      "finished_at": "2024-01-01T00:05:00.000Z"
    }
  ]
}