Skip to main content
GET
List batch jobs

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

job_type
enum<string>
Available options:
EVENT_CSV_IMPORT,
CUSTOMER_CSV_IMPORT,
SUBSCRIPTION_CSV_IMPORT,
SUBSCRIPTION_PLAN_MIGRATION,
TAX_REPORT_EXPORT
status
enum<string>[]
Available options:
PENDING,
CHUNKING,
PROCESSING,
COMPLETED,
COMPLETED_WITH_ERRORS,
FAILED,
CANCELLED
page
integer<int32>

Page number (0-indexed)

Required range: x >= 0
per_page
integer<int32>

Number of items per page

Required range: 1 <= x <= 100

Response

List of batch jobs

data
object[]
required
pagination_meta
object
required