Sign in
Batch Jobs

List batch jobs

List batch jobs with optional filtering by type and status.

get/api/v1/batch-jobs

Query parameters

job_type'EVENT_CSV_IMPORT' | 'CUSTOMER_CSV_IMPORT' | 'SUBSCRIPTION_CSV_IMPORT' | 'SUBSCRIPTION_PLAN_MIGRATION'
statusstring[]
pageinteger

Page number (0-indexed)

per_pageinteger

Number of items per page

Response

List of batch jobs

Example response

{
  "data": [
    {
      "id": "bjob_7n42DGM5Tflk9n8mt7Fhc7"
    }
  ]
}

Changes

Changed in 2 of the 54 revisions of this API.11