Sales CRMDeals

Get all deals

Authentication

api-keystring

The API key should be passed in the request headers as api-key for authentication.

Query parameters

filters[attributes.deal_name]stringOptional

Filter by attributes. If you have a filter for the owner on your end, please send it as filters[attributes.deal_owner] and utilize the account email for the filtering.

filters[linkedCompaniesIds]stringOptional
Filter by linked companies ids
filters[linkedContactsIds]stringOptional
Filter by linked companies ids
modifiedSincestringOptional

Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.

createdSincestringOptional

Filter (urlencoded) the contacts created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.

offsetlongOptional
Index of the first document of the page
limitlongOptional
Number of documents per page
sortenumOptional

Sort the results in the ascending/descending order. Default order is descending by creation if sort is not passed

Allowed values:

Response

Returns deals list with filters
itemslist of objects or null
List of deals

Errors