Skip to main content
GET
Read a job and its latest run

Authorizations

X-API-Key
string
header
required

Batch, Crawl, the Extract endpoints and the account endpoint read the same key from the X-API-Key header.

Path Parameters

job_id
string
required

Assigned by the server on submit.

Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$

Response

OK

job_id
string
required
type
enum<string>
default:regular
required
  • regular: a run is created at submit time.
  • scheduled: fires on a recurring or one-shot schedule. Submit stores the task list as a template on the job row; each scheduled fire produces a fresh Run. schedule field required. Read-only template: addBatchTasks and close return 409. rerun (full or filtered) and stop are allowed.
Available options:
regular,
scheduled
status
enum<string>
required
  • open: initial run still accepting addBatchTasks. Only meaningful while latest_run.run_sequence == 1.
  • closed: no more tasks accepted (created closed, or closed via /close / addTasks{last_batch} / /rerun).
  • deleted: never returned. A deleted job disappears from every read and list the moment DELETE is accepted (reads answer 404); its data is cleaned up asynchronously after.

Clients must accept values not listed here.

Available options:
open,
closed,
deleted
created_at
string<date-time>
required
updated_at
string<date-time>
required
format
enum<string>

Derived server-side from zenrows_params at submit time. Precedence:

  • response_type: markdown|plaintext|pdf → matching format.
  • a non-empty include → json, ahead of response_type.
  • autoparse: true, json_response: true, or non-empty css_extractor or extract → json. (outputs returns JSON from the scraper but is not part of this derivation, so such a result is typed html; kept as is for existing clients.)
  • otherwise → html. The job's format is the default from its job-level params; each task result's type is derived from that task's merged params and sets the Content-Type of its content.

Clients must accept values not listed here.

Available options:
html,
json,
markdown,
plaintext,
pdf
template_tasks
object[]

A scheduled job's task template, when it is small enough to be stored inline on the job; omitted otherwise (a large template is stored separately and not returned here).

zenrows_params
object

Stored canonical form: values are always strings even though submit accepts any JSON scalar (see ScraperParams).

external_id
string

Caller-supplied correlation id passed at submit (omitted when the caller did not supply one). Not server-enforced unique.

name
string

Optional human label passed at submit (omitted when the caller did not supply one). Free-form, up to 100 chars.

metadata
object

Opaque user-supplied key/value pairs. Stored on the task; not forwarded.

schedule
object

Schedule block: present only for type: scheduled jobs.

next_scheduled_run
string<date-time>

The next expected fire, computed from the schedule when the response is built. Omitted for non-scheduled jobs, while schedule_state == paused, and for a one-shot at schedule that has already fired.

schedule_state
enum<string>

Set only for type: scheduled. Default active at submit; flip via POST /v1/jobs/{id}/schedule/state.

Available options:
active,
paused
webhook
object

Webhook delivery config. Present iff a webhook is configured. Mutable via PUT/DELETE /v1/jobs/{id}/webhook; signature never appears alone: the whole webhook key is omitted when no URL is set.

latest_run
object

The job's most recent run, read when the response is built. Absent for scheduled jobs that haven't fired yet, and once every run was deleted.