Transactional emails

Fetch scheduled emails by batchId

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

get/smtp/emailStatus/{batchId}

Request

  • Base URL: https://api.brevo.com/v3
  • URL: https://api.brevo.com/v3/smtp/emailStatus/{batchId}
  • Auth: one of:
    • API key in header api-key
    • API key in header partner-key

Path parameters

batchIdstring required

The batchId of scheduled emails batch (Should be a valid UUIDv4)

Query parameters

startDatestring 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.

endDatestring 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'asc' | 'desc'

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

status'processed' | 'inProgress' | 'queued'

Filter the records by status of the scheduled email batch or message.

limitinteger

Number of documents returned per page

offsetinteger

Index of the first document on the page

Response

Scheduled email batches

countinteger

Total number of batches

Changes

No recorded changes to this operation across all 2 revisions of this API.