contacts

Get a list's details

Retrieve the details of a specific contact list by its ID, including its name, folder ID, creation date, subscriber counts, and campaign statistics. You can optionally filter campaign statistics by providing startDate and endDate parameters (both must be used together in YYYY-MM-DD format).

get/contacts/lists/{listId}

Request

  • Base URL: https://api.brevo.com/v3
  • URL: https://api.brevo.com/v3/contacts/lists/{listId}
  • Auth: API key in header api-key

Path parameters

listIdinteger required

Id of the list

Query parameters

startDatestring

Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to aggregate the sent email campaigns for a specific list id. Prefer to pass your timezone in date-time format for accurate result

endDatestring

Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to aggregate the sent email campaigns for a specific list id. Prefer to pass your timezone in date-time format for accurate result

Response

List informations

idinteger required

ID of the list

namestring required

Name of the list

totalBlacklistedinteger required

Number of blacklisted contacts in the list

totalSubscribersinteger required

Number of contacts in the list

uniqueSubscribersinteger required

Number of unique contacts in the list

createdAtstring required

Creation UTC date-time of the list (YYYY-MM-DDTHH:mm:ss.SSSZ)

dynamicListboolean

Status telling if the list is dynamic or not (true=dynamic, false=not dynamic)

folderIdinteger required

ID of the folder

Changes

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