---
title: "Read a job"
method: GET
path: "/v1/jobs/{id}"
tags: ["Jobs"]
---

# Read a job

`GET /v1/jobs/{id}`

## Request

- Base URL: `https://api.onegoodarea.com`
- URL: `https://api.onegoodarea.com/v1/jobs/{id}`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer

Status, attempts, progress and, once succeeded, the summary. A job whose worker went quiet is re-queued here and run again, up to three attempts.

## Path parameters

- `id` string, required

## Response `200`

Default Response

- object
  - `job` object, required
    - `id` string, required
    - `kind` 'portfolio_map', required
    - `status` 'queued' | 'running' | 'succeeded' | 'failed', required
    - `attempts` integer, required
    - `progress` object, required
      - `total` integer, required
      - `done` integer, required
    - `summary` object, required
      - `count` integer, required
      - `resolved` integer, required
      - `ambiguous` integer, required
      - `not_found` integer, required
      - `with_signals` integer, required
      - `without_signals` integer, required
      - `portfolio` object, required
        - `id` string, required
        - `added` integer, required
        - `updated` integer, required
    - `error` string, required
    - `created_at` string, date-time, required
    - `started_at` string, date-time, required
    - `finished_at` string, date-time, required
  - `notes` string[], required
  - `meta` object, required
    - `engine_version` string, required
    - `generated_at` string, required

## Other responses

- `401`: Default Response
- `403`: Default Response
- `404`: Default Response
- `429`: Default Response
- `500`: Default Response

---

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