GET
/
api
/
v1
/
runs
import { runs } from "@trigger.dev/sdk/v3";

// Get the first page of runs
let page = await runs.list({ limit: 20 });

for (const run of page.data) {
  console.log(`Run ID: ${run.id}, Status: ${run.status}`);
}

// Convenience methods are provided for manually paginating:
while (page.hasNextPage()) {
  page = await page.getNextPage();
  // Do something with the next page of runs
}

// Auto-paginate through all runs
const allRuns = [];

for await (const run of runs.list({ limit: 20 })) {
  allRuns.push(run);
}
{
  "data": [
    {
      "id": "run_1234",
      "status": "WAITING_FOR_DEPLOY",
      "taskIdentifier": "my-task",
      "version": 20240523.1,
      "env": {
        "id": "cl1234",
        "name": "dev",
        "user": "Anna"
      },
      "idempotencyKey": "idempotency_key_1234",
      "isTest": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "startedAt": "2023-11-07T05:31:56Z",
      "finishedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "next": "run_1234",
    "previous": "run_5678"
  }
}

Authorizations

Authorization
string
headerrequired

Use your project-specific Secret API key. Will start with tr_dev_, tr_prod, tr_stg, etc.

You can find your Secret API key in the API Keys section of your Trigger.dev project dashboard.

Our TypeScript SDK will default to using the value of the TRIGGER_SECRET_KEY environment variable if it is set. If you are using the SDK in a different environment, you can set the key using the configure function.

import { configure } from "@trigger.dev/sdk/v3";

configure({ secretKey: "tr_dev_1234" });

Query Parameters

page
object

Use this parameter to paginate the results. You can specify the number of runs per page, and the ID of the run to start the page after or before.

For object fields like page, you should use the "form" encoding style. For example, to get the next page of runs, you can use page[after]=run_1234.

filter
object

Use this parameter to filter the runs. You can filter by created at, status, task identifier, and version.

For array fields, you can provide multiple values to filter by using a comma-separated list. For example, to get QUEUED and EXECUTING runs, you can use filter[status]=QUEUED,EXECUTING.

For object fields, you should use the "form" encoding style. For example, to filter by the period, you can use filter[createdAt][period]=1d.

Response

200 - application/json
data
object[]
pagination
object