Skip to main content
GET
List tasks
Returns a paginated list of tasks visible to the authenticated organization. Each task includes its current status, owner, schedule summary, and run statistics so you can build dashboards or sync task inventories to external systems without additional calls.

Request

Query parameters

  • limit (integer, optional) — Number of tasks to return per page. Min 1, max 100, default 20.
  • offset (integer, optional) — Number of tasks to skip for pagination. Default 0.
  • search (string, optional) — Filter tasks by name (case-insensitive substring match).
  • status (string, optional) — Filter by task status: DRAFT, PROCESSING, NEEDS_REVIEW, READY, ERROR.

Example

Responses

  • 200 OK — Returns { "tasks": Task[], "total": int, "limit": int, "offset": int }.
  • 401 Unauthorized — Missing or malformed API key.

Task object

Each item in the tasks array contains:
  • id (UUID) — Unique task identifier.
  • name (string) — Task name.
  • description (string) — Task description (empty string if not set).
  • status (string) — Current status: DRAFT, PROCESSING, READY, or ERROR.
  • createdAt (string) — ISO 8601 creation timestamp.
  • updatedAt (string) — ISO 8601 last-updated timestamp.
  • owner (object | null) — { "name": "..." } if an owner is assigned.
  • createdBy (object | null) — { "name": "..." } for the task creator.
  • inputs (array) — Declared input schema for the task.
  • outputs (array) — Declared output schema for the task.
  • schedule (object | null) — Embedded schedule summary (see below), or null if no schedule.
  • runCount (integer) — Total number of runs for this task.
  • lastRunAt (string | null) — ISO 8601 timestamp of the most recent run.

Schedule summary

When a task has a schedule, the schedule field contains:
  • isActive (boolean) — Whether the schedule is currently active.
  • cadenceType (string) — Schedule cadence type (e.g., cron).
  • cronExpression (string) — Cron expression for the schedule.
  • timezone (string) — IANA timezone for the schedule.
  • nextRunAt (string | null) — Next scheduled execution time.
  • lastRunAt (string | null) — Last scheduled execution time.

Authorizations

Authorization
string
header
required

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

Query Parameters

limit
integer
default:20

Number of tasks per page (1-100, default 20).

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

Number of tasks to skip.

Required range: x >= 0

Filter tasks by name (case-insensitive substring match).

status
enum<string>

Filter by task status.

Available options:
DRAFT,
PROCESSING,
NEEDS_REVIEW,
READY,
ERROR

Response

Tasks returned successfully.

tasks
object[]
required
total
integer
required
limit
integer
required
offset
integer
required