Search Deal

Search Deal

GET

Search deal records using one or more supported filters.

Request

GET

GET /v1/deal/search

Headers

• Authorization: Bearer your_access_token

Query Parameters

Parameter	Type	Description
deal_slug	string	Direct lookup by deal slug. Takes priority over other filters when provided.
name	string	Deal name.
deal_type	integer	Deal type. Allowed values: 1 = New Business, 2 = Existing Business.
deal_stage_id	integer	Deal stage ID.
organization_slug	string	Organization slug connected to the deal.
organization_name	string	Organization name connected to the deal.
owner_id	integer	Owner user ID.
owner_name	string	Owner full name.
owner_email	string	Owner email address.
close_date_from	date	Return deals with close date on or after this date. Format: YYYY-MM-DD.
close_date_to	date	Return deals with close date on or before this date.
created_from	ISO 8601 timestamp	Return deals created at or after this timestamp.
created_to	ISO 8601 timestamp	Return deals created at or before this timestamp.
updated_from	ISO 8601 timestamp	Return deals updated at or after this timestamp.
updated_to	ISO 8601 timestamp	Return deals updated at or before this timestamp.
exact_search	boolean string	Use true for exact text matching. Default: partial matching.
sort_by	string	Allowed values: created_at, updated_at. Default: updated_at.
sort_order	string	Allowed values: asc, desc. Default: desc.
maximize	string	Comma-separated response expansions. Use all to expand all supported deal fields.
page	integer	Page number. Default: 1.
limit	integer	Records per page. Default: 25. Requests above 50 are capped at 50.

Search Behavior

• Include at least one search filter to receive results.
• deal_slug performs a direct lookup and takes priority over all other filters.
• Text filters use partial matching by default. Pass exact_search=true for exact text matching.
• Date range filters are inclusive. For each date range, the *_to value must be greater than or equal to the matching *_from value.
• close_date_from and close_date_to use the YYYY-MM-DD date format.
• Results are sorted by updated_at in descending order unless sorting parameters are provided.

Supported maximize values

owner, created_by, updated_by, organization, job, candidate, stage, contact, all

Request Examples

Search by deal name

GET /v1/deal/search?name=Renewal

Exact deal name search

GET /v1/deal/search?name=Acme%20Renewal&exact_search=true

Search by close date

GET /v1/deal/search?close_date_from=2026-07-01&close_date_to=2026-07-31

Search by organization and owner

GET /v1/deal/search?organization_name=Acme&owner_email=owner@example.com&maximize=organization,owner

Direct slug lookup

GET /v1/deal/search?deal_slug=deal_68ba678fcd2a83f4640c

Response

200

{
  "total": 1,
  "per_page": 25,
  "current_page": 1,
  "last_page": 1,
  "next_page_url": null,
  "prev_page_url": null,
  "from": 1,
  "to": 1,
  "data": [
    {
      "id": 28,
      "slug": "deal_68ba678fcd2a83f4640c",
      "name": "Acme Renewal",
      "deal_type": 1,
      "close_date": "2026-07-31",
      "deal_amount": 50000,
      "stage": {
        "id": 1
      },
      "organization": {
        "id": 12
      },
      "created_at": "2026-06-21T02:49:00.000Z",
      "updated_at": "2026-07-08T17:47:00.000Z"
    }
  ]
}

400

[
  {
    "field_name": "close_date_to",
    "error_message": "close_date_to must be greater than or equal to close_date_from"
  }
]