List a contact's activity history: recent events such as campaign emails sent, link clicks, list and automation changes, notes

The activity feed of one contact: its history of what the contact has done recently and which campaigns and emails were sent to it, as events recorded over time. Email opens are not activities: this feed shows sends (Log) and clicks (LinkData) but cannot say whether the contact opened an email. Send contact with the contact id. The request first refreshes that contact's feed from the underlying tables, so recent events appear, then returns the entries. A request without contact reads activities across the whole account; on a large account that scans millions of rows and can run for many minutes, so always scope the read to one contact. Each entry says what happened through reference type and reference_action, and names the underlying record with reference_id and reference (its API type and id). What the types mean: Log, a campaign email was sent to the contact (include reference.log.campaign to see which campaign); LinkData, the contact clicked a tracked link in a campaign email (include reference.link for the link); MppLinkData, a campaign link was fetched by a mail privacy proxy rather than by the contact; Forward, the contact forwarded a campaign; Reply, the contact replied to a campaign; Update, the contact updated their details through a campaign's update link; SubscriberEmail, a one-to-one email was sent to the contact from the platform; SubscriberList with referenceaction subscribe or unsubscribe, the contact joined or left a list; SubscriberSeries with start or complete, the contact entered or completed an automation; SeriesBlock with goal, the contact reached an automation goal; Note, a note was added to the contact; SubscriberLog with merge, another contact was merged into this one; TrackingLog, a site-tracking or event-tracking hit, with the event name (orpagevisit for a page visit) in reference_action; SmsLog, SmsReply and SmsUnsub, an SMS sent, a reply and an opt-out; DealActivity and DealTask, CRM deal activity and tasks; SubscriberConversion, a conversion; EcomOrderActivity, an e-commerce order; HilosFlow and HilosConversation, WhatsApp; Enrichment, a data enrichment run; OmniChannelLinkData, a click on a link in an SMS message; FbAudienceContactLog, the contact was added to or removed from a Facebook custom audience; SubscriberRestoreActivity, the contact was archived (removed) or restored. To keep one kind of event, pass type with one or more API type names separated by commas, for example type=log,link-data; to see only events after a moment, pass after. Results are paged: limit defaults to 20 and is capped at 100, page with offset, and meta.total is the number of matching entries. Always pass orders[tstamp]=desc (newest first) or asc: without it the entries come back grouped by kind, not by time.

📘

Contact ID parameter is now required

A contact ID is required to access this endpoint. This endpoint does not support multiple contact IDs with a single call.

🚧

Organization-Related Nodes Have Been Deprecated

Contact-Organization relationships are now managed through Account-Contact end points


Response Details

  • subscriberid: The unique ID representing the contact (or subscriber) associated with the activity.

  • reference_type: Specifies the type of activity being recorded. The activity types can include, but are not limited to:

    • SubscriberEmail: Activity related to email interactions of a subscriber.
    • DealTask: Refers to tasks related to a deal, such as a task assignment or completion.
    • SubscriberList: Actions related to list subscriptions (e.g., subscribing or unsubscribing).
    • SubscriberSeries: Activities associated with an automation sequence, such as starting or completing a step.
    • Log: General logs related to subscriber actions.
    • Update: Logs an update to a contact, deal, or list.
    • DealActivity: Activities related to a deal, often involving interactions such as emails or tasks.
    • Forward: Forwarding actions related to emails.
    • Reply: Responses to emails or messages.
    • Note: Notes added to a subscriber or deal record.
    • LinkData: Tracks interactions with links, such as clicks in emails.
    • MppLinkData: Link interactions via Apple's Mail Privacy Protection.
    • SmsLog: Tracks SMS messages sent to a contact.
    • SmsReply: Tracks replies to SMS messages.
    • SmsUnsub: Unsubscribe actions via SMS.
    • TrackingLog: Tracks interactions through website or email link tracking.
    • SeriesBlock: A step or block in an automation series.
    • SubscriberLog: Logs general subscriber actions.
    • SubscriberConversion: Tracks a subscriber’s conversion event, such as completing a purchase.
    • FbAudienceContactLog: Tracks actions related to Facebook Custom Audience contact interactions.
    • EcomOrderActivity: Activities related to eCommerce orders, such as tracking purchases or cart interactions.
  • reference_id: A unique ID referencing the specific object or event involved in the activity (e.g., a task, note, or automation step).

  • reference_action: Describes the action performed in relation to the reference_type. Some common examples include:

    • "start": Typically refers to the initiation of an automation or series step.
    • "complete": Indicates the completion of an automation or series step.
    • "subscribe": Refers to a subscription action, such as when a contact subscribes to a list.
    • Other actions might include "add", "update", or be left as an empty string ("") depending on the context.
Query Params
int32

The contact id. Always send it: without it the read covers every activity on the account. Several contacts can be read at once by repeating the key, contact[]=1&contact[]=2.

date-time

Return only entries recorded strictly after this date and time. Any common date format is accepted; a value without a timezone offset is read in the platform timezone, the one the response's other timestamps carry. An unreadable value returns 422.

string

Return only entries of these kinds. One or more API type names separated by commas: log, link-data, mpp-link-data, forward, reply, update, contact-email, contact-list, contact-automation, automation-block, note, contact-log, tracking-log, sms-log, sms-reply, sms-unsub, deal-activity, deal-task, contact-conversion, ecom-order-activity, hilos-flow, hilos-conversation, enrichment, omni-channel-link-data, fb-audience-contact-log, contact-restore-activity. These are the reference_type values written in lower case with dashes, with contact in place of subscriber and automation in place of series; the response's referenceModelName uses the same spelling. The reference_type spelling itself, for example Log or SubscriberList, is accepted too.

boolean

A switch. When the parameter is present with any value, including 0, only one-to-one email activity is returned: SubscriberEmail entries, Reply entries, and deal activities that carry a connected-mailbox email. Leave it out to see every kind of activity.

string
Defaults to activities to include

Related records to attach, separated by commas. The reference record itself is always attached. Values: notes, notes.user, recipients, recipients.recipient, reference, reference.automation, reference.campaign, reference.campaign.campaignList, reference.campaign.campaignMessage, reference.campaignMessage, reference.contact, reference.contactList, reference.contactList.list, reference.deal, reference.deal.contact, reference.dealTasktype, reference.link, reference.list, reference.log, reference.log.campaign, reference.log.contact, reference.log.message, reference.message, reference.note, reference.sms, reference.sms.automation, user

string
enum

Order entries by when they happened: asc for oldest first, desc for newest first.

Allowed:
integer
≤ 100
Defaults to 20

Number of entries to return per request. Defaults to 20; the maximum is 100, and asking for more is capped at 100.

integer
Defaults to 0

Number of entries to skip before returning results. Use with limit to page.

Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Choose an example:
application/json