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

Authorizations

X-API-Key
string
header
required

API key passed in the X-API-Key header

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. Defaults to now + 1 year if omitted.

taskType
integer | null

Filter by task type. 0 = ToDo, 2 = Call, 4 = Meeting, 5 = LinkedIn, 7 = ManualEmail, 8 = Sms, 9 = WhatsApp.

status
integer | null

Filter by task status. 0 = New, 1 = Finished, 3 = Cancelled, 4 = Archived, 5 = SequenceDetached.

linkedInTaskType
integer | null

Filter by LinkedIn action subtype. 0 = Message, 1 = Connect, 2 = InMail, 3 = ViewProfile.

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

200 - application/json

Filtered tasks retrieved successfully.

items
TaskListItemResponse · object[]
hasMore
boolean