Tasks

List tasks with filters

Changed on

Returns tasks with the full task text replaced by a bounded taskPreview and completion/integration blobs dropped by default — list views only need the preview. Pass fields=full to restore the full AgentTask, or fields=timeline for the narrow shape the dashboard timeline draws. Every shape gives a user caller only tasks of sessions they can read. Fetch a single task in full via GET /api/tasks/{id}. total (the filtered row count, ignoring limit/offset) is computed only with includeTotal=true.

get/api/tasks

Request

  • Base URL
    http://localhost:3013
  • URL
    http://localhost:3013/api/tasks
  • Auth
    HTTP bearer

Query parameters

statusstring
agentIdstring
scheduleIdstring
workflowRunIdstring uuid
keystring

Non-unique asset directory namespace (for example shared/ or personal/<user-id>/drafts/). Runtime write boundaries normalize and validate the canonical form.

keyPrefixstring

Non-unique asset directory namespace (for example shared/ or personal/<user-id>/drafts/). Runtime write boundaries normalize and validate the canonical form.

searchstring

Search task text and title by word or phrase, with a prefix match on the last word, or a task id by prefix. Not a substring match: '2443' does not find '12443', and '%' and '_' are not wildcards.

includeHeartbeat'true' | 'false'
createdAfterstring date-time
createdBeforestring date-time
sourcestring
requestedByUserIdstring
orderBy'lastUpdatedAt' | 'createdAt'
limitinteger nullable
offsetinteger nullable
fields'full' | 'slim' | 'timeline'
includeTotal'true' | 'false'

Response

Paginated task list

totalinteger

Changes

    • info

      added subschema #1 subschema #2 to the response property anyOf list for the response status

    • info

      removed subschema #1 subschema #2 from the response property anyOf list for the response status

    • info

      added the new optional query request parameter workflowRunId