REreply
Background Jobs

Get a background job

<small>Requires the other:read scope (or a broader one that includes it).</small>

Returns the full record for a background job, including raw input (jsonData) and result (jsonDataResult) JSON payloads when available.

get/v3/background-jobs/{jobId}

Request

Path parameters

jobIdstring uuid required

Background job identifier (must be a non-empty GUID)

Response

Background job record

jobIdstring uuid

Unique identifier for the background job

status'Scheduled' | 'Processing' | 'Done' | 'Failed' | 'Expired' | 'Cancelled' | 'Unknown'

Current job status. One of Scheduled, Processing, Done, Failed, Expired, Cancelled, or Unknown for unrecognized terminal states.

categorystring nullable

Job category, e.g. r2/bg-jobs/email-validation. Use the suffix (email-validation) when filtering the list endpoint.

startedAtstring date-time

When the job started

finishedAtstring date-time nullable

When the job reached a terminal state, or null if still running

progressnumber double nullable

Job progress in [0..1]. Null if the job hasn't reported progress yet.

jsonDatastring nullable

Raw JSON of the input parameters captured at job creation. Opaque — shape is per-category.

jsonDataResultstring nullable

Raw JSON of the job result. Populated only when status is terminal (Done / Failed). Opaque — shape is per-category.

Changes

No recorded changes to this operation across all 1 revision of this API.