Skip to main content
GET
/
api
/
v1
/
batch-jobs
/
{batch_job_id}
Get batch job detail
curl --request GET \
  --url https://api.example.com/api/v1/batch-jobs/{batch_job_id} \
  --header 'Authorization: Bearer <token>'
{
  "created_at": "2023-11-07T05:31:56Z",
  "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "failed_items": 123,
  "failure_count": 123,
  "has_error_csv": true,
  "id": "<string>",
  "processed_items": 123,
  "completed_at": "2023-11-07T05:31:56Z",
  "error_csv_url": "<string>",
  "input_file_name": "<string>",
  "input_file_url": "<string>",
  "total_items": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.meteroid.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
batch_job_id
string<MeteroidId>
required

Batch job ID

Example:

"bjob_7n42DGM5Tflk9n8mt7Fhc7"

Response

Batch job detail

​
created_at
string<date-time>
required
​
created_by
string<uuid>
required
​
failed_items
integer<int32>
required
​
failure_count
integer<int64>
required
​
has_error_csv
boolean
required
​
id
string<MeteroidId>
required
Example:

"bjob_7n42DGM5Tflk9n8mt7Fhc7"

​
job_type
enum<string>
required
Available options:
EVENT_CSV_IMPORT,
CUSTOMER_CSV_IMPORT,
SUBSCRIPTION_CSV_IMPORT,
SUBSCRIPTION_PLAN_MIGRATION
​
processed_items
integer<int32>
required
​
status
enum<string>
required
Available options:
PENDING,
CHUNKING,
PROCESSING,
COMPLETED,
COMPLETED_WITH_ERRORS,
FAILED,
CANCELLED
​
completed_at
string<date-time> | null
​
error_csv_url
string | null
​
input_file_name
string | null
​
input_file_url
string | null
​
total_items
integer<int32> | null