Search deals
Search and filter deals in your CRM.
POST/v2/api/crm/deals/search
This endpoint is paginated. Use page and size in the request body to control results. See 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 |
Authorization
Authorizationstring · headerrequired
Api-Key ak_live_…
Body
filtersobject | null
Named filters. Combined with AND.
1 fields
stagestring
Filter by deal stage/status (exact match)
searchstring | null
Free-text search across deal name and company
sortenum<string>
Sort order (default: DATE_DESC)
DATE_DESCDATE_ASCNAME_ASCNAME_DESCCREATED_DESCCREATED_ASC
pageinteger
Page number (1-indexed)
sizeinteger
Results per page
Responses
200Search results
dataobject[]
9 fields
idstring
Unique deal identifier
statusstring | null
Current deal status
amountnumber | null
Deal monetary value
currencystring | null
Three-letter ISO 4217 currency code
closed_atstring<date-time> | null
When the deal was closed (ISO 8601)
companyobject | null
Embedded company reference
2 fields
created_atstring<date-time>
When the deal was created
updated_atstring<date-time>
When the deal was last updated
401
422
429