Fetch scheduled emails by batchId or messageId

get

https://api.brevo.com/v3/smtp/emailStatus/{identifier}

Fetch scheduled batch of emails by batchId or single scheduled email by messageId (Can retrieve data upto 30 days old)

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

identifier

string

required

The batchId of scheduled emails batch (Should be a valid UUIDv4) or the messageId of scheduled email.

Query Params

startDate

date

Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older tha current date.

endDate

date

Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month.

sort

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. Not valid when identifier is messageId.

Allowed:

status

string

enum

Filter the records by status of the scheduled email batch or message. Not valid when identifier is messageId.

Allowed:

limit

int64

0 to 500

Defaults to 100

Number of documents returned per page. Not valid when identifier is messageId.

offset

int64

Defaults to 0

Index of the first document on the page. Not valid when identifier is messageId.

Responses

200Scheduled email batches

400bad request

404bad request