Contacts

Returns a folder's details

get/contacts/folders/{folderId}

Request

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

Path parameters

folderIdinteger required

id of the folder

Response

Folder details

idinteger required

ID of the folder

namestring required

Name of the folder

totalBlacklistedinteger required

Number of blacklisted contacts in the folder

totalSubscribersinteger required

Number of contacts in the folder

uniqueSubscribersinteger required

Number of unique contacts in the folder

Example response

{
  "id": 2,
  "name": "Magento Customers",
  "totalBlacklisted": 32,
  "totalSubscribers": 19777,
  "uniqueSubscribers": 16222
}

Changes

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