Companies

Get Company Next Best Step

What to do next with this company, and why. SPENDS CREDITS.

A GET that costs money: the recommendation is generated by a model on a cache miss, and the cache key includes the company's engagement state, so activity on the account invalidates it. Tiered billable for that reason rather than as an ordinary read.

get/companies/{company_id}/next-best-step

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/companies/{company_id}/next-best-step
  • Auth: HTTP bearer

Path parameters

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