smsCampaigns

Returns the information for all your created SMS campaigns

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.

get/smsCampaigns

Request

  • Base URL: https://api.brevo.com/v3
  • URL: https://api.brevo.com/v3/smsCampaigns
  • Auth: API key in header api-key

Query parameters

status'suspended' | 'archive' | 'sent' | 'queued' | 'draft' | 'inProcess'

Status of campaign.

startDatestring

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 status is not passed or is set to sent. startDate must not be in the future.

endDatestring

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 status is not passed or is set to sent. endDate must not be in the future.

limitinteger

Number of documents per page

offsetinteger

Beginning point in the list to retrieve from.

sort'asc' | 'desc'

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

Response

SMS campaigns information

countinteger

Number of SMS campaigns retrieved

Changes

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