Skip to main content
GET
List batch jobs

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.

Query Parameters

status
enum<string>
  • 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
type
enum<string>
default:regular
  • 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
limit
integer
default:50

Page size, 1 to 100 (larger values are treated as 100). Not a positive integer → 400.

Required range: 1 <= x <= 100
cursor
string

Opaque; echo the previous response's next_cursor to continue.

Response

Page of jobs.

jobs
object[]
required
next_cursor
string

Echo as ?cursor= for the next page. Omitted on the last page.