Scope: accounting:cashflow.read https://api.alladdin.com/api/v2/business-plan/scenarios

Returns the Business Plan scenarios configured for the authenticated account. A Business Plan can hold several scenarios, each with its own goals; use the returned id as scenario_id when calling the goals endpoint.
Use when the user asks which business plan scenarios exist, or before requesting goals for a scenario other than the main one.
Returns an empty list, not an error, when the account has no Business Plan configured yet.

Request

import requests

url = "https://api.alladdin.com/api/v2/business-plan/scenarios"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Accept": "application/json",
}

response = requests.get(url, headers=headers)
print(response.json())

Responses

Response

{
  "items": [
    {
      "id": "507f1f77bcf86cd799439011",
      "name": "Base",
      "color": "color_1",
      "is_main": true
    }
  ],
  "cursor": null,
  "has_more": false
}

Success responses

200 List of business plan scenarios application/json object items[] object[] id string

Scenario identifier

name string

Scenario name

color string

Color assigned to the scenario in the UI

Enum: color_1 color_2 color_3 color_4 color_5 color_6 color_7 is_main boolean

Whether this is the account's main scenario — the default used when a request does not specify scenario_id

cursor string | null

Always null — scenarios are not paginated

has_more boolean

Always false — scenarios are not paginated

Error responses

401 Invalid or missing API key application/json 403 Insufficient permissions application/json 429 Rate limit exceeded application/json

← PreviousList business plan goals vs actuals →