List subscribers
buttondown_list_subscribersRead-only
List or search subscribers (newest first by default) with e-mail, type (regular, unactivated, unsubscribed, premium, ...), tags, notes, metadata, source, open/click rates and dates. Filter by e-mail text, type, tag, signup date or domain. GET /subscribers.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| tag | No | Only subscribers with these tag names. | |
| page | No | Page number, from 1 (default 1). Pass the previous reply's next_page. | |
| type | No | Only subscribers of these types (e.g. regular, unactivated, unsubscribed). | |
| domain | No | Only subscribers whose e-mail domain is one of these. | |
| not_type | No | Exclude subscribers of these types. | |
| ordering | No | Sort field, - for descending (default -creation_date). | |
| created_after | No | Only subscribers created on or after this date (yyyy-mm-dd). | |
| email_address | No | Only subscribers whose e-mail address contains this text. | |
| created_before | No | Only subscribers created before this date (yyyy-mm-dd). |