List Tasks

Authorizations

Authorization

string

header

required

Bearer API key issued from Settings → Developers.

Query Parameters

page

integer

default:1

Page number.

Required range: x >= 1

size

integer

default:10

Number of items per page.

Required range: 1 <= x <= 100

sort_by

enum<string> | null

Field to sort by.

Available options:

created_at,

updated_at

sort_order

enum<string>

default:asc

Sort direction.

Available options:

asc,

desc

sequence_id

string<uuid> | null

Filter by an individual sequence run.

sequence_template_ids

string<uuid>[] | null

Filter by sequence template. Repeat the parameter to pass multiple values.

types

enum<string>[] | null

Filter by task type. Repeat the parameter to pass multiple values.

Available options:

EMAIL_REPLY,

LINKEDIN_REPLY,

NEW_LEAD_REVIEW,

CALL,

PLAYBOOK_APPROVAL,

TODO

status

enum<string> | null

Filter by status.

Available options:

PENDING,

IN_PROGRESS,

COMPLETED,

SKIPPED

priorities

enum<string>[] | null

Filter by priority bucket. Repeat the parameter to pass multiple values.

Available options:

HOT,

TODAY,

EXTRA

assignee_user_id

string<uuid> | null

Filter by assignee.

contact_id

string<uuid> | null

Filter by contact linked to the task or its sequence.

created_at_after

string<date-time> | null

Return tasks created strictly after this timestamp.

created_at_before

string<date-time> | null

Return tasks created strictly before this timestamp.

Response

200 - application/json

Successful Response

items

TaskPublicOutput · object[]

required

Records on this page.

Hide child attributes

items.id

string<uuid>

required

Unique identifier.

items.organization_id

string<uuid>

required

Workspace this task belongs to.

items.type

enum<string>

required

What kind of task this is.

Available options:

EMAIL_REPLY,

LINKEDIN_REPLY,

NEW_LEAD_REVIEW,

CALL,

PLAYBOOK_APPROVAL,

TODO

items.priority

enum<string>

required

Task priority bucket.

Available options:

HOT,

TODAY,

EXTRA

items.status

enum<string>

required

Current lifecycle state.

Available options:

PENDING,

IN_PROGRESS,

COMPLETED,

SKIPPED

items.sequence_id

string<uuid> | null

required

Sequence run this task was projected from, if any.

items.assignee_user_id

string<uuid> | null

required

User the task is assigned to, if any.

items.disposition

enum<string> | null

required

Outcome for call tasks once executed.

Available options:

ANSWERED,

VOICEMAIL_LEFT,

NO_ANSWER,

INTERESTED,

NOT_INTERESTED,

WRONG_NUMBER

items.reopened_at

string<date-time> | null

required

When the task was last reopened, if ever.

items.reopen_reason

enum<string> | null

required

Why the task was reopened, if applicable.

Available options:

REMINDER_RULE

items.skipped_at

string<date-time> | null

required

When the task was skipped, if applicable.

items.completed_at

string<date-time> | null

required

When the task was completed, if applicable.

items.created_at

string<date-time>

required

When the task was created.

items.updated_at

string<date-time>

required

When the task last changed.

items.title

string | null

Task title for standalone tasks.

items.due_date

string<date> | null

Due date for standalone tasks.

items.contact

PublicContactSummary · object | null

Summary of the contact linked to this task.

Hide child attributes

items.contact.id

string<uuid>

required

Unique identifier of the contact.

items.contact.first_name

string | null

First name.

items.contact.last_name

string | null

Last name.

items.contact.email

string | null

Email.

items.contact.linkedin_url

string | null

LinkedIn profile URL.

items.contact.job_title

string | null

Job title.

items.contact.company_name

string | null

Employer name.

items.contact.company_domain

string | null

Employer's primary domain.

items.assignee

PublicUserSummary · object | null

Summary of the user this task is assigned to.

Hide child attributes

items.assignee.id

string<uuid>

required

Unique identifier of the user.

items.assignee.email

string

required

Email address.

items.assignee.name

string | null

Display name.

items.sequence_template

PublicSequenceTemplateSummary · object | null

Summary of the sequence template for sequence-derived tasks.

Hide child attributes

items.sequence_template.id

string<uuid>

required

Unique identifier of the sequence template.

items.sequence_template.name

string

required

Template name.

items.snoozed_until

string<date-time> | null

When the task is snoozed until, if deferred.

total_count

integer

required

Total number of records matching the query.

total_pages

integer

required

Total number of pages.

has_more

boolean

required

Whether more pages remain after the current one.

Overview

Users

Contacts

Accounts

Sequences & Tasks

Events & Webhooks

Authorizations

Query Parameters

Response