Skip to main content

When to list Tasks

GET /task/list returns your organization’s Tasks as a paginated, filtered, and sorted collection. Reach for it whenever you need more than a single Task by ID:
  • Dashboards — show every Task created today, or everything currently waiting on input.
  • Reconciliation — sweep the Tasks you created in a date window and match them back to your own records by external_id, catching anything you missed a callback for.
The list is always scoped to the organization behind your bearer token; you never see another org’s Tasks.

The response shape

The endpoint returns a GetTasksResponse: Each TaskSummary carries the Task’s metadata — uuid, external_id, task_type, status, name, cleared, created, and latest_status_change. It is the summary shape, not the full TaskDetails; fetch a single Task with GET /task/get when you need its data_items, verdicts, or issues.

Pagination

Page through results with offset and length: Walk the pages by advancing offset by length until you have collected count Tasks.
An offset past the end of the result set is not an error. The API returns 200 OK with your requested offset echoed back and an empty tasks list. Loop until tasks comes back empty, or until offset >= count.

Filtering

Combine any of these query parameters; they are ANDed together. status accepts the wire TaskStatus values: pending, processing, waiting, completed, failed, invalid.
cleared is asymmetric. You set cleared with a boolean via update; it reads back as the timestamp it was set at (or null). So the list filter and TaskSummary.cleared you get back is a timestamp (or null), while the filter parameter above takes a boolean presence check.
selected_date (DateFlavor) chooses which timestamp the date window applies to:
cURL

Sorting

cURL
For stable reconciliation runs, sort by a fixed key (e.g. order_by=created with sort_ascending=true) and page all the way to count. Because the default sort is descending, newly created Tasks appear on the first page — handy for a “latest activity” dashboard, but shift results underneath you mid-run, so pin the sort and, if needed, a date_to upper bound.

Working with async results

Fetch and poll a single Task once you have its ID.

Tasks

The Task resource and its status lifecycle.