Customer success

Get Company 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".

get/customer-success/companies/{company_id}/context

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/customer-success/companies/{company_id}/context
  • Auth: HTTP bearer

Path parameters

company_idstring required

Company id.

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Response

Successful Response

dataOrgPayload required

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".

Changes

No recorded changes to this operation across all 2 revisions of this API.