Skip to main content
GET
List tasks

Authorizations

Authorization
string
header
required

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

Query Parameters

limit
integer
default:10

Page size. Defaults to 10 and is clamped to the range 1–100.

Required range: 1 <= x <= 100
offset
integer
default:0

Number of tasks to skip. Defaults to 0.

Required range: x >= 0

When true, meta.links.* are returned as objects ({ ...filters, limit, offset }) instead of query strings.

Available options:
true,
false
status
string

JSON-encoded array of statuses, e.g. ["completed","failed"]. The raw value is passed through JSON.parse, so it must be valid JSON.

since
string

[DEPRECATED] Alias for approvedAtSince. Ignored when approvedAtSince is also provided.

until
string

[DEPRECATED] Alias for approvedAtUntil. Ignored when approvedAtUntil is also provided.

approvedAtSince
string<date-time>

Lower bound (inclusive) on approvedAt. Any value accepted by JavaScript new Date() (ISO 8601 recommended).

approvedAtUntil
string<date-time>

Upper bound (inclusive) on approvedAt.

createdAtSince
string<date-time>

Lower bound (inclusive) on createdAt.

createdAtUntil
string<date-time>

Upper bound (inclusive) on createdAt.

updatedAtSince
string<date-time>

Lower bound (inclusive) on updatedAt.

updatedAtUntil
string<date-time>

Upper bound (inclusive) on updatedAt.

approvedBy
string[]

Approver emails to match. Declared as an array in the route schema; repeat the parameter to pass several values (approvedBy=a@x.com&approvedBy=b@x.com). Whether a comma-separated single value is also accepted depends on the framework query parser and was not verified.

createdBy
string[]

Creator emails to match. Same encoding rules as approvedBy.

promptApplicationId
string<uuid>

Restrict to tasks of this Workstation/App (sourceType: prompt). The app must be accessible to the caller (404 otherwise). Cannot be combined with agentId.

agentId
string<uuid>

Restrict to tasks of this agent (sourceType: agent). Cannot be combined with promptApplicationId.

promptVersionId
string<uuid>

Restrict to tasks executed with this Canvas version. The version must be accessible to the caller (404 otherwise).

completionRunId
string<uuid>

Restrict to tasks linked to this completion run.

orderBy
string

Sort field. Either a single field name or a JSON-encoded array of field names for multi-column sorting, e.g. ["status","createdAt"]. Defaults to updatedAt. Allowed values: name, reference, approvedAt, createdAt, updatedAt, id, status, approvedBy, createdBy. status sorts by lifecycle order rather than alphabetically.

order
enum<string>
default:desc

Sort direction. Defaults to desc.

Available options:
asc,
desc
ids
string

JSON-encoded array of task IDs to return, e.g. ["<uuid>","<uuid>"].

taskName
string

Case-insensitive substring match on the task name.

excludeInputOutputColumns
boolean
default:false

When true, omits rawInput, inputContent and originalOutputContent from each task and adds a lightweight inputFiles summary instead (unless excludeInputFiles is also true).

excludeInputFiles
boolean
default:false

Only meaningful together with excludeInputOutputColumns=true; suppresses the inputFiles summary.

excludeOutputContent
boolean
default:false

When true, omits outputContent from each task.

tags
string

Tags the task must contain (all of them). Accepts either a JSON-encoded array (["a","b"]) or a comma-separated list (a,b). Values are trimmed and de-duplicated.

Response

Paginated list of tasks

data
Task · object[]
required
meta
Pagination metadata · object
required