Skip to content

Hot Contacts

GET
/inbox/hot-contacts

Most-engaged (‘hot’) contacts ranked by recent INBOUND interaction events (replies / opens / meeting RSVPs) — NOT a static score column.

Org-scoped to the authenticated key’s organization. Registered before /{reply_id} so ‘hot-contacts’ isn’t captured as an id.

Authorizations

Parameters

Query Parameters

days

Lookback window in days

integer
default: 30 >= 1 <= 365

Lookback window in days

limit

Max contacts to return

integer
default: 10 >= 1 <= 50

Max contacts to return

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required
object
contacts
Array<object>

One most-engaged contact (ranked by recent inbound activity).

object
contact_id
required
string
email
Any of:
string
events

Inbound interaction events in the window

integer
last_at
Any of:
string
meetings

Of those events, how many were meetings

integer
who
Any of:
string
days
required
integer
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