/api/v1/object/data/{objectSlug}/bulk-actions/{jobId}Get the report of a bulk job.
Get the report of a bulk job.
Poll this after a bulk call answered 202. status is queued,
running, completed, partial (some records failed), failed (all
failed) or cancelled. chunks_done out of chunks_total shows
progress, and finished_at is set once the job ends. failed lists each
record that was not written, with the reason. Reports are kept for 24
hours.
Scope: update.<object slug>, for example update.contacts.
Errors:
404— no job has that id, or its report has expired (code: BULK_JOB_NOT_FOUND).
Response 200:
{
"status": 200,
"message": "Bulk job report retrieved successfully",
"data": {
"job_id": "d41c7b9e2a60",
"status": "running",
"kind": "delete",
"object_slug": "contacts",
"total": 1200,
"succeeded": 500,
"failed": [],
"created_slugs": [],
"chunks_done": 1,
"chunks_total": 3,
"started_by": 17,
"started_at": "2026-09-14T10:00:00.000Z",
"finished_at": null
}
}
Send request
Use the documented inputs to call this endpoint directly.
Parameters
Values are applied to the request and the example on the right.
Responses
Successful response
{
"message": "string",
"data": "string"
}Bad request
{
"status": 1,
"message": "string",
"code": "string",
"data": {}
}The HTTP status code of the response.
What went wrong. Several validation messages are joined with ", ".
A stable, machine-readable reason. Only some errors set it.
Extra detail about the error. Only some errors set it.
Unauthorized
{
"status": 1,
"message": "string",
"code": "string",
"data": {}
}The HTTP status code of the response.
What went wrong. Several validation messages are joined with ", ".
A stable, machine-readable reason. Only some errors set it.
Extra detail about the error. Only some errors set it.
Internal server error
{
"status": 1,
"message": "string",
"code": "string",
"data": {}
}The HTTP status code of the response.
What went wrong. Several validation messages are joined with ", ".
A stable, machine-readable reason. Only some errors set it.
Extra detail about the error. Only some errors set it.
Powered by heyo-docs