Contacts

Get all folders

get/contacts/folders

Request

  • Base URL: https://api.brevo.com/v3
  • URL: https://api.brevo.com/v3/contacts/folders
  • Auth: one of:
    • API key in header api-key
    • API key in header partner-key

Query parameters

limitinteger required

Number of documents per page

offsetinteger required

Index of the first document of the page

sort'asc' | 'desc'

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

Response

Folders informations

countinteger

Number of folders available in your account

Example response

{
  "folders": [
    {
      "id": 2,
      "name": "Magento Customers",
      "totalBlacklisted": 32,
      "totalSubscribers": 19777,
      "uniqueSubscribers": 16222
    }
  ],
  "count": 10
}

Changes

No recorded changes to this operation across all 2 revisions of this API.