Project / Workflows /

List workflow runs

Lists runs of a workflow

Required permission

Project > Workflows > Runs > Read

Path parameters

projectId
string required
ID of the project
workflowId
string required
ID of the workflow

Query parameters

per_page
integer
The number of results to display per request. Maximum of 100 results per page.
page
integer
The page number to access.
cursor
string
The cursor returned from the previous page of results, used to request the next page.

Response body

{object}
Response object.

data
{object} required
Result data.

runs
[array]
A workflow run

{object}

id
string required
ID of the workflow run
name
string
Optional name for the workflow run
description
string
Optional description for the workflow run
status
string required
Status of the template run
one of
pending, running, success, failure, aborted, aborting, queued, unknown, skipped, waiting, retrying, async_wait, approval_wait
startedAt
string
Timestamp the run started at.
concluded
boolean required
Whether the run has concluded (aborted, success, failed)
concludedAt
string
Timestamp the run concluded at.
createdAt
string required
Timestamp the run was created at.
updatedAt
string required
Timestamp the run was last updated at.

pagination
{object} required
Data about the endpoint pagination.

hasNextPage
boolean required
Is there another page of results available?
cursor
string
The cursor to access the next page of results.
count
number required
The number of results returned by this request.

API

CLI

JS Client

GET /v1/projects/{projectId}/workflows/{workflowId}/runs

GET /v1/teams/{teamId}/projects/{projectId}/workflows/{workflowId}/runs

Example response

200 OK

A list of runs for this workflow.

JSON

{
  "data": {
    "runs": [
      {
        "id": "110ddb52-bdcd-482d-8ac2-05ba580afe2f",
        "name": "Example run",
        "description": "This is an example description",
        "status": "success",
        "startedAt": "2021-01-01 12:01:00.000Z",
        "concluded": true,
        "concludedAt": "2021-01-01 12:10:00.000Z",
        "createdAt": "2021-01-01 12:00:00.000Z",
        "updatedAt": "2021-01-01 12:00:00.000Z"
      }
    ]
  },
  "pagination": {
    "hasNextPage": false,
    "count": 1
  }
}