Search by Custom Fields in a List

Search for a subscriber within a specific list using one or more custom field values. This is useful for advanced filtering beyond just email.

🧩 Search by Custom Fields in a List

Search subscribers using any available custom field (like EMAIL, FNAME, etc.) in a specific list.

---

🔹 HTTP Request

GET API-URL/lists/LIST-UNIQUE-ID/subscribers/search-by-custom-fields

---

🔸 URL Segments

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

---

🔎 Query Parameters

Parameter	Required / Default	Description
array	Yes	Array of custom fields { 'FIELD' => 'VAL' }
page	1	Page number to retrieve.
per_page	10	Items per page to retrieve.

---

🔐 Authorization Header

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

---

💻 PHP Example

// SEARCH BY CUSTOM FIELDS IN A LIST
$response = $endpoint->searchByCustomFields('LIST-UNIQUE-ID', [
    'EMAIL' => '[e-mail]'
]);

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

---

📦 Sample JSON Response

{
  "status": "success",
  "data": {
    "subscriber_uid": "uv445mnqsla78",
    "EMAIL": "[e-mail]",
    "FNAME": "",
    "LNAME": "",
    "status": "unsubscribed",
    "source": "import",
    "ip_address": "",
    "date_added": "2025-03-28 14:10:45"
  }
}