Bulk job status

get
Bulk job status API

https://api.imagekit.io/v1/bulkJobs/:jobId
This endpoint allows you to get the status of a bulk operation e.g. copy or move folder API.
Request
Response
Request
Path Parameters
jobId
optional
string
The jobId you get in the response of bulk job API e.g. copy folder or move folder API.
Headers
Authorization
required
string
base64 encoding of your_private_api_key: Note the colon in the end.
Response
200: OK
On success, you will receive a JSON-encoded response like below.
{
"jobId": "598821f949c0a938d57563bd",
"type": "COPY_FOLDER",
"status": "Completed" // or "Pending"
}

Response structure and status code (application/JSON)

In case of error, you will get an error code along with the error message. On success, you will receive a 200 status code with a JSON-encoded body.

Understanding the response

The JSON-encoded response will have the following properties:

Property name

Description

jobId

The jobId you get in the response of bulk job API e.g. copy folder or move folder API.

type

The type of operation, it could be either COPY_FOLDER or MOVE_FOLDER.

status

The current status of the job. It can be either:

  • Pending - The job has been successfully submitted and is in progress.

  • Completed - The job has been completed.