Get Company Inbox
GET /customer-success/companies/{company_id}/inbox
GET
/customer-success/companies/{company_id}/inbox
Every conversation with anyone at this company, across channels.
The company-level view of the inbox: merged and ordered by date, rather than one thread per contact.
Authorizations
Parameters
Path Parameters
company_id
required
Company id.
string
Company id.
Query Parameters
limit
integer
offset
integer
Header Parameters
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
notes
Any of:
Array<string>
null
page
required
Current page number (1-indexed)
integer
total
required
Total number of items
integer
null
422
Validation Error
object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string