Sign in
Subscribers

List subscribers

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

get/subscribers

Query parameters

pageinteger

Page number

limitinteger

Number of items per page (max 100)

status'active' | 'unsubscribed' | 'bounced' | 'all'

Filter by subscriber status. Use all to disable status filtering.

querystring

Free-text search across email, first name, last name, and tags

emailstring

Legacy alias for a partial email search

tagsstring

Comma-separated tag names. Subscribers must have all provided tags.

liststring

Subscriber list ID or exact list name. The API tries ID first, then exact name.

listIdstring

Filter by subscriber list ID.

listNamestring

Filter by exact subscriber list name when the list ID is not known.

segmentIdstring

Filter by an existing segment ID

Response

Successful response

successboolean

Example response

{
  "success": true,
  "subscribers": [
    {
      "id": "sub_abc123",
      "email": "user@example.com",
      "externalId": "user_123",
      "firstName": "John",
      "lastName": "Doe",
      "status": "active",
      "emailProvider": "gmail",
      "tags": [
        "premium",
        "newsletter"
      ],
      "customAttributes": {
        "plan": "pro",
        "signupSource": "website"
      }
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 100,
    "totalPages": 5
  }
}

Changes