> ## 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 segments

> List segments with optional filtering and pagination



## OpenAPI

````yaml get /api/v2/segment/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/segment/list:
    get:
      tags:
        - Segment
      summary: List segments
      description: List segments with optional filtering and pagination
      operationId: listSegments
      parameters:
        - schema:
            type: array
            items:
              type: string
            description: Filter by segment OIds
          required: false
          description: Filter by segment OIds
          name: oIds
          in: query
        - schema:
            type: string
            nullable: true
            description: >-
              Filter by offering OId. Accepts Product, Service, and Solution
              OIds.
          required: false
          description: Filter by offering OId. Accepts Product, Service, and Solution OIds.
          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
          description: >-
            @deprecated Use `offeringOId` instead. Filter by offering OId
            (Product, Service, or Solution). Kept for backward compatibility.
          name: productOId
          in: query
        - schema:
            type: string
            nullable: true
            description: Text search query
          required: false
          description: Text search query
          name: textSearchQuery
          in: query
        - schema:
            type: number
            nullable: true
            default: 10
            description: Limit
          required: false
          description: Limit
          name: limit
          in: query
        - schema:
            type: number
            nullable: true
            default: 0
            description: Offset
          required: false
          description: Offset
          name: offset
          in: query
      responses:
        '200':
          description: Segment list data
          content:
            application/json:
              schema:
                type: object
                properties:
                  _metadata:
                    $ref: '#/components/schemas/Metadata'
                  hasNext:
                    type: boolean
                    example: false
                    description: Whether there are more results
                  total:
                    type: number
                    example: 0
                    description: Total number of results
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Segment'
                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
          example: 0
          description: API usage
        requestId:
          type: string
          example: requestId
          description: Request ID
        message:
          type: string
          example: message
          description: Message
        timestamp:
          type: string
          example: '2021-01-01T00:00:00.000Z'
          description: Timestamp
      required:
        - requestId
        - timestamp
    Segment:
      type: object
      properties:
        oId:
          type: string
          description: Segment OId
        createdAt:
          type: string
          nullable: true
          format: date-time
          description: Creation date
        updatedAt:
          type: string
          nullable: true
          format: date-time
          description: Updated date
        deletedAt:
          type: string
          nullable: true
          format: date-time
        archivedAt:
          type: string
          nullable: true
          format: date-time
        name:
          type: string
          description: Segment name
        internalName:
          type: string
          description: Segment internal name
        description:
          type: string
          description: Segment description
        active:
          type: boolean
          default: true
        data:
          $ref: '#/components/schemas/SegmentData'
        qualifyingQuestions:
          type: array
          nullable: true
          items:
            type: object
            properties:
              question:
                type: string
                description: The question to ask to qualify the entity
              rationale:
                type: string
                description: The rationale for the question as to why it helps qualify
              fitType:
                type: string
                enum:
                  - GOOD
                  - BAD
                description: The fit type of the question
                example: GOOD
              weight:
                type: string
                enum:
                  - LOW
                  - MEDIUM
                  - HIGH
                  - INSTANT_QUALIFIER
                  - INSTANT_DISQUALIFIER
                description: The weight of the question
                example: MEDIUM
              archivedAt:
                type: string
                nullable: true
                format: date-time
                description: The date and time the question was archived
            required:
              - question
              - rationale
              - fitType
              - weight
          description: Qualifying questions
        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 segment
              example: John
            lastName:
              type: string
              nullable: true
              description: The last name of the user who created the segment
              example: Doe
          description: User data
        workspace:
          type: object
          nullable: true
          properties:
            oId:
              type: string
              nullable: true
          description: Workspace data
        unrecognized:
          type: boolean
        rejected:
          type: boolean
        intelOverride:
          type: object
          nullable: true
          properties:
            enabled:
              type: boolean
            cadence:
              type: string
              enum:
                - weekly
                - biweekly
                - monthly
            guidance:
              type: string
              nullable: true
        tags:
          type: array
          items:
            type: object
            properties:
              tagGroupOId:
                type: string
              tagGroupName:
                type: string
              tagOId:
                type: string
              tagName:
                type: string
            required:
              - tagGroupOId
              - tagGroupName
              - tagOId
              - tagName
      required:
        - oId
        - createdAt
        - name
        - internalName
        - description
        - unrecognized
        - rejected
    SegmentData:
      type: object
      nullable: true
      properties:
        strategicFit:
          type: array
          items:
            type: string
          default: []
        firmographics:
          type: object
          properties:
            industry:
              type: array
              items:
                type: string
              default: []
            businessModel:
              type: array
              items:
                type: string
              default: []
            geography:
              type: array
              items:
                type: string
              default: []
            revenue:
              type: array
              items:
                type: string
              default: []
            employees:
              type: array
              items:
                type: string
              default: []
          default:
            industry: []
            businessModel: []
            geography: []
            revenue: []
            employees: []
          additionalProperties:
            nullable: true
        operatingCharacteristics:
          type: array
          items:
            type: string
          default: []
        strategicPriorities:
          type: array
          items:
            type: string
          default: []
        marketPressures:
          type: array
          items:
            type: string
          default: []
        buyingDynamics:
          type: array
          items:
            type: string
          default: []
        customFields:
          $ref: '#/components/schemas/CustomDataFields'
        additionalProperties:
          type: object
          additionalProperties:
            anyOf:
              - type: string
              - type: array
                items:
                  type: string
              - type: number
              - type: boolean
    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

````