---
title: "Get the status of an async job"
method: GET
path: "/api/v1/jobs/{id}"
tags: ["Bulk"]
---

# Get the status of an async job

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

## Request

- Base URL: `https://www.adadiamonds.com`
- URL: `https://www.adadiamonds.com/api/v1/jobs/{id}`
- Auth: one of:
  - none
  - API key in header `X-Ada-Api-Key`
  - OAuth 2 (authorization code, authorization URL `https://www.adadiamonds.com/oauth/authorize`, token URL `https://www.adadiamonds.com/api/oauth/token`; client credentials, token URL `https://www.adadiamonds.com/api/oauth/token`, scopes: `catalog:read`)

Reports the state of a job started by `createExport`. A job is `queued` for a moment after creation (the response carries `Retry-After`) and `succeeded` after that, at which point `result_url` is set. Expired jobs (older than 24 hours) return 410; start a new export.

## Path parameters

- `id` string, required

## Response `200`

The job.

- Job
  - `object` 'job', required
  - `id` string, required: Opaque signed job id. Valid for 24 hours.
  - `type` 'export', required
  - `status` 'queued' | 'succeeded', required
  - `progress` integer
  - `export` object
    - `type` 'diamonds' | 'engagement-rings' | 'jewelry'
    - `format` 'jsonl' | 'json'
    - `filters` object
  - `status_url` string, uri, required
  - `result_url` string, uri, nullable: Set once `status` is `succeeded`.
  - `created_at` string, date-time, required
  - `completed_at` string, date-time, nullable
  - `expires_at` string, date-time, required
  - `note` string

## Other responses

- `401`: The job id's signature does not verify. Use ids exactly as issued.
- `404`: Nothing at that id. `error_description` says where to list what exists.
- `410`: The job expired (24 hours). Start a new export.
- `429`: Over the rate limit. Wait `Retry-After` seconds; a credential raises the limit.
- `503`: The feature is not configured in this environment. Retry after `Retry-After`.

---

[API](https://skmtc.dev/adadiamonds/apis/ada-diamonds-agent-api.md) · [All operations](https://skmtc.dev/adadiamonds/apis/ada-diamonds-agent-api/llms.txt) · [OpenAPI document](https://skmtc.dev/adadiamonds/apis/ada-diamonds-agent-api/revisions/2b2ed3201815?raw)
