---
title: "Get a background job's status"
method: GET
path: "/api/v1/sites/{slug}/jobs/{id}"
tags: ["Jobs"]
---

# Get a background job's status

`GET /api/v1/sites/{slug}/jobs/{id}`

## Request

- Base URL: `https://api.dotsy.ai`
- URL: `https://api.dotsy.ai/api/v1/sites/{slug}/jobs/{id}`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer

Poll a job started by a 202 response (a large changeset, a large site rename, or a URL import) until `status` is `succeeded` or `failed`. `progress` and `result` depend on the job's `kind`. A job id only works on the site it was started for.

## Path parameters

- `slug` string, required
- `id` string, required

## Response `200`

The job.

- Job
  - `id` string, required: Public job id. Poll GET /api/v1/sites/{slug}/jobs/{id}.
  - `kind` 'import' | 'content' | 'rename', required
  - `status` 'queued' | 'running' | 'succeeded' | 'failed', required
  - `progress` object
    - `done` number, required
    - `total` number, required
  - `result` object
  - `error` object
    - `code` string, required
    - `message` string

## Other responses

- `401`: Missing or invalid credentials.
- `403`: Your role or token can't read this kind of job.
- `404`: No such site, or no such job on this site.
- `503`: Background jobs are not available on this server.

---

[API](https://skmtc.dev/dotsy/apis/dotsy-api.md) · [All operations](https://skmtc.dev/dotsy/apis/dotsy-api/llms.txt) · [OpenAPI document](https://skmtc.dev/dotsy/apis/dotsy-api/revisions/4272ed3b85d7?raw)