Get bulk update job status

What this endpoint does

Returns processing state for one bulk-update job ObjectId.

It does not list jobs. It does not return per-row output; use details after status is completed. A missing job id can return 500, not 404.

INFO

Workflow

List jobs → copy _id → GET /v1/users/bulk-update/{id}/status → when completed, call details. Do not treat details as final while status is still queued or in progress.

Quick start

Replace <jobId> with a 24-character job ObjectId from the list endpoint.

Authentication and permission

Send Authorization: Bearer <COMMUNITY_API_KEY>. Grant getBulkUpdate for status and details. Keep the key server-side.

Complete examples

Unknown ObjectId (500). A well-formed id with no job returns HTTP 500 with { "status": "fail", "message": "Error getting bulk update info", "detail": "Bulk update not found" }.

Invalid id format. Bulk update ID is required and must be a valid ObjectId.

Completed job. Status progresses In Queue → In Progress → Completed with successfulUsers, failedUsers, receivedTime, and duration.

Treat ids as synthetic.

Success and readback

When the job exists, HTTP 200 with status labels In Queue, In Progress, Completed, Failed.

Use Completed as the gate before job details.

CHECK

Missing job is 500

detail: Bulk update not found on HTTP 500 means the ObjectId did not match a job this key can read. Do not retry that id. List jobs again.

Errors and recovery

Status	When	Recovery
`500` `Error getting bulk update info` `Bulk update not found`	Well-formed ObjectId, no job	Copy `_id` from the list. Do not loop.
Invalid ObjectId	Malformed `{id}`	Send a 24-character hex id.
`401`	Missing or invalid Bearer token	Add a valid community key.

Retry safety

TIP

Exact retry

This GET does not mutate users. Retry timeouts with bounded backoff. Do not retry 500 Bulk update not found without a different id. While status is In Queue or In Progress, poll with backoff; do not resubmit the CSV.

Gotchas

List rows may show lowercase completed while this endpoint uses title-case labels. Compare job _id.

Details for a missing id can return 200 empty rather than 500. Status and details are not the same missing-job contract.

Next steps

List bulk update jobs

If status 500s, match name on the list and copy a real _id.

What this endpoint does

Quick start

Authentication and permission

Complete examples

Success and readback

Errors and recovery

Retry safety

Gotchas

Next steps

Request

Responses

Get bulk update job status

What this endpoint does#

Quick start#

Authentication and permission#

Complete examples#

Success and readback#

Errors and recovery#

Retry safety#

Gotchas#

Next steps#

Request

Responses

What this endpoint does

Quick start

Authentication and permission

Complete examples

Success and readback

Errors and recovery

Retry safety

Gotchas

Next steps