---
title: "Jobs API Reference"
description: "Long-running operations. An endpoint that works in the background answers 202 Accepted with a job and a Location header; poll GET /v1/jobs/{id} until the status is JOB_STATUS_SUCCEEDED or JOB_STATUS_FAILED. Jobs can be read for 24 hours after they finish."
canonical: "https://linkbreakers.com/help/api/jobs"
---

# Jobs

Long-running operations. An endpoint that works in the background answers 202 Accepted with a job and a Location header; poll GET /v1/jobs/{id} until the status is JOB\_STATUS\_SUCCEEDED or JOB\_STATUS\_FAILED. Jobs can be read for 24 hours after they finish.

## Jobs

## [#](#jobs-object)The Job Error object

Why a job failed.

codeType

string

Stable error code, the same codeType a synchronous call would return.

message

string

Human-readable explanation.

Example object

```json
{
  "codeType": "string",
  "message": "string"
}
```

GET

`/v1/jobs/{id}`

Requires auth

## [#](#get-a-job)Get a job

Returns the status of a long-running operation and, once it succeeded, its result. Poll this until the status is JOB\_STATUS\_SUCCEEDED or JOB\_STATUS\_FAILED. Requires the \`links:read\` scope.

### [#](#get-a-job-parameters)Parameters

#### path parameters

id

string

Required

path

The job ID returned when the job was accepted.

### [#](#get-a-job-response)Response

200

Everything worked as expected.

completedAt

string (date-time)

When the job finished, once it has.

createdAt

string (date-time)

When the job was accepted.

error

object

Why a job failed.

id

string

Job ID (UUID).

itemCount

integer (int32)

How many items the job was submitted with.

linksBulkCreate

object

Result of a JOB\_TYPE\_LINKS\_BULK\_CREATE job.

status

string (enum)

Where a job stands.

##### Allowed values

`JOB_STATUS_UNSPECIFIED`

Not set.

`JOB_STATUS_PENDING`

Accepted and waiting to run.

`JOB_STATUS_RUNNING`

Running now.

`JOB_STATUS_SUCCEEDED`

Finished; the result is set.

`JOB_STATUS_FAILED`

Finished without doing its work; error says why. Nothing was created.

statusUrl

string

Path to poll for this job's status.

type

string (enum)

What a job does.

##### Allowed values

`JOB_TYPE_UNSPECIFIED`

Not set.

`JOB_TYPE_LINKS_BULK_CREATE`

Creates a batch of links (POST /v1/links/bulk/jobs).

### [#](#get-a-job-error)Error response

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

object

Required

Wrapped error response.

Example request (cURL)

```bash
curl -X GET "https://api.linkbreakers.com/v1/jobs/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN"
```

Typical response

```json
{
  "completedAt": "2026-10-10T21:07:44.176Z",
  "createdAt": "2026-10-10T21:07:44.176Z",
  "error": {
    "codeType": "string",
    "message": "string"
  },
  "id": "string",
  "itemCount": 0,
  "linksBulkCreate": {
    "linkIds": [
      "string"
    ]
  },
  "status": "JOB_STATUS_UNSPECIFIED",
  "statusUrl": "https://example.com",
  "type": "JOB_TYPE_UNSPECIFIED"
}
```

Base URL: `https://api.linkbreakers.com`

---

Source: https://linkbreakers.com/help/api/jobs