transactionalEmails

Fetch scheduled emails by batchId or messageId

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

get/smtp/emailStatus/{identifier}

Request

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

Path parameters

identifierstring required

The batchId of scheduled emails batch (must be a valid UUIDv4) or the messageId of scheduled email (enclosed in angle brackets with @ sign, e.g. <...@domain>). When using messageId, the limit, offset, sort, and status query parameters are ignored.

Query parameters

startDatestring date

Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Cannot be more than 30 days older than the 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. Not valid when identifier is messageId.

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

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

limitinteger

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

offsetinteger

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

Response

Scheduled email batches

unknown required
OR
unknown required

Changes

No recorded changes to this operation across all 1 revision of this API.