v1

latestOpenAPI 3.1.02026-07-26359254.7 MB

Tasks

Filter tasks

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

post/v3/tasks/filter

Query parameters

topinteger

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

skipinteger

Number of items to skip.

Request body

fromstring date-time nullable

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

tostring date-time nullable

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

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.

sequenceIdsinteger[] nullable

Filter tasks belonging to these sequences.

sequenceStepIdsinteger[] nullable

Filter tasks belonging to these sequence steps.

timeZoneIdsstring[] nullable

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

contactIdinteger nullable

Filter tasks for a specific contact.

assignedUserIdinteger nullable

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

overdueboolean nullable

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

Response

Filtered tasks retrieved successfully.

hasMoreboolean