Get scenario

GET /api/v1/cfo-projection/scenarios/{scenario_id}

Get a projection scenario by ID.

Operation ID: get_scenario_api_v1_cfo_projection_scenarios__scenario_id__get · View as markdown · OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Parameters

Path

scenario_id string required

Responses

200 Successful Response

Schema: ScenarioResponse

id string required
business_id string required
name string required
is_active boolean required
base_month string · date required
projection_months integer required
revenue_drivers object
cost_classifications object
variable_drivers object
fixed_drivers object
monthly_overrides object
tax_rate number required
interest_income_monthly integer required
interest_expense_monthly integer required
created_at string · date-time required
updated_at string · date-time required

401 Unauthorized - Authentication required

403 Forbidden - Insufficient permissions

404 Not Found - Resource does not exist

422 Validation Error

Schema: HTTPValidationError

detail array · ValidationError ValidationError

5 fields

loc array · string | integer required
msg string required
type string required
input object
ctx object

Code samples

GET /api/v1/cfo-projection/scenarios/{scenario_id}

bash

curl -X GET 'https://api.ondayzero.com/api/v1/cfo-projection/scenarios/{scenario_id}' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID'

javascript

const response = await fetch('https://api.ondayzero.com/api/v1/cfo-projection/scenarios/{scenario_id}', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer dz_your_token',
    'x-business-id': 'YOUR_BUSINESS_ID',
  },
});
const data = await response.json();

python

import httpx

headers = {
    "Authorization": "Bearer dz_your_token",
    "x-business-id": "YOUR_BUSINESS_ID",
}

response = httpx.get("https://api.ondayzero.com/api/v1/cfo-projection/scenarios/{scenario_id}", headers=headers)
data = response.json()