---
title: "Read a job and its progress"
method: GET
path: "/api/v1/project-rooms/{id}/jobs/{jobId}"
tags: ["Projects"]
---

# Read a job and its progress

`GET /api/v1/project-rooms/{id}/jobs/{jobId}`

## Request

- Base URL: `https://askthegrid.com`
- URL: `https://askthegrid.com/api/v1/project-rooms/{id}/jobs/{jobId}`
- Auth: HTTP bearer

Poll with after set to the last event ID to retrieve subsequent progress events.

## Path parameters

- `id` string, required
- `jobId` string, required

## Query parameters

- `after` integer

## Response `200`

Success

- object
  - `job` object, required
    - `id` string, required
    - `kind` string, required
    - `key` string, required
    - `subjectId` string, nullable, required
    - `runId` string, nullable, required
    - `status` 'queued' | 'running' | 'succeeded' | 'failed' | 'cancelled', required
    - `progress` object, nullable, required
      - `done` number, required
      - `total` number, required
      - `note` string
      - `unit` string
      - `rate` number
      - `at` string
    - `attempts` integer, required
    - `maxAttempts` integer, required
    - `error` string, nullable, required
    - `createdBy` object, required
      - `email` string, required
      - `name` string
    - `createdAt` string, required
    - `startedAt` string, nullable, required
    - `finishedAt` string, nullable, required
    - `runAfter` string, required
    - `cancelRequested` boolean, required
  - `events` object[], required
    - `id` integer, required
    - `at` string, required
    - `level` 'info' | 'warn' | 'error', required
    - `message` string, required
    - `data` object, nullable, required

## Other responses

- `400`: The request did not match the contract.
- `401`: Missing or invalid credentials.
- `429`: Rate limit exceeded. Wait `Retry-After` seconds; `X-RateLimit-Limit`, `X-RateLimit-Remaining` and `X-RateLimit-Reset` report the budget. Signed-in sessions and API keys have larger budgets than anonymous callers.

---

[API](https://skmtc.dev/askthegrid/apis/ask-the-grid-api.md) · [All operations](https://skmtc.dev/askthegrid/apis/ask-the-grid-api/llms.txt) · [OpenAPI document](https://skmtc.dev/askthegrid/apis/ask-the-grid-api/revisions/9cd80115e395?raw)