Skip to main content
POST
/
v3
/
tasks
/
filter
Filter tasks
curl --request POST \
  --url https://api.reply.io/v3/tasks/filter \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "from": "2023-11-07T05:31:56Z",
  "to": "2023-11-07T05:31:56Z",
  "taskType": "toDo",
  "status": "new",
  "sequenceIds": [
    123
  ],
  "sequenceStepIds": [
    123
  ],
  "timeZoneIds": [
    "<string>"
  ],
  "contactId": 123,
  "assignedUserId": 123,
  "overdue": true
}
'
{
  "items": [
    {
      "id": 123,
      "taskType": "toDo",
      "status": "new",
      "linkedInTaskType": "message",
      "assignedUserId": 123,
      "contact": {
        "id": 123,
        "fullName": "<string>"
      },
      "startAt": "2023-11-07T05:31:56Z",
      "dueTo": "2023-11-07T05:31:56Z",
      "finishedAt": "2023-11-07T05:31:56Z",
      "isScheduled": true,
      "sequenceId": 123,
      "sequenceStepId": 123
    }
  ],
  "hasMore": true
}

Documentation Index

Fetch the complete documentation index at: https://docs.reply.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Authenticate every request with a Bearer token. Pass your Reply API key in the Authorization header:

Authorization: Bearer <your-api-key>

Get your API key from the Reply dashboard: Settings → API Key.

Query Parameters

top
integer

Maximum number of items to return (default 25, max 1000).

skip
integer

Number of items to skip.

Body

application/json

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> | null

Filter tasks with StartAt >= this value. Defaults to 2000-01-01 if omitted.

to
string<date-time> | null

Filter tasks with StartAt <= this value. Must be after from when both are provided. Defaults to now + 1 year if omitted.

taskType
enum<string> | null

Filter by task type. Must be a valid enum value. Possible values: toDo, call, meeting, linkedIn, manualEmail, sms, whatsApp.

Available options:
toDo,
call,
meeting,
linkedIn,
manualEmail,
sms,
whatsApp
status
enum<string> | null

Filter by task status. Must be a valid enum value. Possible values: new, finished, cancelled, archived, sequenceDetached.

Available options:
new,
finished,
cancelled,
archived,
sequenceDetached
sequenceIds
integer[] | null

Filter tasks belonging to these sequences.

sequenceStepIds
integer[] | null

Filter tasks belonging to these sequence steps.

timeZoneIds
string[] | null

Filter by prospect timezone (e.g. "America/New_York").

contactId
integer | null

Filter tasks for a specific contact.

assignedUserId
integer | null

Filter tasks assigned to a specific user. Only returns results if the caller has permission to view that user's tasks.

overdue
boolean | null

Filter by overdue status. true = overdue only, false = not overdue only, null = all.

Response

Filtered tasks retrieved successfully.

items
TaskListItemResponse · object[]
hasMore
boolean