Activities Guide

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

Activity Data Structure

Table Format

An activity object contains the following fields:

Field	Type	Description
activityUID	string	Unique activity identifier
action	string	Type of action performed (add, remove, change, complete, clear, queue, send, queue-to)
createdAt	datetime	When the activity was created
createdBy	string	Name of user who created the activity
createdByUID	string	UID of user who created the activity
data	object	Additional data associated with the activity
failedAt	datetime	When the activity failed (if applicable)
GTID	string	GroupTrack ID of the related contact
link	string	URL link associated with the activity
note	string	Activity notes
pipelineUID	string	UID of the pipeline associated with the activity
platform	string	Platform where activity occurred (e.g., Instagram, Facebook)
prioritizedAt	datetime	When the activity was prioritized
queuedTo	string	Name of person activity was queued to
queuedToUID	string	UID of person activity was queued to
reasonCode	string	Code for failure reason
reasonText	string	Text description of failure reason
sentAt	datetime	When the activity was sent
stageUID	string	UID of the stage associated with the activity
status	string	Current status (sent, queued, failed, pending)
statusLabel	string	Label for the activity status
tagName	string	Name of tag associated with the activity
tagSetUID	string	UID of tag set associated with the activity
teamMember	string	Team member associated with the activity
teamMemberUID	string	UID of team member associated with the activity
type	string	Type of activity (initial, gender, birthDate, name, message, note, team, pipeline, stage, friend_request, tag, status, statusLabel, post, email, task, phone, sync, pin, info)

TypeScript Schema Format

interface Activity {
  activityUID: string; // Unique activity identifier
  action?: string | null; // Type of action performed
  createdAt?: Date | null; // When the activity was created
  createdBy?: string | null; // Name of user who created the activity
  createdByUID?: string | null; // UID of user who created the activity
  data?: any; // Additional data associated with the activity
  failedAt?: Date | null; // When the activity failed
  GTID?: string | null; // GroupTrack ID of the related contact
  link?: string | null; // URL link associated with the activity
  note?: string | null; // Activity notes
  pipelineUID?: string | null; // UID of the pipeline associated with the activity
  platform?: string | null; // Platform where activity occurred
  prioritizedAt?: Date | null; // When the activity was prioritized
  queuedTo?: string | null; // Name of person activity was queued to
  queuedToUID?: string | null; // UID of person activity was queued to
  reasonCode?: string | null; // Code for failure reason
  reasonText?: string | null; // Text description of failure reason
  sentAt?: Date | null; // When the activity was sent
  stageUID?: string | null; // UID of the stage associated with the activity
  status?: string | null; // Current status
  statusLabel?: string | null; // Label for the activity status
  tagName?: string | null; // Name of tag associated with the activity
  tagSetUID?: string | null; // UID of tag set associated with the activity
  teamMember?: string | null; // Team member associated with the activity
  teamMemberUID?: string | null; // UID of team member associated with the activity
  type?: string | null; // Type of activity
}

Searching Activities

You can search for activities 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 activities by type
GET "/activities?filter[type]=message"

# Search for activities created after a specific date
GET "/activities?filter[createdAt][gt]=2025-01-01"

# Search for activities by contact GTID
GET "/activities?filter[GTID]=contact123"

# Search for activities with a specific status
GET "/activities?filter[status]=sent"

Activity Filters

Filter	Type	Description	Comparators
activityUID	Text	The activity's unique identifier	eq, exists, like
action	Text	The activity's action type	eq, exists, like
createdAt	Datetime	When the activity was created	eq, exists, lt, lte, gt, gte
createdBy	Text	The name of the activity's creator	eq, exists, like
createdByUID	Text	The UID of the activity's creator	eq, exists, like
failedAt	Datetime	When the activity failed	eq, exists, lt, lte, gt, gte
GTID	Text	The contact's GroupTrack ID	eq, exists, like
link	Text	The activity's associated link	eq, exists, like
note	Text	The activity's notes	eq, exists, like
pipelineUID	Text	The activity's pipeline UID	eq, exists, like
platform	Text	The platform where the activity occurred	eq, exists, like
prioritizedAt	Datetime	When the activity was prioritized	eq, exists, lt, lte, gt, gte
queuedTo	Text	The name the activity was queued to	eq, exists, like
queuedToUID	Text	The UID the activity was queued to	eq, exists, like
reasonCode	Text	The activity's failure reason code	eq, exists, like
reasonText	Text	The activity's failure reason text	eq, exists, like
sentAt	Datetime	When the activity was sent	eq, exists, lt, lte, gt, gte
stageUID	Text	The activity's stage UID	eq, exists, like
status	Text	The activity's status	eq, exists, like
statusLabel	Text	The activity's status label	eq, exists, like
tagName	Text	The activity's tag name	eq, exists, like
tagSetUID	Text	The activity's tag set UID	eq, exists, like
teamMember	Text	The team member associated with the activity	eq, exists, like
teamMemberUID	Text	The UID of the team member associated with the activity	eq, exists, like
type	Text	The activity's type	eq, exists, like