GET /emailCampaigns
Return all your created email campaignsServers
- https://api.brevo.com/v3
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
endDate |
String | No |
Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' ) |
limit |
Integer | No |
Number of documents per page Default value: 50 |
statistics |
String | No |
Filter on type of the statistics required. Example globalStats value will only fetch globalStats info of the campaign in returned response.This option only returns data for events occurred in the last 6 months.For older campaigns, it’s advisable to use the Get Campaign Report endpoint. Valid values:
|
sort |
String | No |
Sort the results in the ascending/descending order of record creation. Default order is descending if Valid values:
Default value: "desc" |
type |
String | No |
Filter on the type of the campaigns Valid values:
|
status |
String | No |
Filter on the status of the campaign Valid values:
|
startDate |
String | No |
Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' ) |
excludeHtmlContent |
Boolean | No |
Use this flag to exclude htmlContent from the response body. If set to true, htmlContent field will be returned as empty string in the response body Valid values:
|
offset |
Integer | No |
Index of the first document in the page 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.