Skip to main content
POST
Search deals

Authorizations

Authorization
string
header
required

A workspace API token. Create one in Settings → API. Send it as Authorization: Bearer sk_live_....

Body

application/json

Body for POST /v1/deals/search, and arguments for the MCP search_records tool.

cursor
string | null
expand
string | null
fields
string | null
filter
FilterGroup · object

A set of conditions combined with and / or. Groups may nest.

limit
integer
default:50
Required range: 1 <= x <= 200
q
string | null

Free text across the deal title, contact name and organization name.

sort
string | null

Same syntax as the sort query parameter.

Response

Successful Response

A page of deals.

A named subclass purely so the generated SDK type is DealList rather than the Page_Deal_ FastAPI derives from the generic.

data
Deal · object[]
required
meta
PageMeta · object
required