Subscribers
Get Subscriber
Get a subscriber by email address with lists, sequence enrollments, and recent activity
GET
/
api
/
v1
/
subscribers
/
{email}
Get Subscriber
curl --request GET \
--url https://api.sequenzy.com/api/v1/subscribers/{email} \
--header 'Authorization: Bearer <token>'{
"success": true,
"subscriber": {
"id": "sub_abc123",
"email": "user@sequenzy.com",
"externalId": "user_123",
"firstName": "John",
"lastName": "Doe",
"status": "active",
"emailProvider": "gmail",
"tags": ["customer", "newsletter"],
"customAttributes": { "plan": "pro" },
"lists": [
{
"id": "list_vip",
"name": "VIP Customers",
"description": null,
"isPrivate": false,
"subscribedAt": "2024-01-10T09:00:00Z",
"unsubscribedAt": null
}
],
"sequenceEnrollments": [
{
"tokenId": "token_123",
"sequenceId": "seq_welcome",
"sequenceName": "Welcome Flow",
"sequenceStatus": "active",
"enrollmentStatus": "active",
"currentNodeId": "node_abc",
"currentNodeType": "action_email",
"currentNodeLabel": "Send welcome email",
"scheduledFor": null,
"enteredAt": "2024-01-10T09:05:00Z",
"updatedAt": "2024-01-10T09:05:00Z"
}
],
"emailStats": {
"sent": 12,
"delivered": 12,
"opened": 9,
"clicked": 3,
"bounced": 0,
"unsubscribed": 0,
"complained": 0
},
"activity": [
{
"id": "evt_1",
"eventType": "custom",
"eventTime": "2024-01-15T10:25:00Z",
"emailSendId": null,
"campaignId": null,
"clickedUrl": null,
"bounceType": null,
"eventName": "saas.purchase",
"properties": { "plan": "pro" }
}
],
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-01-15T10:30:00Z"
}
}
Retrieve a subscriber by their email address. The response includes the base subscriber profile plus list memberships, sequence enrollments, email engagement stats, and the most recent activity events.
You can also retrieve by external ID with
GET /api/v1/subscribers/external?externalId={externalId}.
Path Parameters
Subscriber email (URL encoded)
Query Parameters
External ID to use with
/subscribers/external. Use this route for IDs that
contain /.curl "https://api.sequenzy.com/api/v1/subscribers/user%40sequenzy.com" \
-H "Authorization: Bearer YOUR_API_KEY"
curl "https://api.sequenzy.com/api/v1/subscribers/external?externalId=user_123" \
-H "Authorization: Bearer YOUR_API_KEY"
Responses
{
"success": true,
"subscriber": {
"id": "sub_abc123",
"email": "user@sequenzy.com",
"externalId": "user_123",
"firstName": "John",
"lastName": "Doe",
"status": "active",
"emailProvider": "gmail",
"tags": ["customer", "newsletter"],
"customAttributes": { "plan": "pro" },
"lists": [
{
"id": "list_vip",
"name": "VIP Customers",
"description": null,
"isPrivate": false,
"subscribedAt": "2024-01-10T09:00:00Z",
"unsubscribedAt": null
}
],
"sequenceEnrollments": [
{
"tokenId": "token_123",
"sequenceId": "seq_welcome",
"sequenceName": "Welcome Flow",
"sequenceStatus": "active",
"enrollmentStatus": "active",
"currentNodeId": "node_abc",
"currentNodeType": "action_email",
"currentNodeLabel": "Send welcome email",
"scheduledFor": null,
"enteredAt": "2024-01-10T09:05:00Z",
"updatedAt": "2024-01-10T09:05:00Z"
}
],
"emailStats": {
"sent": 12,
"delivered": 12,
"opened": 9,
"clicked": 3,
"bounced": 0,
"unsubscribed": 0,
"complained": 0
},
"activity": [
{
"id": "evt_1",
"eventType": "custom",
"eventTime": "2024-01-15T10:25:00Z",
"emailSendId": null,
"campaignId": null,
"clickedUrl": null,
"bounceType": null,
"eventName": "saas.purchase",
"properties": { "plan": "pro" }
}
],
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-01-15T10:30:00Z"
}
}
⌘I
Get Subscriber
curl --request GET \
--url https://api.sequenzy.com/api/v1/subscribers/{email} \
--header 'Authorization: Bearer <token>'{
"success": true,
"subscriber": {
"id": "sub_abc123",
"email": "user@sequenzy.com",
"externalId": "user_123",
"firstName": "John",
"lastName": "Doe",
"status": "active",
"emailProvider": "gmail",
"tags": ["customer", "newsletter"],
"customAttributes": { "plan": "pro" },
"lists": [
{
"id": "list_vip",
"name": "VIP Customers",
"description": null,
"isPrivate": false,
"subscribedAt": "2024-01-10T09:00:00Z",
"unsubscribedAt": null
}
],
"sequenceEnrollments": [
{
"tokenId": "token_123",
"sequenceId": "seq_welcome",
"sequenceName": "Welcome Flow",
"sequenceStatus": "active",
"enrollmentStatus": "active",
"currentNodeId": "node_abc",
"currentNodeType": "action_email",
"currentNodeLabel": "Send welcome email",
"scheduledFor": null,
"enteredAt": "2024-01-10T09:05:00Z",
"updatedAt": "2024-01-10T09:05:00Z"
}
],
"emailStats": {
"sent": 12,
"delivered": 12,
"opened": 9,
"clicked": 3,
"bounced": 0,
"unsubscribed": 0,
"complained": 0
},
"activity": [
{
"id": "evt_1",
"eventType": "custom",
"eventTime": "2024-01-15T10:25:00Z",
"emailSendId": null,
"campaignId": null,
"clickedUrl": null,
"bounceType": null,
"eventName": "saas.purchase",
"properties": { "plan": "pro" }
}
],
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-01-15T10:30:00Z"
}
}