Skip to main content
GET
/
v3
/
background-jobs
/
{jobId}
Get a background job
curl --request GET \
  --url https://api.reply.io/v3/background-jobs/{jobId} \
  --header 'Authorization: Bearer <token>'
{
  "jobId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "Scheduled",
  "category": "<string>",
  "startedAt": "2023-11-07T05:31:56Z",
  "finishedAt": "2023-11-07T05:31:56Z",
  "progress": 0.5,
  "jsonData": "<string>",
  "jsonDataResult": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.reply.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Authenticate every request with a Bearer token. Pass your Reply API key in the Authorization header:

Authorization: Bearer <your-api-key>

Get your API key from the Reply dashboard: Settings → API Key.

Path Parameters

​
jobId
string<uuid>
required

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

Response

Background job record

A long-running background operation tracked by the API. Includes status, progress, timing, and the raw input/result JSON payloads.

​
jobId
string<uuid>
read-only

Unique identifier for the background job

​
status
enum<string>
read-only

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

Available options:
Scheduled,
Processing,
Done,
Failed,
Expired,
Cancelled,
Unknown
​
category
string | null
read-only

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

​
startedAt
string<date-time>
read-only

When the job started

​
finishedAt
string<date-time> | null
read-only

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

​
progress
number<double> | null
read-only

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

Required range: 0 <= x <= 1
​
jsonData
string | null
read-only

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

​
jsonDataResult
string | null
read-only

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