v1

latestOpenAPI 3.1.12026-07-268973189.3 KB
Deals

List deals

Returns a paginated list of deals. Supports search and filtering.

get/deals

Query parameters

cursorstring

Cursor for pagination. Pass the previous response nextCursor value to fetch the next page.

limitnumber

Number of items to return (max 100)

searchstring

Search by deal title

pipelineIdstring

Filter by pipeline public ID

stageIdstring

Filter by stage public ID

status'ACTIVE' | 'WON' | 'LOST'

Filter by deal status (ACTIVE, WON, LOST)

Response

OK

nextCursorstring nullable

Cursor to fetch the next page. Null if there are no more results.

hasMoreboolean required

Whether additional results are available