API Reference

Return all your created email campaigns

get
https://api.brevo.com/v3/emailCampaigns
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

📘

The response payload for this endpoint has changed

You now need to specify which type of statistics you would like to retrieve. For more information visit this page.

Query Params
string
enum

Filter on the type of the campaigns

Allowed:
string
enum

Filter on the status of the campaign

Allowed:
string
enum

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.

Allowed:
string

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' )

string

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' )

int64
0 to 100
Defaults to 50

Number of documents per page

int64
Defaults to 0

Index of the first document in the page

string
enum
Defaults to desc

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

Allowed:
boolean
enum

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

Allowed:
Responses

Updated 12 months ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 12 months ago