Skip to content

Get Account Context

GET
/desk/accounts/{account_id}/context

Why this account is here: summary, timeline, deal state, committee.

Read-only; never writes. This is the evidence a plan is built from, so it is the right read before proposing one.

Authorizations

Parameters

Path Parameters

account_id
required

The account’s mashup company id (cb_account_plans.account_id).

integer
>= 1

The account’s mashup company id (cb_account_plans.account_id).

Query Parameters

activity_limit
integer
default: 50 >= 1 <= 200

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

An open envelope for a plan, a context read or a committee result.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string