Skip to main content
GET
/
api
/
v1
/
subscribers
List Subscribers
curl --request GET \
  --url https://api.sequenzy.com/api/v1/subscribers \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "subscribers": [
    {
      "id": "sub_abc123",
      "email": "user@sequenzy.com",
      "firstName": "John",
      "lastName": "Doe",
      "status": "active",
      "emailProvider": "gmail",
      "tags": ["customer", "newsletter"],
      "customAttributes": { "plan": "pro" },
      "createdAt": "2024-01-15T10:30:00Z",
      "updatedAt": "2024-01-15T10:30:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 150,
    "totalPages": 8
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.sequenzy.com/llms.txt

Use this file to discover all available pages before exploring further.

List subscribers with pagination and optional filtering by status, free-text query, tags, segment, or email.

​
Query Parameters

​
page
number
default:"1"
Page number
​
limit
number
default:"20"
Items per page (max 100)
​
status
string
Filter by status: active, unsubscribed, or bounced
​
query
string
Free-text search across email, first name, last name, and tags
​
email
string
Legacy alias for a partial email search
​
tags
string
Comma-separated tag names. A subscriber must have all provided tags.
​
segmentId
string
Filter by an existing segment ID
curl "https://api.sequenzy.com/api/v1/subscribers?page=1&limit=20&status=active&query=john&tags=customer,vip" \
  -H "Authorization: Bearer YOUR_API_KEY"

​
Responses

{
  "success": true,
  "subscribers": [
    {
      "id": "sub_abc123",
      "email": "user@sequenzy.com",
      "firstName": "John",
      "lastName": "Doe",
      "status": "active",
      "emailProvider": "gmail",
      "tags": ["customer", "newsletter"],
      "customAttributes": { "plan": "pro" },
      "createdAt": "2024-01-15T10:30:00Z",
      "updatedAt": "2024-01-15T10:30:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 150,
    "totalPages": 8
  }
}