List bulk actions

List bulk actions in the current environment. Bulk actions are returned newest first and can be paginated with cursor pagination.

GET /api/v1/bulk-actions

List bulk actions

TypeScript

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

let page = await runs.bulk.list({ limit: 20 });

for (const action of page.data) {
  console.log(action.id, action.type, action.status);
}

200

{
  "data": [
    {
      "id": "bulk_1234",
      "type": "CANCEL",
      "status": "PENDING",
      "counts": {
        "total": 123,
        "success": 123,
        "failure": 123
      },
      "createdAt": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "completedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "next": "<string>",
    "previous": "<string>"
  }
}

Authorizations

Authorization · string · header · required

Use a named environment API key. It starts with tr_dev_sk_, tr_prod_sk_, tr_stg_sk_, etc.

Create a named API key in the API Keys section of your Trigger.dev project dashboard. Choose the narrowest access preset that supports your integration.

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";

configure({ accessToken: "tr_dev_sk_1234" });

Query Parameters

page · object

Use this parameter to paginate bulk actions. Pass page[after] or page[before] using the cursor returned in the previous response.

Show child attributes

Response

200

application/json

Successful request

data · object[] · required

Show child attributes

pagination · object · required

Show child attributes