GET /crm/deals
Retrieve a paginated list of deals with optional filtering, sorting, and search capabilities. Results can be filtered by attributes such as deal name or owner, linked companies, linked contacts, or modification/creation timestamps. Default sort order is descending by creation date.
Servers
- https://api.brevo.com/v3
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
createdSince |
String | No |
Filter (urlencoded) the deals 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. |
limit |
Integer | No |
Number of documents per page Default value: 50 |
filters[linkedContactsIds] |
String | No |
Filter by linked contacts ids |
modifiedSince |
String | No |
Filter (urlencoded) the deals 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. |
sortBy |
String | No |
The field used to sort field names. |
sort |
String | No |
Sort the results in the ascending/descending order. Default order is descending by creation if Valid values:
|
filters[attributes.deal_name] |
String | No |
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] |
String | No |
Filter by linked companies ids |
offset |
Integer | No |
Index of the first document of the page |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.