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

# Search deals

> Search and filter deals in your CRM.

<Note>
  **Required scope:** `CRM_READ`
</Note>

This endpoint is paginated. Use `page` and `size` in the request body to control results. See [Pagination](/en/v2/api-reference/guides/pagination).

## Request body

| Field     | Type    | Description                                                                                 |
| --------- | ------- | ------------------------------------------------------------------------------------------- |
| `filters` | object  | Named filters (see below)                                                                   |
| `search`  | string  | Full-text keyword search across deal name and company                                       |
| `sort`    | string  | Sort order: `DATE_DESC`, `DATE_ASC`, `NAME_ASC`, `NAME_DESC`, `CREATED_DESC`, `CREATED_ASC` |
| `page`    | integer | Page number (1-indexed)                                                                     |
| `size`    | integer | Results per page (max 100)                                                                  |

## Filters

| Field   | Match type | Description       |
| ------- | ---------- | ----------------- |
| `stage` | exact      | Deal stage/status |


## OpenAPI

````yaml POST /v2/api/crm/deals/search
openapi: 3.0.3
info:
  title: Allo API
  description: >-
    Allo API provides programmatic access to your Allo account, allowing you to
    manage webhooks, retrieve calls and contacts, and send SMS messages.


    All requests to `/v1/api/**` endpoints automatically go through quota
    checking and scope validation.
  version: 1.0.0
  contact:
    name: Allo Support
servers:
  - url: https://api.withallo.com
    description: Production server
security: []
tags:
  - name: Summary Templates
    description: >-
      Manage call summary templates that control how AI-generated call summaries
      are structured for your team.
  - name: Webhooks
    description: >-
      Manage webhook endpoints to receive real-time notifications about events
      in your Allo account. Each endpoint subscribes to one or more event topics
      and is verified with a signing secret.
  - name: Calls
    description: >-
      Retrieve and search call records with filtering and pagination. Filter
      calls by your Allo phone number.
  - name: Contacts
    description: >-
      Search and retrieve contact information with sorting and pagination.
      Includes engagement level tracking.
  - name: SMS
    description: Send SMS messages to phone numbers using your Allo numbers.
  - name: Phone Numbers
    description: Retrieve information about your Allo phone numbers.
  - name: Analytics
    description: Pre-computed call metrics, team performance, and outbound dial funnel
  - name: CRM
    description: Manage people, companies, and deals in your CRM.
paths:
  /v2/api/crm/deals/search:
    post:
      tags:
        - CRM
      summary: Search deals
      description: Search and filter deals in your CRM.
      operationId: searchDeals
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchDealsRequest'
            example:
              search: Enterprise
              page: 1
              size: 20
      responses:
        '200':
          description: Search results
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      data:
                        type: array
                        items:
                          $ref: '#/components/schemas/CrmDeal'
                  - $ref: '#/components/schemas/PaginatedResponse'
        '401':
          $ref: '#/components/responses/ApiUnauthorized'
        '422':
          $ref: '#/components/responses/ApiValidationError'
        '429':
          $ref: '#/components/responses/ApiRateLimited'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    SearchDealsRequest:
      type: object
      description: Request body for searching deals
      properties:
        filters:
          type: object
          nullable: true
          description: Named filters. Combined with AND.
          properties:
            stage:
              type: string
              description: Filter by deal stage/status (exact match)
        search:
          type: string
          nullable: true
          description: Free-text search across deal name and company
        sort:
          type: string
          nullable: true
          enum:
            - DATE_DESC
            - DATE_ASC
            - NAME_ASC
            - NAME_DESC
            - CREATED_DESC
            - CREATED_ASC
          description: 'Sort order (default: DATE_DESC)'
        page:
          type: integer
          default: 1
          description: Page number (1-indexed)
        size:
          type: integer
          default: 20
          maximum: 100
          description: Results per page
    CrmDeal:
      type: object
      description: A deal in the CRM
      properties:
        id:
          type: string
          description: Unique deal identifier
          example: dea-def456
        name:
          type: string
          description: Deal name
          example: Enterprise Plan
        status:
          type: string
          nullable: true
          description: Current deal status
          example: negotiation
        amount:
          type: number
          nullable: true
          description: Deal monetary value
          example: 50000
        currency:
          type: string
          nullable: true
          description: Three-letter ISO 4217 currency code
          example: USD
          minLength: 3
          maxLength: 3
        closed_at:
          type: string
          format: date-time
          nullable: true
          description: When the deal was closed (ISO 8601)
          example: null
        company:
          $ref: '#/components/schemas/CrmCompanyRef'
        created_at:
          type: string
          format: date-time
          description: When the deal was created
          example: '2026-04-15T14:00:00'
        updated_at:
          type: string
          format: date-time
          description: When the deal was last updated
          example: '2026-04-28T10:30:00'
    PaginatedResponse:
      type: object
      properties:
        pagination:
          $ref: '#/components/schemas/Pagination'
    CrmCompanyRef:
      type: object
      nullable: true
      description: Embedded company reference
      properties:
        id:
          type: string
          description: Company ID
          example: com-xyz789
        name:
          type: string
          description: Company name
          example: Acme Corp
    Pagination:
      type: object
      properties:
        page:
          type: integer
        size:
          type: integer
        total_count:
          type: integer
        total_pages:
          type: integer
        has_more:
          type: boolean
    ApiError:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
            code:
              type: string
            message:
              type: string
            retryable:
              type: boolean
            request_id:
              type: string
            retry_after_seconds:
              type: integer
              nullable: true
  responses:
    ApiUnauthorized:
      description: Invalid or missing API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    ApiValidationError:
      description: Invalid request parameters
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    ApiRateLimited:
      description: Rate limit exceeded
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization

````