Skip to main content
GET
Get the business review plan

Authorizations

Authorization
string
header
required

Use your API key as a Bearer token. API keys can be generated in Settings → Integrations → API Access.

Query Parameters

year
integer

Defaults to the current year

Required range: 2000 <= x <= 2100
companyId
string<uuid>

Limit the plan to one company

includeSuggestions
boolean | null

Also return balanced target suggestions

rebalanceAll
boolean

With includeSuggestions, re-plan clients that already have a target

Response

Year plan

data
object
required