Tasks Guide

This guide provides examples and information on how to interact with the Tasks endpoints of our REST API.

Task Data Structure

Table Format

A task object contains the following fields:

Field	Type	Description
taskUID	string	Unique task identifier
initialTaskUID	string	UID of initial task (if this is a repeat)
bulkTaskUID	string	UID of bulk task (if part of bulk operation)
createdAt	datetime	When the task was created
createdBy	string	Name of user who created the task
createdByUID	string	UID of user who created the task
assignedToUID	string	UID of person task is assigned to
assignedToName	string	Name of person task is assigned to
GTID	string	GroupTrack ID of the related contact
contactName	string	Name of the contact associated with the task
pipelineUID	string	UID of the pipeline associated with the task
dueDate	datetime	When the task is due
taskStatus	string	Current status of the task
taskName	string	Name/title of the task
isRepeating	boolean	Whether the task repeats
notified	array	Notification history for the task

TypeScript Schema Format

interface Task {
  taskUID: string; // Unique task identifier
  initialTaskUID?: string | null; // UID of initial task if this is a repeat
  bulkTaskUID?: string | null; // UID of bulk task if part of bulk operation
  createdAt?: string | number | null; // When the task was created
  createdBy?: string | null; // Name of user who created the task
  createdByUID?: string | null; // UID of user who created the task
  assignedToUID?: string | null; // UID of person task is assigned to
  assignedToName?: string | null; // Name of person task is assigned to
  GTID?: string | null; // GroupTrack ID of the related contact
  contactName?: string | null; // Name of the contact associated with the task
  pipelineUID?: string | null; // UID of the pipeline associated with the task
  dueDate?: Date | null; // When the task is due
  taskStatus?: string | null; // Current status of the task
  taskName?: string | null; // Name/title of the task
  isRepeating?: boolean | null; // Whether the task repeats
  notified?: TaskNotification[] | null; // Notification history for the task
}

interface TaskNotification {
  notifiedOn?: Date | null; // When the notification was sent
  notifiedVia?: string | null; // How the notification was sent
  notificationError?: string | null; // Any error that occurred during notification
}

Searching Tasks

You can search for tasks using various filters. Below are a list of available filters:

For detailed information on how to use these filters and available comparators, see Searching Guide.

Usage Examples

# Search for tasks by name
GET "/tasks?filter[taskName]=Follow up"

# Search for tasks due after a specific date
GET "/tasks?filter[dueDate][gt]=2025-01-01"

# Search for tasks assigned to a person
GET "/tasks?filter[assignedToUID]=user123"

# Search for repeating tasks
GET "/tasks?filter[isRepeating]=true"

Task Filters

Filter	Type	Description	Comparators
actualDueDate	Datetime	The task's actual due date	eq, exists, lt, lte, gt, gte
assignedToName	Text	The name of the person the task is assigned to	eq, exists, like
assignedToUID	Text	The UID of the person the task is assigned to	eq, exists, like
bulkTaskUID	Text	The task's bulk operation UID	eq, exists, like
contactName	Text	The name of the contact associated with the task	eq, exists, like
createdAt	Datetime	When the task was created	eq, exists, lt, lte, gt, gte
createdBy	Text	The name of the task's creator	eq, exists, like
createdByUID	Text	The UID of the task's creator	eq, exists, like
dueDate	Datetime	When the task is due	eq, exists, lt, lte, gt, gte
GTID	Text	The contact's GroupTrack ID	eq, exists, like
initialTaskUID	Text	The UID of the initial task if this is a repeat	eq, exists, like
isRepeating	Boolean	Whether the task repeats	exists
notified.notificationError	Text	Any error in the task's notifications	eq, exists, like
notified.notifiedOn	Datetime	When the task was notified	eq, exists, lt, lte, gt, gte
notified.notifiedVia	Text	How the task was notified	eq, exists, like
pipelineUID	Text	The task's pipeline UID	eq, exists, like
taskName	Text	The task's name/title	eq, exists, like
taskStatus	Text	The task's current status	eq, exists, like
taskUID	Text	The task's unique identifier	eq, exists, like