Knowledgebase

Get Contact List Details

Retrieve a contact list details.

Method: GET
Endpoint: /api/getList

Parameters

Parameter Type Required

Description 

list_id int Yes

Required to retrieve the specific list from the system, $id is the value here which refers to the ID of that list you want to retrieve. 


Response Parameters

Parameter Type Response
status string Success or Error
response string Result of the operation
 

Example Request (CURL)

<?php
$api_token = 'xxxxxxxxxxxxxxxxxxxxxxxxxxx';
$id = 2;
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL,"http://sampledomain.com/api/getList/$id");
curl_setopt($ch, CURLOPT_HTTPHEADER,
    array('Content-Type: application/json', 'Authorization: Bearer ' . $api_token));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$output = curl_exec ($ch);
print_r($output);
curl_close ($ch);
?>


Success Response

{
    "status": "success",
    "result": [
        {
            "id": 99,
            "name": "user list by user apioi",
            "group_id": 89,
            "owner_name": "Adnan",
            "owner_email": "[email protected]",
            "reply_email": "[email protected]",
            "bounce_email_id": 2,
            "is_deleted": 0,
            "validate": 0,
            "user_id": 4,
            "total_subscribers": 0,
            "export_status": 0,
            "download_status": 0,
            "import_status": 0,
            "zapier_connected": null,
            "created_at": "2020-10-22 07:41:30",
            "updated_at": "2020-10-22 08:47:28",
            "import_cancel": 0
        }
    ]
}
A Valid API call will return success response along with the available data system has about the specific list, like List Name, List Owner, List Owner Email, Reply to Email and such.


Error Response

{"status":"error","response":"Error message goes here"}
Status value of the response will be "Error" alongwith reason of the error occurred.
GET
/api/getList/{id}
Try it out