Skip to content

List Account Plans

GET
/desk/accounts/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.

Authorizations

Parameters

Query Parameters

status
Any of:
string
Allowed values: draft active paused archived

Only plans in this status.

source
Any of:
string
Allowed values: all deals campaign

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

campaign_id
Any of:
string

REQUIRED when source=campaign.

mine

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

boolean

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

limit
integer
default: 100 >= 1 <= 200
offset
integer

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

An open envelope for a LIST result, so a bare list keeps its shape.

object
items
Array
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