---
title: "Filter tasks"
method: POST
path: "/v3/tasks/filter"
tags: ["Tasks"]
---

# Filter tasks

`POST /v3/tasks/filter`

<small>_Requires the `tasks:read` scope (or a broader one that includes it)._</small>

Returns a filtered, paginated list of tasks.
Pagination params (`top`, `skip`) are in query string; filter criteria in request body.
All filter fields are optional — an empty body `{}` returns all tasks.
The request body must be a valid JSON object; a missing or unparseable body returns 400.

## Query parameters

- `top` integer
- `skip` integer

## Request body

- object — Request body for the POST /tasks/filter endpoint. All fields are optional — an empty object `{}` returns all tasks visible to the caller.
  - `from` string, date-time, nullable — Filter tasks with StartAt >= this value. Defaults to 2000-01-01 if omitted.
  - `to` string, date-time, nullable — Filter tasks with StartAt <= this value. Must be after `from` when both are provided. Defaults to now + 1 year if omitted.
  - `taskType` 'toDo' | 'call' | 'meeting' | 'linkedIn' | 'manualEmail' | 'sms' | 'whatsApp', nullable — Filter by task type. Must be a valid enum value. Possible values: `toDo`, `call`, `meeting`, `linkedIn`, `manualEmail`, `sms`, `whatsApp`.
  - `status` 'new' | 'finished' | 'cancelled' | 'archived' | 'sequenceDetached', nullable — Filter by task status. Must be a valid enum value. Possible values: `new`, `finished`, `cancelled`, `archived`, `sequenceDetached`.
  - `sequenceIds` integer[], nullable — Filter tasks belonging to these sequences.
  - `sequenceStepIds` integer[], nullable — Filter tasks belonging to these sequence steps.
  - `timeZoneIds` string[], nullable — Filter by prospect timezone (e.g. "America/New_York").
  - `contactId` integer, nullable — Filter tasks for a specific contact.
  - `assignedUserId` integer, nullable — Filter tasks assigned to a specific user. Only returns results if the caller has permission to view that user's tasks.
  - `overdue` boolean, nullable — Filter by overdue status. `true` = overdue only, `false` = not overdue only, `null` = all.

## Response `200`

Filtered tasks retrieved successfully.

- object
  - `items` object[]
    - `id` integer — Task ID.
    - `taskType` 'toDo' | 'call' | 'meeting' | 'linkedIn' | 'manualEmail' | 'sms' | 'whatsApp' — Task type. Possible values: `toDo`, `call`, `meeting`, `linkedIn`, `manualEmail`, `sms`, `whatsApp`.
    - `status` 'new' | 'finished' | 'cancelled' | 'archived' | 'sequenceDetached' — Task status. Possible values: `new`, `finished`, `cancelled`, `archived`, `sequenceDetached`.
    - `linkedInTaskType` 'message' | 'connect' | 'inMail' | 'viewProfile', nullable — LinkedIn action subtype. Possible values: `message`, `connect`, `inMail`, `viewProfile`.
    - `assignedUserId` integer — ID of the user this task is assigned to.
    - `contact` object, nullable — Minimal contact information embedded in task list responses.
      - `id` integer, required — Contact (prospect) ID.
      - `fullName` string, nullable — Contact's full name.
    - `startAt` string, date-time — Task start time.
    - `dueTo` string, date-time — Task due time.
    - `finishedAt` string, date-time, nullable — When the task was completed. Null for active tasks.
    - `isScheduled` boolean — Whether the task is scheduled for automatic execution.
    - `sequenceId` integer, nullable — Sequence ID if this task was created by a sequence.
    - `sequenceStepId` integer, nullable — Sequence step ID.
  - `hasMore` boolean

## Other responses

- `400` — Validation failure on the request body, query parameters, or pagination (e.g. missing/unparseable body, invalid `taskType`/`status` enum values, `to` before `from`, `top` out of range, `skip` negative).
- `401` — Unauthorized. The response body is empty; check the `WWW-Authenticate` header for the expected scheme.
- `403` — User lacks required feature scope to view tasks
- `429` — Too Many Requests

---

[API](https://skmtc.dev/reply/apis/reply-api.md) · [All operations](https://skmtc.dev/reply/apis/reply-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/reply/reply-api/revisions/1c3d32eaf95e/schema)
