Skip to main content
GET
Get bulk job status
Retrieve the status and statistics of a bulk messaging job.

Authorizations

Authorization
string
header
required

Use your API key as a Bearer token. Format: Authorization: Bearer sk_live_xxxxx

Headers

Xerobi-Version
string
default:2026-01-01
required

API version in YYYY-MM-DD format. Using the latest version ensures access to newest features.

Pattern: ^\d{4}-\d{2}-\d{2}$

Path Parameters

job_id
string
required

Bulk job ID

Response

Bulk job details

Bulk messaging job status and statistics

id
string
required

Unique job identifier

Example:

"job_bulk_001"

status
enum<string>
required

Job processing status

Available options:
processing,
completed,
failed,
cancelled
Example:

"processing"

total
integer
required

Total number of recipients

Required range: x >= 1
Example:

5000

queued
integer
required

Messages queued for delivery

Example:

4850

sent
integer

Messages sent to carrier

Example:

150

delivered
integer

Successfully delivered messages

Example:

120

failed
integer

Failed deliveries

Example:

5

estimated_cost
number

Estimated total cost

Example:

250

created_at
string<date-time>

Job creation timestamp

Example:

"2026-01-15T10:00:00Z"

completed_at
string<date-time> | null

Job completion timestamp

Example:

null