Skip to main content
GET
List contact activities

Authorizations

Authorization
string
header
required

Bearer token authentication using your API key

Path Parameters

org_id
string
required

Org ID

contact_id
string
required

Contact ID

Query Parameters

type
enum<string>

Only activities of this type.

Available options:
comment_created,
file_uploaded,
segment_added,
segment_removed,
contact_blocked,
contact_unblocked,
contact_unsubscribed,
contact_resubscribed,
contact_ai_replies_disabled,
contact_ai_replies_enabled,
contact_updated
contact_id
string

Filter to activities scoped to this contact.

Maximum string length: 128
table_id
string

Filter to activities scoped to this table.

Maximum string length: 128
record_id
string

Filter to activities scoped to this table record.

Maximum string length: 128
actor_id
string

Filter to activities performed by this user.

Maximum string length: 128
assistant_id
string

Filter to activities performed by this assistant.

Maximum string length: 128
segment_id
string

Filter to activities involving this segment.

Maximum string length: 128
page
number

Page number

take
number

Number of items to take

next
string

Next page token (Only used on special endpoints)

Response

200 - application/json
id
string
required
type
enum<string>
required

Schema for the type of an activity event

Available options:
comment_created,
file_uploaded,
segment_added,
segment_removed,
contact_blocked,
contact_unblocked,
contact_unsubscribed,
contact_resubscribed,
contact_ai_replies_disabled,
contact_ai_replies_enabled,
contact_updated
attachments
object[]
required

The files the activity carries: a comment's attachments, an upload's file

created_at
string<date-time> | null
required
updated_at
string<date-time> | null
required
actor
object

Schema for a limited user

assistant
object

Schema for an assistant actor in an activity

agent
object

A reduced agent reference

channel
object

The contact channel that reported the change (a new phone, username or user ID), with no member behind it

segment
object

Schema for the segment

broadcast
object

Public information about a broadcast

comment
string | null

Comment body when type='comment' (null/undefined otherwise)

message_id
string

The private note this comment mirrors, when it was written in a conversation

chat
object

The chat behind the comment: the conversation a note was written in, or the run that answered a tag

metadata
object

Activity metadata payload. Discriminated by type, which mirrors the parent activity row type.