---
title: "Get scenarios"
method: GET
path: "/api/v2/scenarios"
tags: ["Scenarios"]
---

# Get scenarios

`GET /api/v2/scenarios`

## Request

- Base URL: `https://developer.productive.io` (the document declares no server; this is the origin it was published from)
- URL: `https://developer.productive.io/api/v2/scenarios`
- Auth: none declared

List scenarios with optional filters. Returns paginated scenario records the caller has access to.

## Query parameters

- `filter` union: Filter schema for `scenario` list endpoints — pass a single condition or a logical group.
  - object: A logical filter group — combine multiple conditions with the `$op` operator.
    - `$op` 'or' | 'and', required: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match.
  - FilterScenario: Filter parameters for narrowing scenario list results.
    - `deal_id` union: Filter by deal or budget.
      - object: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `eq` DealId (unresolved $ref)
        - `not_eq` DealId (unresolved $ref)
        - `contains` DealId (unresolved $ref)
        - `not_contain` DealId (unresolved $ref)
      - DealId (unresolved $ref)
    - `id` union: Filter by ID.
      - object: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `eq` Id (unresolved $ref)
        - `not_eq` Id (unresolved $ref)
        - `contains` Id (unresolved $ref)
        - `not_contain` Id (unresolved $ref)
      - Id (unresolved $ref)
    - `project_id` union: Filter by project.
      - object: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `eq` ProjectId (unresolved $ref)
        - `not_eq` ProjectId (unresolved $ref)
      - ProjectId (unresolved $ref)
- `sort` string[]

## Response `200`

Collection scenario

- object: Paginated list of scenario records in JSON:API format.
  - `data` object[]: Array of scenario resource objects.
    - `attributes` object: Scenario attributes.
      - `budget_total` BudgetTotal (unresolved $ref)
      - `budget_total_default` BudgetTotalDefault (unresolved $ref)
      - `budget_total_normalized` BudgetTotalNormalized (unresolved $ref)
      - `budget_used` BudgetUsed (unresolved $ref)
      - `budget_used_default` BudgetUsedDefault (unresolved $ref)
      - `budget_used_normalized` BudgetUsedNormalized (unresolved $ref)
      - `cost` Cost (unresolved $ref)
      - `cost_default` CostDefault (unresolved $ref)
      - `cost_normalized` CostNormalized (unresolved $ref)
      - `created_at` CreatedAt (unresolved $ref)
      - `currency` Currency (unresolved $ref)
      - `currency_default` CurrencyDefault (unresolved $ref)
      - `currency_normalized` CurrencyNormalized (unresolved $ref)
      - `deleted_at` DeletedAt (unresolved $ref)
      - `end_date` EndDate (unresolved $ref)
      - `last_applied_at` LastAppliedAt (unresolved $ref)
      - `metadata` Metadata (unresolved $ref)
      - `name` Name (unresolved $ref)
      - `profit` Profit (unresolved $ref)
      - `profit_default` ProfitDefault (unresolved $ref)
      - `profit_margin` ProfitMargin (unresolved $ref)
      - `profit_normalized` ProfitNormalized (unresolved $ref)
      - `revenue` Revenue (unresolved $ref)
      - `revenue_default` RevenueDefault (unresolved $ref)
      - `revenue_normalized` RevenueNormalized (unresolved $ref)
      - `start_date` StartDate (unresolved $ref)
    - `relationships` object: Scenario relationships.
      - `creator` union: A JSON:API single relationship — links to one related resource or `null`.
        - SingleLinkageNullable
          - `data` Resource, required: A JSON:API resource identifier object containing the resource type and ID.
            - `id` string, required: The unique identifier of the resource.
            - `type` string, required: The resource type name (e.g. `tasks`, `people`, `deals`).
        - NotIncluded: Placeholder for a relationship that was not sideloaded in this response.
          - `meta` object, required: Metadata indicating the sideload status of this relationship.
            - `included` false, required: Whether the related resource was included in the sideloaded data. Always `false` for this variant.
      - `deal` union: A JSON:API single relationship — links to one related resource or `null`.
        - SingleLinkageNullable
          - `data` Resource, required: A JSON:API resource identifier object containing the resource type and ID.
            - `id` string, required: The unique identifier of the resource.
            - `type` string, required: The resource type name (e.g. `tasks`, `people`, `deals`).
        - NotIncluded: Placeholder for a relationship that was not sideloaded in this response.
          - `meta` object, required: Metadata indicating the sideload status of this relationship.
            - `included` false, required: Whether the related resource was included in the sideloaded data. Always `false` for this variant.
      - `organization` union: A JSON:API single relationship — links to one related resource or `null`.
        - SingleLinkageNullable
          - `data` Resource, required: A JSON:API resource identifier object containing the resource type and ID.
            - `id` string, required: The unique identifier of the resource.
            - `type` string, required: The resource type name (e.g. `tasks`, `people`, `deals`).
        - NotIncluded: Placeholder for a relationship that was not sideloaded in this response.
          - `meta` object, required: Metadata indicating the sideload status of this relationship.
            - `included` false, required: Whether the related resource was included in the sideloaded data. Always `false` for this variant.
  - `included` unknown[]: Sideloaded related resources.
    - unknown
  - `meta` Meta: Pagination and response metadata returned with every collection endpoint.
    - `current_page` integer: The current page number in this paginated response (1-based).
    - `max_page_size` integer: Maximum number of records allowed per page for this endpoint.
    - `organization_features` object: Feature flags and capabilities enabled for the current organization, used for UI rendering.
    - `page_size` integer: Number of records returned per page in this response.
    - `settings` object: Organization or user settings relevant to this resource's display.
    - `total_count` integer: Total number of records matching the current query across all pages.
    - `total_pages` integer: Total number of pages available for the current query and page size.

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `408`: Request Timeout
- `423`: Locked
- `429`: Too Many Requests
- `500`: Internal Server Error

## Changes

- **2026-11-02** `fa3060fd0144`: 7 info
  - added the non-success response with the status `400`
  - added the non-success response with the status `401`
  - added the non-success response with the status `403`
  - added the non-success response with the status `408`
  - …3 more

[Operation history](https://skmtc.dev/productive/apis/api-documentation/changes/api/v2/scenarios/get.md)

---

[API](https://skmtc.dev/productive/apis/api-documentation.md) - [All operations](https://skmtc.dev/productive/apis/api-documentation/llms.txt) - [OpenAPI document](https://skmtc.dev/productive/apis/api-documentation/revisions/e7bdfdf6cba3?raw)