Get One List

Fetch detailed information about a specific subscriber list by providing its unique list UID. Includes general, default, and notification configuration data.

📄 Get One List

Retrieve details of a specific list using its unique ID.

🔹 HTTP Request

GET API-URL/lists/LIST-UNIQUE-ID

🔸 URL Segments

Segment	Required	Description
LIST-UNIQUE-ID	Yes	Unique identifier of the list to fetch.

🔐 Authorization Header

Include your customer API key:

X-API-KEY: your-api-key-here

💻 PHP Example

// get a single list
$response = $endpoint->getList('LIST-UNIQUE-ID');

// DISPLAY RESPONSE
echo '<hr /><pre>';
print_r($response->body);
echo '</pre>';

📦 Sample JSON Response

{
  "status": "success",
  "data": {
    "record": {
      "general": {
        "list_uid": "lm451q7h7j3e2",
        "name": "API Test List",
        "display_name": "Testing list",
        "description": "This is a test list, created from the API."
      },
      "defaults": {
        "from_email": "[email protected]",
        "from_name": "Emily Carter",
        "reply_to": "[email protected]",
        "subject": "Welcome to Our Newsletter!"
      },
      "notifications": {
        "subscribe": "no",
        "unsubscribe": "no",
        "subscribe_to": "",
        "unsubscribe_to": ""
      },
      "company": {
        "name": "Support",
        "address_1": "Test",
        "address_2": "",
        "zone_name": "Constanta",
        "city": "Constanta",
        "zip_code": "1234x",
        "phone": "",
        "address_format": "[COMPANY_NAME]\n[COMPANY_ADDRESS_1] [COMPANY_ADDRESS_2]\n[COMPANY_CITY] [COMPANY_ZONE] [COMPANY_ZIP]\n[COMPANY_COUNTRY]\n[COMPANY_WEBSITE]",
        "country": {
          "country_id": "1",
          "name": "Afghanistan",
          "code": "AF"
        }
      }
    }
  }
}