Skip to content

Get Contact Timeline

GET
/contacts/{contact_id}/timeline

The funnel timeline for one contact: what was done, what it cost, what came back.

Read-only. Tenancy: the key’s own organisation is the only schema read, and the contact must be visible to the key (id_kind="pk", the namespace the timeline sources are keyed on, so the gate authorises the same row the handler serves). Every step kind is present in a fixed order; count and cost_credits are null when not recorded, which is not the same as 0. Returns 404 for a contact outside the key’s organisation or visibility and 504 when the read times out. Credit figures are withheld (credits_withheld: true) when the key’s user lacks credits:view.

Authorizations

Parameters

Path Parameters

contact_id
required

Contact primary key (mashup_contacts.id).

integer

Contact primary key (mashup_contacts.id).

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

An open envelope for one record, one dashboard or one job receipt.

Open because most of these reads are COMPUTED shapes - an engagement summary, a next-best-step, an intelligence status - that grow with the product, and dropping a field from an advisory read makes it say “nothing to report” rather than “we did not tell you”.

object
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