GET /couponCollections

Retrieve a paginated list of all coupon collections in your Brevo account. Results can be sorted by creation date, remaining coupons count, or expiration date, in ascending or descending order. Pagination defaults to 50 collections per page (maximum 100).

Servers

Query parameters

Name Type Required Description
limit Integer No

Number of documents returned per page

Default value: 50

sortBy String No

The field used to sort coupon collections

Valid values:

  • "expirationDate"
  • "createdAt"
  • "remainingCoupons"

Default value: "createdAt"

sort String No

Sort the results by creation time in ascending/descending order

Valid values:

  • "desc"
  • "asc"

Default value: "desc"

offset Integer No

Index of the first document on the page

Default value: 0

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. 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.
  3. Click Test request to test run your request to the API and see the API's response.