to-do

GET /to-do

Request

  • Base URL
    https://api.focusbear.io (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Query parameters

order'ASC' | 'DESC'
pagenumber
takenumber
status'NOT_STARTED' | 'IN_PROGRESS' | 'COMPLETED'
exclude_completedboolean

Exclude effectively completed tasks before pagination. Known native custom columns override raw status; other tasks use materialized COMPLETED status. Intersects the optional status filter. When applied, response meta.excludesCompleted is true.

eisenhower_quadrantnumber
should_use_cacheboolean

Deprecated. GET /to-do always serves cached data; integration freshness is driven by the off-thread sync worker. This field is ignored.

project_idstring uuid

Filter tasks belonging to a native Focus Bear project.

project_idsstring[]

Tasks in any of these native projects (comma-separated, repeated, or both). Empty = no project filter. Intersects project_id when both are sent.

sort_mode'SMART' | 'CHRONOLOGICAL' | 'DUE_DATE'

Ordering strategy for the returned page. SMART ranks by the computed TOP score, CHRONOLOGICAL by creation time — both honour the order param. DUE_DATE sorts by task due date ascending (earliest and overdue first) with undated tasks last, tie-broken by id; it ignores order, which is always treated as ascending.

scope'OWNED' | 'MINE'

OWNED (default) returns every to-do the caller owns, whoever it is assigned to. MINE returns the caller's own work: to-dos they own that are unassigned or assigned to themselves, plus native project to-dos a colleague owns and assigned to them in a project they still own or are an accepted member of. To-dos the caller owns but assigned to someone else are left out.

include_commentsboolean

Include comments (with reactions) for each task

include_reactionsboolean

Include task-level reactions for each task

tag_idstring uuid
perspiration_gtenumber
perspiration_ltenumber
synced_project_idstring uuid

Changes

No recorded changes to this operation across all 1 revision of this API.