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

# Get crmdeals



## OpenAPI

````yaml /openapi.json get /crm/deals
openapi: 3.0.0
info:
  title: meetergo Platform API
  description: >-
    Comprehensive scheduling API for creating users, managing availability,
    handling bookings, and connecting calendar providers. Enables seamless
    integration with external platforms and applications.
  version: version
  contact: {}
  termsOfService: https://www.meetergo.com/tos/
servers: []
security: []
tags:
  - name: User V4
    description: Create and manage users in your workspace
  - name: Meeting Type V4
    description: Configure meeting templates with durations, buffers, and conferencing
  - name: availability
    description: Manage weekly schedules and availability settings
  - name: Booking V4
    description: Create new bookings
  - name: Booking Availability V4
    description: Query available time slots for booking
  - name: Appointment V4
    description: Manage existing appointments
  - name: Attendee V4
    description: Manage attendee details and notes
  - name: Calendar Connections V4
    description: Connect and sync external calendars
  - name: Signatures V4
    description: >-
      Send PDFs for e-signature and download the signed, eIDAS-grade document
      (DocuSeal-compatible)
  - name: One Time Booking Link V4
    description: Create single-use booking links
  - name: availability-exception
    description: Override availability for specific dates
  - name: Booking Link V4
    description: Configure various booking page types
  - name: Personal Page V4
    description: Manage user profile pages
  - name: Handoff V4
    description: Reassign meetings to other hosts
  - name: Calendar Auth V4
    description: OAuth callbacks for calendar providers
  - name: CRM Deals
    description: >-
      Create, update, and track deals through pipeline stages (incl. per-deal
      activity history)
  - name: CRM Pipelines
    description: Manage pipelines and their stages
  - name: Queue V4
    description: Round-robin and queue-based routing (Beta)
  - name: Queue User Group V4
    description: Manage queue user groups (Beta)
  - name: Meeting Type Template V4
    description: Reusable meeting type configurations (Beta)
  - name: Attendee Pending V4
    description: Manage pending attendee approvals (Beta)
  - name: Provisional Booking V4
    description: Manage provisional/unconfirmed bookings (Beta)
paths:
  /crm/deals:
    get:
      tags:
        - CRM Deals
      operationId: findAll
      parameters:
        - name: search
          required: false
          in: query
          schema:
            type: string
        - name: pipelineId
          required: false
          in: query
          schema:
            type: string
            format: uuid
        - name: stageId
          required: false
          in: query
          schema:
            type: string
            format: uuid
        - name: crmCompanyId
          required: false
          in: query
          schema:
            type: string
            format: uuid
        - name: contactId
          required: false
          in: query
          schema:
            type: string
            format: uuid
        - name: ownerId
          required: false
          in: query
          schema:
            type: string
        - name: isOpen
          required: false
          in: query
          schema:
            type: boolean
        - name: isWon
          required: false
          in: query
          schema:
            type: boolean
        - name: isLost
          required: false
          in: query
          schema:
            type: boolean
        - name: page
          required: false
          in: query
          schema:
            type: number
        - name: limit
          required: false
          in: query
          schema:
            type: number
        - name: sortBy
          required: false
          in: query
          schema:
            $ref: '#/components/schemas/Object'
        - name: sortOrder
          required: false
          in: query
          schema:
            $ref: '#/components/schemas/Object'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DealListDto'
      security:
        - ApiKey: []
        - JWT: []
        - ApiUserHeader: []
components:
  schemas:
    Object:
      type: object
      properties: {}
    DealListDto:
      type: object
      properties:
        deals:
          type: array
          items:
            $ref: '#/components/schemas/DealDto'
        total:
          type: number
        page:
          type: number
        limit:
          type: number
        totalPages:
          type: number
      required:
        - deals
        - total
        - page
        - limit
        - totalPages
    DealDto:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        value:
          type: number
        currency:
          type: string
        expectedCloseDate:
          format: date-time
          type: string
        notes:
          type: string
        crmCompanyId:
          type: string
        contactId:
          type: string
        pipelineId:
          type: string
        stageId:
          type: string
        ownerId:
          type: string
        companyId:
          type: string
        lostReason:
          enum:
            - price
            - competition
            - timing
            - no_budget
            - no_response
            - feature_missing
            - other
          type: string
        lostReasonNote:
          type: string
        wonAt:
          format: date-time
          type: string
        lostAt:
          format: date-time
          type: string
        enteredStageAt:
          format: date-time
          type: string
        customFields:
          type: object
        createdAt:
          format: date-time
          type: string
        updatedAt:
          format: date-time
          type: string
        crmCompany:
          type: object
          properties:
            id:
              type: string
            name:
              type: string
            domain:
              type: string
          required:
            - id
            - name
        contact:
          type: object
          properties:
            id:
              type: string
            firstName:
              type: string
            lastName:
              type: string
            email:
              type: string
          required:
            - id
            - firstName
            - lastName
        stage:
          type: object
          properties:
            id:
              type: string
            name:
              type: string
            color:
              type: string
            isWon:
              type: boolean
            isLost:
              type: boolean
            winProbability:
              type: number
            rottingDays:
              type: number
          required:
            - id
            - name
            - color
            - isWon
            - isLost
            - winProbability
        contacts:
          type: array
          items:
            $ref: '#/components/schemas/DealContactDto'
        owner:
          type: object
          properties:
            id:
              type: string
            givenName:
              type: string
            familyName:
              type: string
            email:
              type: string
          required:
            - id
            - email
        isRotting:
          type: boolean
      required:
        - id
        - name
        - pipelineId
        - stageId
        - ownerId
        - companyId
        - enteredStageAt
        - createdAt
        - updatedAt
    DealContactDto:
      type: object
      properties:
        id:
          type: string
        dealId:
          type: string
        contactId:
          type: string
        role:
          enum:
            - primary
            - decision_maker
            - influencer
            - user
            - other
          type: string
        isPrimary:
          type: boolean
        createdAt:
          format: date-time
          type: string
        contact:
          type: object
          properties:
            id:
              type: string
            firstName:
              type: string
            lastName:
              type: string
            email:
              type: string
          required:
            - id
            - firstName
            - lastName
      required:
        - id
        - dealId
        - contactId
        - role
        - isPrimary
        - createdAt
  securitySchemes:
    ApiKey:
      scheme: bearer
      bearerFormat: API Key
      type: http
      description: >-
        Bearer token: a Platform API Key (format: ak_live:<uuid>:<secret>) or a
        Personal Access Token (format: rgo-...). PATs always act as the token
        owner.
    JWT:
      scheme: bearer
      bearerFormat: JWT
      type: http
      description: JWT Bearer token for standard user authentication
    ApiUserHeader:
      type: apiKey
      in: header
      name: x-meetergo-api-user-id
      description: >-
        User ID to act on behalf of. Platform API Keys only (required with an
        API Key unless the endpoint states otherwise). Requests authenticated
        with a Personal Access Token are rejected if this header names another
        user.

````