Skip to content

Get Activity Feed

GET
/activity-feed

One timeline over everything that happened to a record.

Replaces four separate per-type reads. entity_type decides which record scope authorises the call, and all four are resolved from the CALLING KEY’S OWN credential scopes - so a key without deals:read resolves the deal scope to nothing and cannot read a deal’s feed through this path, even though the key gate on the route is contacts:read.

Authorizations

Parameters

Query Parameters

entity_type
required

Contact | company | deal | team_member

string

Contact | company | deal | team_member

entity_id
required

Id of that record.

string

Id of that record.

types
Any of:
string

Comma-separated subset of task,note,email,call,meeting,sms,chat,stage_change,quote,record_change,deal. Omit for all.

source

Manual | crm | system | dialer | automation | api | all

string
default: all

Manual | crm | system | dialer | automation | api | all

since
Any of:
string

ISO 8601 cursor; returns events at or after it.

limit
integer
default: 50 >= 1 <= 200

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

An open envelope for a LIST result, so a bare list keeps its shape.

object
items
Array
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string