Search Subscriber by Email

Search and retrieve subscriber information from a specific list using the subscriber's email address. This is helpful for quickly locating a contact without knowing their UID.

📧 Search Subscriber by Email

Look up a subscriber by their email address within a specified list.


🔹 HTTP Request

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

🔸 URL Segments

Segment
Required
Description

LIST-UNIQUE-ID

Yes

Unique identifier of the subscriber list.


🔎 Query Parameters

Parameter
Required
Description

email

Yes

Email address of the subscriber.


🔐 Authorization Header

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

💻 PHP Example

// SEARCH BY EMAIL
$response = $endpoint->emailSearch('LIST-UNIQUE-ID', '[email protected]');

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

📦 Sample JSON Response

{
  "status": "success",
  "data": {
    "subscriber_uid": "st890efghijk2",
    "status": "confirmed",
    "date_added": "2024-11-15 08:27:14"     
  }
}

Last updated