GET / Contact List Detailed

GET / Contact List Detailed

GET /v2/list/{listId}?full

Header

HTTP/1.1
Authorization: Bearer $api_id.$api_secret
Host: api.$app_domain
Accept: application/json

Response

{
    "data": {
        "id": "6671",
        "name": "Contact List One",
        "ma_type": "1",
        "date_format": "Y-m-d",
        "time_format": "", (e.g. “h:iA”),
        "counter": "21",
        "time": "1646344838",
        "report_url": "list.php?lid=6671"
    },
    “segments”:  [{
        "id": "501",
        "name": "My Segment 1",
        "manual": "1",
        "time": "1652572800",
        "count": "32"
    }],
    "fields": [{
        "id": "33742",
        "name": "Address",
        "type": "text",
        "tag": "address"
    }, {
        "id": "33743",
        "name": "City",
        "type": "text",
        "tag": "city"
    }, {
        "id": "33740",
        "name": "Company Size",
        "type": "text",
        "tag": "company_size"
    }]

}

Response data type

• id, integer, unique id for the list object
• name, string, name assigned to the list object
• ma_type, integer, defining the type of list 0 [subscriber] , 1 [crm], 2 [contact list]
• date_format, string, defining the date format assigned to the list object
• time_format, string, defining the time format assigned to the list object
• counter, integer, total raw count of contact records contained in the list object
• time, unix timestamp, last modified value for list object
• report_url, string, defining the url path to the list manager for the list object

Error code

HTTP/1.1 404 Not Found
{
    "id": "0",
    "message": "Error description"
}