GET /smtp/emailStatus/{identifier}

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

Servers

https://api.brevo.com/v3

Path parameters

Name	Type	Required	Description
`identifier`	String	Yes	The `batchId` of scheduled emails batch (Should be a valid UUIDv4) or the `messageId` of scheduled email.

Query parameters

Name	Type	Required	Description
`endDate`	String	No	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.
`limit`	Integer	No	Number of documents returned per page. Not valid when identifier is `messageId`. Default value: 100
`sort`	String	No	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`. Valid values: `"desc"` `"asc"` Default value: "desc"
`status`	String	No	Filter the records by `status` of the scheduled email batch or message. Not valid when identifier is `messageId`. Valid values: `"inProgress"` `"queued"` `"processed"`
`startDate`	String	No	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.
`offset`	Integer	No	Index of the first document on the page. Not valid when identifier is `messageId`. 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.