Skip to main content
GET
/
api
/
v1
/
batch-jobs
List batch jobs
curl --request GET \
  --url https://api.example.com/api/v1/batch-jobs \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "failed_items": 123,
      "id": "<string>",
      "job_type": "EVENT_CSV_IMPORT",
      "processed_items": 123,
      "status": "PENDING",
      "completed_at": "2023-11-07T05:31:56Z",
      "input_file_name": "<string>",
      "total_items": 123
    }
  ],
  "pagination_meta": {
    "page": 1,
    "per_page": 1,
    "total_items": 1,
    "total_pages": 1
  }
}

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