List all subscribers.
list_subscribersRetrieve and filter Flodesk subscribers by status, segment, or page to manage marketing contacts and review audience lists.
Instructions
List all subscribers.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | The page number. Defaults to 1. | |
| status | No | Optional. The subscriber's status. `active`: The subscriber is currently active to receive marketing emails. `unsubscribed`: The subscriber has opted out of marketing emails. `unconfirmed`: The subscriber is pending for double opt-in confirmation. `bounced`: The subscriber's address is undeliverable due to a hard bounce. `complained`: The subscriber marked an email as spam. `cleaned`: The subscriber was cleaned, learn more [here](https://help.flodesk.com/en/articles/4747969#how_can_i_find_out_which_email_addresses_have_been_cleaned). `archived`: The subscriber was archived. | |
| account | No | Exact configured private account profile label; not a tenant or provider account ID. | |
| per_page | No | The number of records to be returned on each page. Defaults to 20. Maximum 100. | |
| segment_id | No | Optional. The segment's id. When included, returns only subscribers who were added to the given segment. |