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": 100,
    "total": 150,
    "totalPages": 2
  }
}
List subscribers with pagination and optional filtering by status, free-text query, tags, list, 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, bounced, or all. Use all to disable status filtering.
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.
list
string
Subscriber list ID or exact list name. The API tries ID first, then exact name.
listId
string
Filter by subscriber list ID.
listName
string
Filter by exact subscriber list name when the ID is not known.
segmentId
string
Filter by an existing segment ID
curl "https://api.sequenzy.com/api/v1/subscribers?page=1&limit=100&status=active&list=Master%20List" \
  -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": 100,
    "total": 150,
    "totalPages": 2
  }
}