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

# List sales opportunities

> Requires `crm:sales:read`. 



## OpenAPI

````yaml /openapi.json get /crm/sales/opportunities
openapi: 3.0.3
info:
  title: Visito M2M API
  version: 1.0.0
  description: >-
    Tenant-scoped server-to-server API for channels, conversations, commerce,
    custom AI tools, and WhatsApp templates. Send operations are asynchronous
    and return queued acknowledgements. Expansion adds conversation controls,
    knowledge, sales opportunities, delivery status, reporting, and signed
    webhooks.
servers:
  - url: https://platform-api.visitoai.com/m2m/v1
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Channels
  - name: Conversations
  - name: Commerce
  - name: Custom tools
  - name: WhatsApp templates
  - name: Properties
  - name: Knowledge
  - name: Sales CRM
  - name: Delivery
  - name: Reporting
  - name: Webhooks
paths:
  /crm/sales/opportunities:
    get:
      tags:
        - Sales CRM
      summary: List sales opportunities
      description: 'Requires `crm:sales:read`. '
      operationId: m2mGetCrmSalesOpportunities
      parameters:
        - name: limit
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 50
          description: ''
        - name: cursor
          in: query
          schema:
            type: string
          description: Opaque nextCursor from the preceding page.
        - name: stageId
          in: query
          schema:
            type: string
          description: ''
        - name: status
          in: query
          schema:
            type: string
          description: ''
        - name: group
          in: query
          schema:
            type: string
          description: ''
        - name: includeTotal
          in: query
          schema:
            type: boolean
          description: ''
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SalesOpportunities'
        default:
          $ref: '#/components/responses/Error'
components:
  schemas:
    SalesOpportunities:
      type: object
      properties:
        opportunities:
          type: array
          items:
            $ref: '#/components/schemas/SalesOpportunity'
        hasMore:
          type: boolean
        nextCursor:
          type: string
          nullable: true
        pipelineVersion:
          type: integer
        total:
          type: integer
    SalesOpportunity:
      type: object
      properties:
        opportunityId:
          type: string
        leadId:
          type: string
        conversationId:
          type: string
        displayName:
          type: string
        channel:
          type: string
        version:
          type: integer
        revision:
          type: integer
        stageId:
          type: string
        stageLocked:
          type: boolean
        status:
          type: string
          enum:
            - open
            - won
            - lost
        summary:
          type: string
        values:
          type: object
          additionalProperties:
            type: object
        createdAt:
          type: string
        updatedAt:
          type: string
        closedAt:
          type: string
      required:
        - opportunityId
        - revision
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              example: M2M_AUTH_INSUFFICIENT_SCOPE
            message:
              type: string
            details:
              type: object
              additionalProperties: true
      example:
        error:
          code: M2M_AUTH_INSUFFICIENT_SCOPE
          message: M2M credential does not have required scope.
          details:
            requiredScopes:
              - conversations:write
            missingScopes:
              - conversations:write
  responses:
    Error:
      description: Structured error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Visito M2M API key
      description: Server-side tenant-scoped credential created from Build > API Keys.

````