Skip to content

Query Universal Activity

POST
/universal-activity

The unified activity timeline, cursor-paginated.

POST rather than GET because the filter set is large and structured - matching the app, so a rebuilt inbox sends the same body.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body

Filter set for the unified activity timeline. Every field is optional.

org_id is deliberately ABSENT: the org comes from the API key’s own principal, never from the body, so a client cannot steer the query at another tenant.

object
assignee_emails
Any of:
Array<string>
campaign_ids
Any of:
Array<string>
channels
Any of:
Array<string>
company_id
Any of:
string
contact_id
Any of:
string
cursor
Any of:
string
direction
Any of:
string
exclude_tag_ids
Any of:
Array<string>
page_size

Rows per page (1-100).

integer
default: 15 >= 1 <= 100
queue
Any of:
string
Allowed values: hot_replies follow_up booked_meetings everything
search
Any of:
string
tag_ids
Any of:
Array<string>
updated_after
Any of:
string format: date-time
updated_before
Any of:
string format: date-time
workspace_all_mail
Any of:
boolean
workspace_id
Any of:
string

Responses

200

Successful Response

object
data
required
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

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