Get Company Dashboard
GET /companies/{company_id}/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.
Authorizations
Parameters
Path Parameters
Company id.
Company id.
Header Parameters
Responses
200
Successful Response
object
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”.
object
object
Whether there are more pages
Items per page
Current page number (1-indexed)
Total number of items
422
Validation Error