# Get a calendar job: `GET /v1/jobs/{job_id}`

Cost: free (0 (failed requests are free)). Docs: https://scrapercompany.com/docs/reference/jobs-get

Poll a batched calendar job and read each item's status.

A submitted job (`POST /v1/jobs`) returns immediately with a job id; this
is how you learn the outcome. Each item reports its own status, so one
failed property does not hide the ones that succeeded. Results are
omitted unless `include_results` is set. Free.

Parameters:

- `job_id` (string; required)
- `include_results` (boolean; optional; default false): Include each completed calendar payload. Leave false for a small status-only response.

Response fields:

- `id` (string; required): `refreshjob_...`
- `job_id` (string; required): Same as `id`.
- `poll_url` (string; required): `/v1/jobs/{job_id}`
- `status` (string; required; one of queued, running, succeeded, partial, failed)
- `priority` (integer; required)
- `callback_url` (string | null; required)
- `callback_status` (string; required; one of not_configured, pending, delivered, failed)
- `callback_attempts` (integer; required)
- `callback_last_error` (string | null; required)
- `artifact_uri` (string | null; required)
- `artifact_sha256` (string | null; required)
- `result_summary` (object; required): Empty object until the job finishes.
  - `result_summary.rates` (integer; optional)
  - `result_summary.database` (object; optional)
- `error` (string | null; required)
- `items_total` (integer; required)
- `items_succeeded` (integer; required)
- `items_failed` (integer; required)
- `created_at` (string; required): Timestamp string, e.g. `2026-08-10 14:05:00.123456+00`.
- `started_at` (string | null; required): Timestamp string, e.g. `2026-08-10 14:05:00.123456+00`.
- `finished_at` (string | null; required): Timestamp string, e.g. `2026-08-10 14:05:00.123456+00`.
- `updated_at` (string; required): Timestamp string, e.g. `2026-08-10 14:05:00.123456+00`.
- `items` (array of object; required)
  - `items[].id` (string; required): `refreshitem_...`
  - `items[].item_index` (integer; required)
  - `items[].token` (string; required)
  - `items[].label` (string | null; required)
  - `items[].status` (string; required; one of queued, running, succeeded, failed)
  - `items[].request` (object; required): One property in an asynchronous calendar batch.
  - `items[].result` (object | null; required): The item's calendar payload. Only populated with `include_results=true` once the item succeeded; otherwise null.
  - `items[].error` (string | null; required)
  - `items[].attempts` (integer; required)
  - `items[].started_at` (string | null; required): Timestamp string, e.g. `2026-08-10 14:05:00.123456+00`.
  - `items[].finished_at` (string | null; required): Timestamp string, e.g. `2026-08-10 14:05:00.123456+00`.
  - `items[].updated_at` (string; required): Timestamp string, e.g. `2026-08-10 14:05:00.123456+00`.

Base URL: `https://api.scrapercompany.com`. Auth: send your key in the `x-api-key` header. A failed request (4xx or 5xx) or an empty result costs 0 credits.

- [Full API reference as one Markdown file](https://scrapercompany.com/llms-full.txt)
- [OpenAPI spec](https://scrapercompany.com/openapi.json)
