Skip to main content
GET
List jobs
  • Lists the jobs you can read with GET /v1/jobs/{id}: those your API key, app or Dashboard started. The Dashboard lists the ones you started from any client.
  • status filters by one or more statuses, comma-separated, such as status=needs_input. A filtered page can hold fewer jobs than limit, so follow next_cursor until it is null.
  • q finds the jobs whose website or site name contains its text. Tasks are kept encrypted for you alone and can’t be searched here; search them in the jobs you list.
  • counts totals your jobs of the listed type by state, whatever status, q, cursor and limit asked for; needs_input_count repeats counts.needs_input.
  • A job’s result is never listed; read it with GET /v1/jobs/{id}.
  • Callers: an API key, an integration’s API key, an MCP OAuth token or a Dashboard session.
  • Permission: jobs:read.
  • Effect: Changes nothing.
  • Errors: only the errors any request can get.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

type
enum<string>

Only runs, or only builds

Available options:
run,
build
status
string

Only jobs in these statuses, comma-separated: queued, running, needs_input, succeeded, failed, cancelled

q
string

Only jobs whose website or site name contains this text, ignoring case. A task is kept encrypted for you alone, so search tasks in the jobs you have listed

cursor
string

The next_cursor of the previous page

limit
string

Jobs per page, 1 to 50 (default 20)

Response

One page of jobs

data
object[]
required
next_cursor
string | null
required
needs_input_count
integer
required

counts.needs_input, kept for callers that read it

Required range: x >= 0
counts
object
required

How many of your jobs of the listed type are in each state, whatever status, q, cursor and limit asked for