List Pipelines

List pipeline runs, cursor-paginated and newest first. Filter by status or schema. Preview runs are excluded from the listing.

List your pipeline runs, cursor-paginated and ordered newest first by default. Each entry is a slim summary of a run: its id, name, status, the Spec it ran against, and the compiled phase count. Preview runs (the sample-anchored runs the app uses to render Spec previews) are excluded, so this listing only shows real pipeline runs.

Filter the listing with status to narrow to runs in a particular lifecycle state, or schema_id to scope to one Spec. Combine them to find, for example, every active run of a given Spec. Pagination is cursor-based: pass the next_cursor from the previous response as cursor to walk the result set deterministically across pages.

The listing is intentionally lean. For a run's phase progress use GET /v1/pipelines/{id}/progress, and for its full detail use GET /v1/pipelines/{id}. Each list entry carries a links object with self, progress, and a dashboard URL into the app. This endpoint requires an API key with the read scope.

GET/v1/pipelines

Response

Response fields

dataarrayArray of pipeline run objects.

data[].idstringPipeline run UUID.

data[].namestringRun name.

data[].statusstringPipeline status.

data[].schemaobjectThe Spec used for the run: { id }.

data[].phase_countintegerNumber of compiled phases in the run's phase config.

data[].created_atstringISO 8601 creation timestamp.

data[].linksobjectRelated resource URLs (self, progress, dashboard).

pagination.totalintegerTotal number of runs matching the query.

pagination.limitintegerMaximum results per page.

pagination.has_morebooleanWhether more results exist beyond this page.

pagination.next_cursorstring | nullCursor to fetch the next page. Null if no more results.

Response

{
  "data": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "name": "Lease Agreement — 2024-09-14",
      "status": "active",
      "schema": { "id": "sch_uuid_1" },
      "phase_count": 5,
      "created_at": "2024-09-14T10:32:00.000Z",
      "links": {
        "self": "/v1/pipelines/a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "progress": "/v1/pipelines/a1b2c3d4-e5f6-7890-abcd-ef1234567890/progress",
        "dashboard": "https://app.talonic.com/structure-pt/a1b2c3d4-e5f6-7890-abcd-ef1234567890"
      }
    }
  ],
  "pagination": {
    "total": 12,
    "limit": 20,
    "has_more": false,
    "next_cursor": null
  }
}

Errors

Error responses

401unauthorizedMissing or invalid API key.

429rate_limitedToo many requests. Retry after the period indicated in the Retry-After header.

Run Pipeline

Get Pipeline