Skip to main content
GET
List subscribers

Authorizations

Authorization
string
header
required

A session token from subscriber login, used by subscriber.dev's own apps. Requests about an environment also need its ID in the x-environment-id header. From your own code, use an API key.

Query Parameters

limit
number
default:20
Required range: 1 <= x <= 100
offset
number
default:0
Required range: 0 <= x <= 9007199254740991
email
string<email>

Filter to the subscriber with this exact email address

Pattern: ^(?:[A-Za-z0-9_'+\-]+\.)*[A-Za-z0-9_'+\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
externalId
string

Filter to the subscriber with this exact external ID

q
string

Case-insensitive partial match across email, phone, externalId, firstName, lastName, and name

Minimum string length: 1
emailOptedIn
enum<boolean>

Filter by the subscriber's latest email preference (true = opted in, false = opted out)

Available options:
true,
false

Response

subscribers
object[]
required
limit
number
required
offset
number
required