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

# List alternatives

> List alternatives with optional filtering and pagination



## OpenAPI

````yaml get /api/v2/alternative/list
openapi: 3.0.0
info:
  version: 1.0.0
  title: Octave API
  description: API for Octave workspace management and AI-powered content generation
servers:
  - url: https://app.octavehq.com
security:
  - ApiKeyAuth: []
paths:
  /api/v2/alternative/list:
    get:
      tags:
        - Alternative
      summary: List alternatives
      description: List alternatives with optional filtering and pagination
      operationId: listAlternatives
      parameters:
        - schema:
            type: array
            items:
              type: string
            description: Filter by alternative OIds
          required: false
          name: oIds
          in: query
        - schema:
            type: string
            nullable: true
            description: >-
              Filter by offering OId. Accepts Product, Service, and Solution
              OIds.
          required: false
          name: offeringOId
          in: query
        - schema:
            type: string
            nullable: true
            description: >-
              @deprecated Use `offeringOId` instead. Filter by offering OId
              (Product, Service, or Solution). Kept for backward compatibility.
            deprecated: true
          required: false
          name: productOId
          in: query
        - schema:
            type: string
            nullable: true
            description: Text search query
          required: false
          name: textSearchQuery
          in: query
        - schema:
            type: number
            nullable: true
            default: 10
            description: Limit
          required: false
          name: limit
          in: query
        - schema:
            type: number
            nullable: true
            default: 0
            description: Offset
          required: false
          name: offset
          in: query
      responses:
        '200':
          description: Alternative list data
          content:
            application/json:
              schema:
                type: object
                properties:
                  _metadata:
                    $ref: '#/components/schemas/Metadata'
                  hasNext:
                    type: boolean
                    description: Whether there are more results
                    example: false
                  total:
                    type: number
                    description: Total number of results
                    example: 0
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Alternative'
                required:
                  - _metadata
                  - hasNext
                  - total
                  - data
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                properties:
                  _metadata:
                    $ref: '#/components/schemas/Metadata'
                  message:
                    type: string
                required:
                  - _metadata
                  - message
      deprecated: false
components:
  schemas:
    Metadata:
      type: object
      properties:
        usage:
          type: number
          default: 0
          description: API usage
          example: 0
        requestId:
          type: string
          description: Request ID
          example: requestId
        message:
          type: string
          description: Message
          example: message
        timestamp:
          type: string
          description: Timestamp
          example: '2021-01-01T00:00:00.000Z'
      required:
        - requestId
        - timestamp
    Alternative:
      type: object
      properties:
        oId:
          type: string
          description: Alternative OId
        createdAt:
          type: string
          nullable: true
          description: Creation date
        updatedAt:
          type: string
          nullable: true
          description: Updated date
        deletedAt:
          type: string
          nullable: true
          description: Deleted date
        archivedAt:
          type: string
          nullable: true
          description: Archived date
        name:
          type: string
          description: Alternative name
        internalName:
          type: string
          description: Alternative internal name
        description:
          type: string
          description: Alternative description
        active:
          type: boolean
          default: true
        data:
          $ref: '#/components/schemas/AlternativeData'
        user:
          type: object
          nullable: true
          properties:
            oId:
              type: string
              nullable: true
            firstName:
              type: string
              nullable: true
              description: The first name of the user who created the alternative
              example: John
            lastName:
              type: string
              nullable: true
              description: The last name of the user who created the alternative
              example: Doe
          description: User data
        workspace:
          type: object
          nullable: true
          properties:
            oId:
              type: string
              nullable: true
          description: Workspace data
      required:
        - oId
        - createdAt
        - name
        - internalName
        - description
    AlternativeData:
      type: object
      nullable: true
      properties:
        whereItWorks:
          type: array
          items:
            type: string
        whereItBreaks:
          type: array
          items:
            type: string
        whoChampionsThisApproach:
          type: array
          items:
            type: string
        whyOurApproachIsSuperior:
          type: array
          items:
            type: string
        perceivedBenefits:
          type: array
          items:
            type: string
        hiddenCostsAndPitfalls:
          type: array
          items:
            type: string
        customFields:
          $ref: '#/components/schemas/CustomDataFields'
      required:
        - whereItWorks
        - whereItBreaks
        - whoChampionsThisApproach
        - whyOurApproachIsSuperior
        - perceivedBenefits
        - hiddenCostsAndPitfalls
    CustomDataFields:
      type: array
      items:
        $ref: '#/components/schemas/CustomDataFieldItem'
    CustomDataFieldItem:
      type: object
      properties:
        title:
          type: string
        value:
          type: array
          items:
            type: string
      required:
        - title
        - value
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: api_key

````