Skip to main content

Query tasks

Query/filter tasks with descriptor payloads and cursor pagination.

POST/api/task-queue/query
HTTP referenceScope tasks:readUpdated September 27, 2026

This page documents the canonical HTTP contract for this endpoint.

Body parameters

  • filter · optional

    object

    Optional FilterDescriptor tree for task filtering.

  • search · optional

    string

    Optional free-text search.

  • scope · optional

    string

    Legacy org or user scope toggle; prefer a descriptor rule on field scope.

  • sort · optional

    array<object>

    Sort specs; each item is { field, direction }. Defaults to due_date ascending.

  • pagination · optional

    object

    Pagination object { limit, cursor }. Default limit is 50.

  • include_skipped · optional

    boolean

    Include skipped/deleted tasks. Defaults to false.

  • include_total_count · optional

    boolean

    Include total count in response. Defaults to true.

  • include_research_values · optional

    boolean

    Hydrate live research values. Defaults to true.

  • research_field_ids · optional

    array<string>

    Restrict research hydration to these field IDs. Empty array skips hydration entirely.

Errors

StatusMeaning
400Invalid descriptor payload.
401Invalid API key or missing auth.
403Missing tasks:read scope.

Docs