Skip to main content
POST
Search tasks

Authorizations

x-token
string
header
required

Body

application/json
userIds
string[]

Restrict to tasks assigned to these user ids.

isChecked
boolean

Filter by completion state.

isPinned
boolean
archived
boolean
default:false
taskPriority
string

One of asap|high|medium|low.

streamId
string
channelId
string
aptletUuid
string

Board UUID.

aptletInstanceId
string
leaderboard
boolean
onlyAssigned
boolean
unAssigned
boolean
useCount
boolean

Return a count instead of the task list.

limit
integer
default:1000
dueAt
object

Date-range filter. Either bound may be supplied independently — startDate maps to $gte, endDate to $lte.

checkedAt
object

Date-range filter. Either bound may be supplied independently — startDate maps to $gte, endDate to $lte.

updatedAt
object

Date-range filter. Either bound may be supplied independently — startDate maps to $gte, endDate to $lte.

Response

Matching tasks (or a count).

tasks
object[]
count
integer

Present instead of tasks when useCount is true.