Skip to main content
GET
List tasks

Authorizations

Authorization
string
header
required

A team API key, sk_offstage_…, created in the console. Everything it touches belongs to its team.

Query Parameters

state
enum<string>

Only tasks in this state. queued → claimed → running → succeeded | failed | timed_out, or cancelled from any state before those. The last four are terminal.

Available options:
queued,
claimed,
running,
succeeded,
failed,
timed_out,
cancelled
kind
enum<string>

Only tasks of this kind. runner lists GitHub Actions jobs. Labels the task and picks its default session: screenshot runs gui, the rest headless. agent runs agent instead of command. runner is a GitHub Actions job: the plane makes one from a job queued with runs-on: offstage-macos (or offstage-macos-gui) in a connected GitHub organization, and its task carries github. No client submits one: createTask refuses it with 400 bad-kind.

Available options:
build,
test,
screenshot,
agent,
runner
limit
integer
default:50

Page size.

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

The previous page's nextCursor. It marks a position among all your items, so an item that leaves the state filter between pages never breaks the listing.

Response

A page of task summaries.

tasks
object[]
required
nextCursor
string | null
required

Pass as cursor for the next page; null on the last page.