Skip to main content
GET
Get what was written in an activity

Authorizations

Authorization
string
header
required

An API key, sent as Authorization: Bearer stfy_live_…. See Authentication for how to get one and which scopes it needs.

Path Parameters

activity_id
string
required

The activity's id, from GET /v1/activities

Query Parameters

limit
integer
default:100

Messages per page

Required range: 1 <= x <= 500
cursor
string | null

next_cursor from the previous page, for more messages

Response

200 - application/json

Successful Response

activity_id
string
required
campaign_email
ActivityCampaignEmail · object | null

A campaign send's email; null on anything else

has_more
boolean
default:false

Whether the thread has more messages than this page

messages
ActivityMessage · object[]

A page of an email, Slack, Teams, ticket, Chatter or LinkedIn thread's messages, oldest first; empty on any other kind

next_cursor
string | null

Pass as cursor for the thread's next messages

note
ActivityNote · object | null

A note's text and author; null on any other kind

pushed
ActivityPushedContent · object | null

A pushed meeting's or event's subject and notes; null on anything else (a pushed thread's words are its messages)

survey_answers
ActivitySurveyAnswer · object[]

A survey response's answers, in the survey's order; empty on any other kind

survey_comment
string | null

A survey response's overall comment, as the survey tool reports it beside the score (some tools keep the respondent's words only here)

type
enum<string> | null

The activity's type

Available options:
email,
meeting,
slack,
teams,
ticket,
survey,
chatter,
note,
linkedin,
marketing_event