Contacts

Get lists in a folder

get/contacts/folders/{folderId}/lists

Request

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

Path parameters

folderIdinteger required

Id of the folder

Query parameters

limitinteger

Number of documents per page

offsetinteger

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

Folder's Lists details

countinteger

Number of lists in the folder

Example response

{
  "lists": [
    {
      "id": 23,
      "name": "Magento Customers - EN",
      "totalBlacklisted": 13,
      "totalSubscribers": 1776,
      "uniqueSubscribers": 1789
    }
  ],
  "count": 6
}

Changes

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