Skip to main content
POST
/
api
/
tasks
/
search
Search tasks
curl --request POST \
  --url https://core-api.getaptly.com/api/tasks/search \
  --header 'Content-Type: application/json' \
  --header 'x-token: <api-key>' \
  --data '
{
  "isChecked": false,
  "archived": false,
  "taskPriority": "high",
  "dueAt": {
    "startDate": "2026-06-01T00:00:00.000Z",
    "endDate": "2026-06-30T00:00:00.000Z"
  },
  "limit": 100
}
'
{
  "tasks": [
    {
      "_id": "<string>",
      "companyId": "<string>",
      "title": "<string>",
      "mergedTitle": "<string>",
      "description": "<string>",
      "mergedDescription": "<string>",
      "userId": "<string>",
      "checked": true,
      "archived": true,
      "status": "<string>",
      "priority": "<string>",
      "dueAt": "2023-11-07T05:31:56Z",
      "aptletInstanceId": "<string>",
      "aptletUuid": "<string>",
      "attachments": [
        {
          "_id": "<string>",
          "name": "<string>",
          "type": "<string>"
        }
      ],
      "priorityLabel": "<string>",
      "statusLabel": "<string>",
      "assignee": {
        "_id": "<string>",
        "fullName": "<string>"
      }
    }
  ],
  "count": 123
}

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.