Companies

Get Company Dashboard

Everything the company detail view shows, in one call.

The deal it surfaces is filtered by its own ALWAYS-ENFORCED deal scope: being able to see a company never implies being able to see its deals, so a key without deal visibility gets the dashboard with no active deal rather than a deal it should not see.

Open-shaped, and it has three legitimate shapes - a full dashboard, and two shells for companies that have not been through the account pipeline. Read document_status to tell them apart.

get/companies/{company_id}/dashboard

Request

Base URL: https://be.graph8.com/api/v1
URL: https://be.graph8.com/api/v1/companies/{company_id}/dashboard
Auth: HTTP bearer

Path parameters

company_idstring required

Company id.

Headers

Authorizationstring nullable

X-Target-Org-Idstring nullable

Response

Successful Response

dataCrmRecordPayload required

An open envelope for one record, one dashboard or one job receipt.

Open because most of these reads are COMPUTED shapes - an engagement summary, a next-best-step, an intelligence status - that grow with the product, and dropping a field from an advisory read makes it say "nothing to report" rather than "we did not tell you".

Changes

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