> ## Documentation Index
> Fetch the complete documentation index at: https://developers.thinkout.io/llms.txt
> Use this file to discover all available pages before exploring further.

# List scenarios

> Every scenario in the workspace, oldest first, the order of the tabs on the scenarios screen.



## OpenAPI

````yaml /openapi/v1.yaml get /scenarios
openapi: 3.1.0
info:
  title: ThinkOut API
  version: '1.0'
  description: >
    Read access to the data of a ThinkOut workspace.


    Every endpoint in version 1 is a `GET`. Lists share one envelope and page
    with a cursor

    wherever they can grow. Every response carries `X-RateLimit-Limit`,
    `X-RateLimit-Remaining`

    and `X-RateLimit-Reset`.


    Version 1 changes additively: new endpoints, optional parameters, response
    fields and enum

    values can appear at any time. Tolerate unknown fields and never treat an
    enum as closed.
  contact:
    name: ThinkOut developer support
    url: https://developers.thinkout.io/guides/support
servers:
  - url: https://api.thinkout.io/v1
security:
  - apiKey: []
tags:
  - name: Banks
    description: The workspace's bank connections and the state of each one.
  - name: Accounts
    description: Manual, bank-synced and delegated accounts with computed balances.
  - name: Transactions
    description: Booked and pending movements on the workspace's accounts.
  - name: Categories
    description: The workspace category tree, split by direction and business activity.
  - name: Counterparties
    description: Customers and suppliers that transactions and forecasts are attributed to.
  - name: Labels
    description: Free-form tags grouped by label type.
  - name: Forecasts
    description: Planned inflows and outflows and the transactions that realised them.
  - name: Budgets
    description: >-
      Monthly budgets per category beside what has moved and what is still
      expected, as the budgets screen shows them.
  - name: Scenarios
    description: >-
      The what-ifs built on the scenarios screen and the figures the screen
      shows for them.
  - name: Reports
    description: >-
      Totals rather than rows. Summaries over transactions, forecasts and cash
      flow, and balances per account.
paths:
  /scenarios:
    get:
      tags:
        - Scenarios
      summary: List scenarios
      description: >-
        Every scenario in the workspace, oldest first, the order of the tabs on
        the scenarios screen.
      operationId: listScenarios
      responses:
        '200':
          description: The workspace's scenarios.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/List'
                  - type: object
                    properties:
                      data:
                        type: array
                        items:
                          $ref: '#/components/schemas/Scenario'
                      has_more:
                        type: boolean
                        description: Always `false`. This list is not paged.
                      next_cursor:
                        type: 'null'
                        description: Always `null`. This list is not paged.
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  schemas:
    List:
      type: object
      required:
        - object
        - data
        - has_more
        - next_cursor
      properties:
        object:
          type: string
          const: list
        data:
          type: array
          items: {}
        has_more:
          type: boolean
          description: Whether another page exists.
        next_cursor:
          type:
            - string
            - 'null'
          description: Pass as `cursor` to fetch the next page. `null` on the last page.
    Scenario:
      type: object
      required:
        - object
        - id
        - name
        - type
        - from
        - to
        - initial_balance
        - currency
        - created_at
        - updated_at
      properties:
        object:
          type: string
          const: scenario
        id:
          type: string
          format: uuid
        name:
          type: string
          example: Pessimistic
        type:
          $ref: '#/components/schemas/ScenarioType'
        from:
          type: string
          format: date
          description: First day of the scenario's first month.
        to:
          type: string
          format: date
          description: Last day of the scenario's last month.
        initial_balance:
          oneOf:
            - $ref: '#/components/schemas/Money'
            - type: 'null'
          description: >-
            The balance a snapshot or blank scenario starts from. `null` for a
            dynamic scenario, which starts from the cash flow's balance.
        currency:
          $ref: '#/components/schemas/Currency'
          description: The workspace currency. Every scenario amount is in it.
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
          description: Equal to `created_at` until the scenario is first changed.
      example:
        object: scenario
        id: 2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f
        name: Pessimistic
        type: dynamic
        from: '2026-11-01'
        to: '2027-10-31'
        initial_balance: null
        currency: RON
        created_at: '2026-10-02T08:15:00Z'
        updated_at: '2026-11-10T14:40:00Z'
    ScenarioType:
      type: string
      description: >-
        `dynamic` is the cash flow, actual and still expected, with the
        scenario's edits on top, and moves with the data. `snapshot` is a copy
        of the cash flow taken when the scenario was created, then edited.
        `blank` holds only the amounts typed into it, starting from its initial
        balance.
      enum:
        - dynamic
        - snapshot
        - blank
    Money:
      type: string
      description: >-
        Decimal amount as a string with two decimals. Negative means an outflow
        on transactions, forecasts and report figures.
      pattern: ^-?[0-9]+\.[0-9]{2}$
      example: '-1250.00'
    Currency:
      type: string
      description: ISO 4217 alphabetic currency code.
      pattern: ^[A-Z]{3}$
      example: RON
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - type
            - code
            - message
            - param
            - request_id
          properties:
            type:
              type: string
              enum:
                - invalid_request
                - authentication
                - not_found
                - rate_limit
                - server
            code:
              type: string
              description: >
                Stable machine-readable reason. Branch on this, not on
                `message`. One of

                `invalid_parameter`, `invalid_cursor`, `limit_out_of_range`,
                `invalid_expand`,

                `as_of_in_future`, `unauthorized`, `forbidden`,
                `resource_not_found`,

                `too_many_groups`, `period_too_long`, `rate_limited`,
                `internal_error`.
            message:
              type: string
              description: Human-readable explanation. Wording may change.
            param:
              type:
                - string
                - 'null'
              description: The query parameter at fault, when there is one.
            request_id:
              type: string
              description: Quote this when contacting support.
  responses:
    Unauthorized:
      description: The API key is missing, malformed, unknown or revoked.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              type: authentication
              code: unauthorized
              message: Missing, malformed, unknown or revoked API key
              param: null
              request_id: 0HNF8K3QJL2VM:00000001
    Forbidden:
      description: >-
        The key is valid but the company's ThinkOut plan does not include the
        API.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              type: authentication
              code: forbidden
              message: >-
                The API is not included in this company's ThinkOut plan. Contact
                support@thinkout.io to enable it.
              param: null
              request_id: 0HNF8K3QJL2VM:00000001
    RateLimited:
      description: >-
        More than 120 requests in the current minute for this key. Wait for the
        seconds in `Retry-After`.
      headers:
        Retry-After:
          schema:
            type: integer
          description: Seconds until the minute window resets.
        X-RateLimit-Limit:
          schema:
            type: integer
          description: Requests allowed per minute.
        X-RateLimit-Remaining:
          schema:
            type: integer
          description: Requests left in the current minute.
        X-RateLimit-Reset:
          schema:
            type: integer
          description: Seconds until the minute window resets.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              type: rate_limit
              code: rate_limited
              message: Too many requests
              param: null
              request_id: 0HNF8K3QJL2VM:00000001
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: >-
        A workspace API key created in ThinkOut settings. One key reads one
        workspace.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.