Get Company Context
GET /customer-success/companies/{company_id}/context
Everything known about this client, in one read.
The assembled picture - contacts, activity, brief state, linked records - rather than a single table. Open-shaped, because what belongs in “the context” grows with the product and a dropped section would read as “nothing there”.
Authorizations
Parameters
Path Parameters
Company id.
Company id.
Header Parameters
Responses
200
Successful Response
object
An open envelope for a single role, team, member or account record.
Open on purpose. The app’s own response models on this surface grow with
the product - RoleResponse gained rep_limits and manages_role_slugs,
TeamResponse gained channel counts and a campaign count - and a pinned
mirror would SILENTLY DROP whatever it had not caught up on. A dropped
permission in a role read is the worst possible kind of stale: it reads as
“they do not have it”.
object
object
Whether there are more pages
Items per page
Current page number (1-indexed)
Total number of items
422
Validation Error