companies

Bounded company context for an agent

One bounded view of a company: the record, its contacts, open opportunities, open tasks, and recent interactions. Each collection is capped and the response says whether the cap was reached.

get/v1/companies/{id}/context

Request

  • Base URL: https://api.indraft.io
  • URL: https://api.indraft.io/v1/companies/{id}/context
  • Auth: HTTP bearer

Path parameters

idstring required

The company id, as returned by the call that created or matched it.

Query parameters

interactionsinteger

How many recent interactions to include in the brief. Bounded, and the answer says when the bound bit rather than implying it returned everything.

openTasksinteger

How many open tasks to include in the brief, bounded the same way.

openOpportunitiesinteger

How many open deals to include in the brief, bounded the same way.

relatedContactsinteger

How many of the account's contacts to include in the brief, bounded the same way.

Response

Success

standingobject required

Per field: which kind of claim is standing on it, who asserted it, and when. This is the provenance the product is sold on, keyed by column name so it lines up with changes, held[] and the unconfirmed queue. confirmed means a person checked it and outranks everything an agent can assert; inferred is the weakest and is what an agent's own conclusion should carry. A write whose claim ranks below what is here is held rather than applied.

truncatedobject required

Which collections hit their cap, keyed by name. True means there is more that is not here, so do not conclude from this response that a company has three contacts.

requestIdstring required

Changes

No recorded changes to this operation across all 1 revision of this API.