Skip to main content
GET
List activities

Authorizations

Authorization
string
header
required

Bearer token authentication

Query Parameters

page
integer

Page number, starting at 1. Each page holds 30 activities.

Required range: x >= 1
days_ago
string

Only return activities created within this many days.

Response

Success

id
integer

Activity ID.

user_id
integer

User whose feed the activity belongs to.

title
string | null

Activity headline.

description
string | null

Activity detail text.

read_at
string<date-time> | null

When the activity was read, or null while unread.

created_at
string<date-time>
relation_type
string | null

Type of the record the activity is about, for example Contact, View, or Medium.

company_id
integer | null

Company the activity belongs to.

slug
string | null

Activity type, for example new_lead, order_placed, page_views, or imported.

state
enum<string>

new for activities from the last 7 days, otherwise earlier.

Available options:
new,
earlier
relation
object | null

Attributes of the related record. Only returned for View and Medium relations that belong to the same company; null otherwise.

contact
object | null

Contact the activity is about, if any. When the caller is a customer member and the contact belongs to someone else, the contact is identified only by id, first_name, last_name, full_name, avatar_url, status, and discarded_at; its email, phone, address, and other details are omitted. A customer's own contacts are returned in full.

visitor
object | null

Visitor the activity is about, if any. When the caller is a customer member, the visitor is returned only if it came through the customer and the activity names no contact that belongs to someone else, and then without token, ip_address, ip, latitude, or longitude; otherwise it is null.