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

# List deals

> Deals with pipeline totals.

Scope: `crm:read`.



## OpenAPI

````yaml /openapi.json get /deals
openapi: 3.1.0
info:
  title: Messaly API
  version: 1.0.0
  description: >-
    SMS, WhatsApp, email, contacts and CRM for your business. Amounts are in
    KES. Authenticate with an API key (Settings → API keys). A key can be
    limited to scopes and to IP addresses; a key with no scopes can call every
    endpoint here.
servers:
  - url: https://app.telaven.com/api/v1
    description: Production
security:
  - bearerAuth: []
  - apiKeyHeader: []
tags:
  - name: Account
    description: Wallet balance and SMS pricing.
  - name: SMS
    description: Send SMS and read messages and analytics.
  - name: SMS campaigns
    description: Create, schedule and send SMS campaigns to lists and tags.
  - name: Contacts
    description: Contacts and contact lists.
  - name: WhatsApp
    description: Send approved WhatsApp templates.
  - name: Email
    description: Email campaigns and unsubscribes.
  - name: CRM
    description: Deals, companies and pipelines.
paths:
  /deals:
    get:
      tags:
        - CRM
      summary: List deals
      description: |-
        Deals with pipeline totals.

        Scope: `crm:read`.
      operationId: listDeals
      parameters:
        - name: page
          in: query
          required: false
          description: Page number, starting at 1.
          schema:
            type: integer
            example: 1
        - name: limit
          in: query
          required: false
          description: Items per page (1–100, default 20).
          schema:
            type: integer
            example: 20
        - name: pipelineId
          in: query
          required: false
          description: One pipeline.
          schema:
            type: string
            format: uuid
        - name: status
          in: query
          required: false
          description: open, won, lost.
          schema:
            type: string
        - name: search
          in: query
          required: false
          description: Match on name.
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              example:
                success: true
                data:
                  - id: f2b8…
                    name: Acme bulk SMS
                    value: '120000.00'
                    currency: KES
                    stage: proposal
                    status: open
                    probability: 60
                pagination:
                  page: 1
                  limit: 20
                  total: 1
                  totalPages: 1
                stats:
                  totalValue: 120000
                  openDeals: 1
                  wonDeals: 0
                  lostDeals: 0
        '401':
          description: No API key, or the key is wrong, disabled or expired.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: >-
            The key doesn't have the scope this endpoint needs, or it's used
            from an address its IP allowlist doesn't include.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: >-
            More than 120 requests in a minute with this key. Wait for the
            number of seconds in Retry-After.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: >-
            Something went wrong on our side. Retry with backoff. A POST sent
            with an Idempotency-Key replays this same error for that key,
            because the request may have partly run: check the result before
            trying again with a new key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: string
        code:
          type: string
          description: Machine-readable code where one exists, e.g. INSUFFICIENT_BALANCE.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Authorization: Bearer tlv_…'
    apiKeyHeader:
      type: apiKey
      in: header
      name: X-API-Key

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.