Skip to content

Get Contact Inbox

GET
/customer-success/contacts/{contact_id}/inbox

The same rollup, narrowed to ONE person at the company.

Authorizations

Parameters

Path Parameters

contact_id
required

Contact id.

string

Contact id.

Query Parameters

limit
integer
default: 50 >= 1 <= 200
offset
integer

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

An open envelope for a LIST result, so a bare list keeps its shape.

Most of these handlers return a bare list[...]; a few return a named envelope ({"team_members": [...], "total": n}). Both are reachable as items, and a named envelope KEEPS its own key as well so a caller already reading the app’s shape is not broken by the wrapper.

object
items
Array
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