Desk

List Account Plans

The Account Board: the latest plan version per account.

mine=true is resolved against the caller's own identity. For a MACHINE key that is nobody, so it returns nothing - which is correct rather than broken, and is why the default is false.

get/desk/accounts/plans

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/desk/accounts/plans
  • Auth: HTTP bearer

Query parameters

status'draft' | 'active' | 'paused' | 'archived' nullable

Only plans in this status.

source'all' | 'deals' | 'campaign' nullable

Which board: deals (accounts with an open deal), campaign (requires campaign_id), or all. Omitted means all.

campaign_idstring nullable

REQUIRED when source=campaign.

mineboolean

Only accounts this caller owns. Ownership is resolved BEFORE paging, so this changes the total rather than filtering a page.

limitinteger
offsetinteger

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Response

Successful Response

Changes

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