Skip to main content
GET
List the subscribers of a list

Authorizations

Authorization
string
header
required

An API token. The "read" ability: GET routes only. "read + write": every route.

Path Parameters

list
string<uuid>
required

The list's identifier (uuid).

Query Parameters

page
integer
default:1
Required range: x >= 1
per_page
integer
default:25
Required range: 1 <= x <= 100
status
enum<string>
Available options:
unconfirmed,
subscribed,
unsubscribed
email
string<email>

An exact address (lower-cased first).

tag
string

The name of a tag the subscriber carries.

since
string<date>

Created from this date onwards.

sort
enum<string>
default:id
Available options:
id,
email
direction
enum<string>
default:desc
Available options:
asc,
desc

Response

The subscribers, most recent first.

data
object[]
meta
object