GET /smsCampaigns
Retrieve a paginated list of all your SMS campaigns with their statistics and recipient information. Results can be filtered by status and date range, with a default limit of 500 and maximum of 1000 per page. The sort order defaults to descending by creation date; date filters are only available when status is not passed or is set to sent.
Servers
- https://api.brevo.com/v3
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
endDate |
String | No |
Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent SMS campaigns. Prefer to pass your timezone in date-time format for accurate result. Only available if |
limit |
Integer | No |
Number of documents per page Default value: 500 |
sort |
String | No |
Sort the results in the ascending/descending order of record creation. Default order is descending if Valid values:
Default value: "desc" |
status |
String | No |
Status of campaign. Valid values:
|
startDate |
String | No |
Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent SMS campaigns. Prefer to pass your timezone in date-time format for accurate result. Only available if |
offset |
Integer | No |
Beginning point in the list to retrieve from. 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.