Skip to main content

Count tasks

Count tasks matching the same payload shape used by Query tasks.

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

This page documents the canonical HTTP contract for this endpoint.

Body parameters

  • filter · optional

    object

    FilterDescriptor tree.

  • search · optional

    string

    Optional free-text search.

  • scope · optional

    string

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

  • pagination · optional

    object

    Accepted by the shared query request model; ignored by count calculation.

  • sort · optional

    array<object>

    Accepted by shared query model; count is independent of ordering.

  • include_skipped · optional

    boolean

    Include skipped tasks in count. Defaults to false.

  • include_total_count · optional

    boolean

    Accepted by shared model but ignored by count endpoint.

  • include_research_values · optional

    boolean

    Accepted by shared model but ignored by count endpoint.

  • research_field_ids · optional

    array<string>

    Accepted by shared model but ignored by count endpoint.

Errors

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

Docs