Subscribers
Get subscriber by email
Retrieves a subscriber by their email address, including notes, list memberships, sequence enrollments, email stats, and recent activity.
get/subscribers/{email}
Path parameters
emailstring required
URL-encoded email address
Query parameters
includeMachineEngagementboolean
Include detected scanner, preview, and tracked asset open/click events in subscriber email stats and recent activity.
Response
Successful response
Example response
{
"success": true,
"subscriber": {
"id": "sub_abc123",
"email": "user@example.com",
"externalId": "user_123",
"firstName": "John",
"lastName": "Doe",
"phone": "+15551234567",
"smsStatus": "subscribed",
"status": "active",
"emailProvider": "gmail",
"tags": [
"premium",
"newsletter"
],
"customAttributes": {
"plan": "pro",
"signupSource": "website"
},
"lists": [
{
"id": "list_vip",
"name": "VIP Customers"
}
],
"sequenceEnrollments": [
{
"tokenId": "token_123",
"sequenceId": "seq_welcome",
"sequenceName": "Welcome Flow",
"sequenceStatus": "active",
"enrollmentStatus": "active",
"currentNodeId": "node_abc",
"currentNodeType": "action_email",
"currentNodeLabel": "Send welcome email"
}
],
"notes": [
{
"id": "note_123",
"companyId": "comp_abc123",
"subscriberId": "sub_abc123",
"authorId": "user_123",
"body": "Asked about enterprise pricing",
"author": {
"id": "user_123",
"name": "Ana",
"email": "ana@example.com"
}
}
],
"activity": [
{
"eventType": "custom",
"eventName": "saas.purchase"
}
]
}
}