bulk-actions

Retrieve bulk action

Retrieve the status and aggregate processing counts for a bulk action.

get/api/v1/bulk-actions/{bulkActionId}

Request

Base URL
https://api.trigger.dev
Auth
HTTP bearer
TypeScript
https://skmtc.dev/triggerdotdev/apis/trigger-dev-v3-rest-api/docs/api/v1/bulk-actions/:bulkActionId/get.ts
A function with typed inputs. Its response is checked against the schema.

bulkActionIdstring required

The ID of a bulk action, starts with bulk_.

Successful request

idstring required

The bulk action ID, prefixed with bulk_.

namestring

The name provided when the bulk action was created.

type'CANCEL' | 'REPLAY' required

status'PENDING' | 'COMPLETED' | 'ABORTED' required

createdAtstring date-time required

completedAtstring date-time

{
  "id": "bulk_1234"
}