Skip to main content
GET
List tasks

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Scopes

publicAPI.v2.all

Public API v2

Query Parameters

campaignIdentifier
string

Only return tasks from the campaign with this identifier (the campaign's identifier field, not its ID).

status
string

Filter by status. Separate multiple values with | (for example TODO|PAUSED). TODO matches only tasks that are not yet due; DUE_TODAY and PASTDUE match TODO tasks due today or overdue.

Example:

"TODO|DUE_TODAY"

taskType
string

Filter by task type. Separate multiple values with | (for example call|email). Values are those of the task type field, matched case-insensitively; manual-email also matches legacy email tasks and linkedin-message also matches legacy linkedin tasks.

Example:

"call|email"

limit
integer
default:25

Maximum number of tasks to return. Values above 50 are capped at 50 and negative values use 1; 0 or a non-numeric value uses the default.

Required range: 1 <= x <= 50
offset
integer
default:0

Number of tasks to skip for pagination.

Required range: x >= 0
sortColumn
enum<string>
default:createdAt

Column to sort by. Any other value sorts by createdAt.

Available options:
createdAt,
taskName,
taskDueDate,
engagementStatus,
taskType,
priority,
completedAt,
prospectStatus,
contactStatus,
lastSalesEngagementAt,
contactFullName,
status,
campaignStepDueDay,
campaignStep
sortOrder
enum<string>
default:desc

Sort direction, case-insensitive. Any other value sorts descending.

Available options:
asc,
desc

Response

A page of tasks.

success
boolean
Example:

true

data
object[]
supplementalData
object

Not populated: totalCount and every per-status and per-type count are always 0. To page, increase offset until fewer than limit tasks are returned.