GET /events
Retrieve a list of events filtered by various criteria.
Servers
- https://api.brevo.com/v3
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
object_type[] |
Array | No |
Filter by object type (repeatable) |
endDate |
String | No |
Mandatory if startDate is used. End of date range (YYYY-MM-DD or RFC3339). Must be ≥ startDate. |
limit |
Integer | No |
Max events to return. Default 100, min 1, max 10000. Default value: 100 |
contact_id[] |
Array | No |
Filter by contact ID (repeatable) |
startDate |
String | No |
Mandatory if endDate is used. Start of date range (YYYY-MM-DD or RFC3339). Defaults to 6 months ago when omitted alongside endDate. Must be ≤ endDate. |
event_name[] |
Array | No |
Filter by event name (repeatable) |
offset |
Integer | No |
Events to skip for pagination. Default 0, min 0. Default value: 0 |
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.