List Scenarios

GET 
/api/v2/pro-forma/scenarios

The authenticated user's saved what-if scenarios, newest first. Scenarios are strictly per-user — other users' scenarios are never returned.

Required scope: products:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

product_id null on a scenario = hypothetical product (manual profile stored in inputs.manual_profile).

Requires Bearer token (products scope).

Request

Responses

200

OK

Response Headers

Content-Type

401

Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.

403

Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.

429

Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.