v2

latestOpenAPI 3.0.02026-07-31355176194.7 KB
v1Deals

List all deals

get/v1/deals

Query parameters

limitnumber

A limit on the number of objects to be returned. Limit can range between 1 and 100.

cursorstring

A cursor for use in pagination. The cursor is the id of the last object returned in the previous request.

pipeline_idstring

Filter deals by pipeline id.

status'open' | 'won' | 'lost'

Filter deals by status (open, won, lost).

contact_idstring

Filter deals by the id of the contact associated with the deal.

created_at_fromstring

Only return deals that were created after this date.

created_at_tostring

Only return deals that were created before this date.

won_lost_date_fromstring

Only return deals that were won or lost after this date.

won_lost_date_tostring

Only return deals that were won or lost before this date.

Response

nextCursorobject nullable required

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