Sign in
Subscribers

List subscribers

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

get/subscribers

Query parameters

pageinteger

Page number

limitinteger

Number of items per page (max 100)

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

Filter by subscriber status

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.

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