v1

latestSwagger 2.02026-08-065854114.9 KB
deals

List and search for deals.

get/deals

Query parameters

pageinteger

Page of results to fetch.

per_pageinteger

Number of results to return per page.

titlestring

Title prefix.

dealStatus1 | 2 | 3

Deal status ID.

dealStageinteger

Deal stage ID.

dealStageOrderinteger

Deal stage sequence number.

userOwnerinteger

Owner user ID.

authorinteger

Author user ID.

organizationinteger

Organization ID.

personinteger

Person ID.

lossReasoninteger

Loss reason ID.

productsinteger[]

Array of product IDS.

startAtGtstring date-time

Use to search for deals that started after this date.

startAtLtstring date-time

Use to search for deals that started before this date.

endAtGtstring date-time

Use to search for deals that were finished after this date.

endAtLtstring date-time

Use to search for deals that were finished before this date.

createdAtGtstring date-time

Use to search for deals that were created after this date.

createdAtLtstring date-time

Use to search for deals that were created before this date.

updatedAtGtstring date-time

Use to search for deals that were updated after this date.

updatedAtLtstring date-time

Use to search for deals that were updated before this date.

withCustomFieldsboolean

Return custom fields of deals. Use this param to include them in the response. Example: /deals?withCustomFields=true

Response

OK