Retrieve a single job by ID.

GET

/v1/jobs/{id}

const url = 'https://api.adversarial.com/api/v1/jobs/example';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.adversarial.com/api/v1/jobs/example

Parameters

Path Parameters

required

string

Job ID, as returned when the job was enqueued

Responses

200

Job details

application/json

A single background job.

object

created_at

required

string format: date-time

duration_seconds

How long the job took, in seconds, from when it was enqueued (created_at) to when it reached its final state (updated_at). Absent while the job is still in flight. Includes time spent waiting in the queue.

integer | null format: int64

error_message

Why the job failed. Absent unless the status is failed.

string | null

required

Job ID, assigned when the job was enqueued.

string

integration_type

The integration this job belongs to, when it is integration work.

string | null

name

required

The kind of work this job performs (e.g. RiskIntegrationImporter).

string

run_at

required

When the job became — or becomes — eligible to run: the enqueue time for an immediate job, a future instant for a scheduled one. For a recurring job this advances to the next scheduled run once it completes. It is not the time the job started or finished, so it should not be used to measure how long the job took; read duration_seconds for that.

string format: date-time

status

required

The lifecycle status of a background job.

string

Allowed values: queued processing completed failed cancelled

updated_at

required

string format: date-time

Example

{
  "status": "queued"
}

404

Job not found