GEgetaptly
Tasks

Search tasks

Query tasks for the authenticated company. All body fields are optional filters. Date-range filters (dueAt, checkedAt, updatedAt) take an object of { startDate, endDate } — either bound may be supplied independently. Set useCount: true to return { count } instead of { tasks }.

post/api/tasks/search

Request

Request body

userIdsstring[]

Restrict to tasks assigned to these user ids.

isCheckedboolean

Filter by completion state.

isPinnedboolean
archivedboolean
taskPrioritystring

One of asap|high|medium|low. The search filter is named taskPriority; the field is priority on the task itself and in update bodies.

streamIdstring
channelIdstring
aptletUuidstring

Board UUID.

aptletInstanceIdstring
leaderboardboolean
onlyAssignedboolean
unAssignedboolean
useCountboolean

Return a count instead of the task list.

limitinteger

Response

Matching tasks (or a count).

countinteger

Present instead of tasks when useCount is true.

Changes

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