Skip to main content
GET
Get a catch-up

Authorizations

Authorization
string
header
required

Bearer token authentication

Path Parameters

id
string
required

Response

Success

A catch-up raised for a member: a suggestion to follow up with someone, plus the actions it proposes.

id
integer
suggestion_title
string | null

Short headline shown to the member.

suggestion_description
string | null

Why the catch-up was raised and what to do about it.

mocked
boolean | null

True for sample catch-ups generated for demos and testing.

catch_up_class
string | null

Trigger that produced the catch-up, such as CART_ABANDONED or CUSTOM_CATCH_UP.

company
integer

ID of the company the catch-up belongs to.

user_company
integer | null

ID of the member the catch-up was raised for, or null when that member no longer resolves.

status
boolean

True while at least one of the catch-up's actions is still pending.

catch_up_actions
object[]

Every action the catch-up proposes, whatever its status.