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

# List deals



## OpenAPI

````yaml /openapi.yaml get /deals
openapi: 3.0.3
info:
  title: Leonar API
  description: >
    REST API for accessing and managing workspace data in Leonar CRM.


    ## Authentication


    All API requests require a Bearer token in the Authorization header:


    ```

    Authorization: Bearer leo_xxxxx

    ```


    API keys can be created and managed in Settings > API.


    ## Rate limiting


    - **2000 requests per hour by default**, configurable per workspace and
    shared by all API keys owned by the same user

    - Rate limit headers are included in all responses


    ## Pagination


    List endpoints support pagination via `limit` and `offset` query parameters.
  version: 1.0.0
  contact:
    name: Leonar Support
    url: https://leonar.ai
    email: support@leonar.ai
servers:
  - url: https://app.leonar.app/api/v1
    description: Production
security:
  - BearerAuth: []
tags:
  - name: Contacts
    description: Manage contacts in your workspace
  - name: Companies
    description: Manage companies and their relationships
  - name: Deals
    description: Track and manage sales deals
  - name: Deal Pipelines
    description: View deal pipeline configurations
  - name: Projects
    description: Organize recruiting projects
  - name: Pipeline Entries
    description: Manage candidates in project pipelines
  - name: Tasks
    description: Track to-dos and follow-ups
  - name: Tags
    description: Organize resources with tags
  - name: Notes
    description: Manage notes on contacts, companies, deals, and projects
  - name: Sequences
    description: Automate outreach campaigns
  - name: Conversations
    description: View conversations across channels
  - name: Messages
    description: Send messages via email, LinkedIn, or WhatsApp
  - name: Enrichment
    description: Find emails and phone numbers for contacts
  - name: Sourcing
    description: Search and import candidates
  - name: Connected Accounts
    description: View linked LinkedIn accounts
paths:
  /deals:
    get:
      tags:
        - Deals
      summary: List deals
      operationId: list-deals
      parameters:
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/offset'
        - $ref: '#/components/parameters/updatedAfter'
        - $ref: '#/components/parameters/updatedBefore'
        - name: status
          in: query
          schema:
            type: string
            enum:
              - open
              - won
              - lost
              - unqualified
              - all
            default: all
        - name: pipeline_id
          in: query
          schema:
            type: string
            format: uuid
        - name: stage_id
          in: query
          schema:
            type: string
            format: uuid
        - name: company_id
          in: query
          schema:
            type: string
            format: uuid
        - name: owner_id
          in: query
          schema:
            type: string
            format: uuid
        - name: search
          in: query
          schema:
            type: string
          description: Search by title
        - name: sort
          in: query
          schema:
            type: string
            default: '-created_at'
          description: >-
            Options: `created_at`, `updated_at`, `title`, `amount`,
            `expected_close_date`
      responses:
        '200':
          description: List of deals
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Deal'
                  meta:
                    $ref: '#/components/schemas/PaginationMeta'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  parameters:
    limit:
      name: limit
      in: query
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 50
      description: Items per page
    offset:
      name: offset
      in: query
      schema:
        type: integer
        minimum: 0
        default: 0
      description: Items to skip
    updatedAfter:
      name: updated_after
      in: query
      schema:
        type: string
        format: date-time
      description: >-
        Return resources changed after this RFC 3339 timestamp. Contacts may
        redeliver rows exactly at the boundary; consumers must upsert
        idempotently.
    updatedBefore:
      name: updated_before
      in: query
      schema:
        type: string
        format: date-time
      description: >-
        Return resources with `updated_at` less than or equal to this RFC 3339
        timestamp.
  schemas:
    Deal:
      type: object
      properties:
        id:
          type: string
          format: uuid
        title:
          type: string
        status:
          type: string
          enum:
            - open
            - won
            - lost
            - unqualified
        amount:
          type: number
          nullable: true
        signed_amount:
          type: number
          nullable: true
        currency:
          type: string
          default: EUR
        expected_amount:
          type: number
          nullable: true
        expected_close_date:
          type: string
          format: date
          nullable: true
        probability:
          type: number
          nullable: true
        pipeline_id:
          type: string
          format: uuid
        stage_id:
          type: string
          format: uuid
        company_id:
          type: string
          format: uuid
        owner_id:
          type: string
          format: uuid
          nullable: true
        primary_source_id:
          type: string
          format: uuid
          nullable: true
          description: Primary deal source definition ID.
        closed_at:
          type: string
          format: date-time
          nullable: true
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        archived_at:
          type: string
          format: date-time
          nullable: true
      example:
        id: c3d4e5f6-7890-12ab-cdef-345678901bcd
        title: Recruitment - 3 Senior Engineers
        status: open
        amount: 45000
        signed_amount: null
        currency: EUR
        expected_amount: 45000
        expected_close_date: '2025-03-15'
        probability: 60
        pipeline_id: d4e5f6a7-8901-23bc-defa-456789012cde
        stage_id: e5f6a7b8-9012-34cd-efab-567890123def
        company_id: b2c3d4e5-6789-01ab-cdef-234567890abc
        owner_id: f6a7b8c9-0123-45de-fabc-678901234ef0
        primary_source_id: a7b8c9d0-1234-56ef-abcd-789012345ef1
        closed_at: null
        created_at: '2025-02-01T10:00:00Z'
        updated_at: '2025-02-10T15:30:00Z'
        archived_at: null
    PaginationMeta:
      type: object
      properties:
        total:
          type: integer
          description: Total number of results matching the query
        limit:
          type: integer
          description: Maximum items per page
        offset:
          type: integer
          description: Number of items skipped
        has_more:
          type: boolean
          description: Whether more pages are available
      example:
        total: 142
        limit: 50
        offset: 0
        has_more: true
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - invalid_api_key
                - insufficient_scope
                - rate_limit_exceeded
                - validation_error
                - not_found
                - internal_error
                - billing_required
                - plan_upgrade_required
              description: >
                Error codes:

                - `invalid_api_key` — API key is missing, malformed, or revoked

                - `insufficient_scope` — API key lacks the required scope for
                this endpoint

                - `rate_limit_exceeded` — Too many requests (2000/hour)

                - `validation_error` — Request body or parameters failed
                validation

                - `not_found` — The requested resource does not exist

                - `internal_error` — Unexpected server error

                - `billing_required` — Workspace has no active subscription

                - `plan_upgrade_required` — Current plan does not include this
                feature
            message:
              type: string
              description: Human-readable error description
  responses:
    Unauthorized:
      description: Invalid or missing API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: invalid_api_key
              message: Invalid API key
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: API key starting with `leo_`

````