Sign in

v1

latestOpenAPI 3.0.3MIT2026-07-1410794124.7 KB
Lists

Load List

Returns detailed information about specified list. Required Access Level: ViewContacts

get/lists/{name}

Path parameters

namestring string required

string

Example:My List 1

Name of your list.

Response

OK

ListNamestring string

Name of your list.

PublicListIDstring guid nullable

ID code of list. Please note that this is different from the listid field.

DateAddedstring date-time

Date of creation in YYYY-MM-DDThh:ii:ss format

AllowUnsubscribeboolean

True: Allow unsubscribing from this list. Otherwise, false

Example response

{
  "ListName": "My List 1",
  "PublicListID": "E33EBA7A-C20D-4D3D-8F2F-5EEF42F58E6F",
  "DateAdded": "2001-01-01T12:00:00"
}