Contact ManagementLists

Get a list's details

Authentication

api-keystring

The API key should be passed in the request headers as api-key for authentication.

Path parameters

listIdlongRequired
Id of the list

Query parameters

startDatestringOptional

Mandatory if endDate 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

endDatestringOptional

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
createdAtstring

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

folderIdlong
ID of the folder
idlong
ID of the list
namestring
Name of the list
totalBlacklistedlong
Number of blacklisted contacts in the list
totalSubscriberslong
Number of contacts in the list
uniqueSubscriberslong
Number of unique contacts in the list
campaignStatslist of objects or null
dynamicListboolean or null

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

Errors