List subscriptions
list_subscriptionsRetrieve and filter Beehiiv publication subscriptions by status, tier, email, or creation date to read account data and manage subscriber lists.
Instructions
List subscriptions. Reads account data. OAuth integrations require subscriptions:read.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | **Offset-based pagination (deprecated)**: Page number for offset-based pagination. This method is deprecated and limited to 100 pages maximum. Please migrate to cursor-based pagination using the `cursor` parameter. If not specified, results 1-10 from page 1 will be returned. See the [Pagination Guide](/welcome/pagination) for migration guidance. | |
| tier | No | Optionally filter the results by a their tier | all |
| No | Optional email address to find a subscription. This param must be an exact match and is case insensitive. | ||
| limit | No | A limit on the number of objects to be returned. The limit can range between 1 and 100, and the default is 10. | |
| cursor | No | **Cursor-based pagination (recommended)**: Use this opaque cursor token to fetch the next page of results. When provided, pagination will use cursor-based method which is more efficient and consistent than offset-based pagination. See the [Pagination Guide](/welcome/pagination) for more details. | |
| expand | No | Optional list of expandable objects. `subscription_premium_tiers ` - Returns an array of tiers the subscription is associated with. `referrals` - Returns an array of subscriptions with limited data - `id`, `email`, and `status`. These are the subscriptions that were referred by this subscription. `stats` - Returns statistics about the subscription(s). `custom_fields` - Returns an array of custom field values that have been set on the subscription. `newsletter_lists` - Returns an array of newsletter list prefixed IDs the subscription is actively subscribed to. | |
| status | No | Optionally filter the results by a status | all |
| account | No | Named private account from BEEHIIV_ACCOUNTS. Defaults to BEEHIIV_DEFAULT_ACCOUNT or the first configured account. | |
| order_by | No | The field that the results are sorted by. Defaults to created `created` - The time in which the subscription was first created. | created |
| all_pages | No | Read successive cursor pages, bounded by max_items (default 1000). | |
| direction | No | The direction that the results are sorted in. Defaults to asc `asc` - Ascending, sorts from smallest to largest. `desc` - Descending, sorts from largest to smallest. | asc |
| max_items | No | Maximum records when all_pages=true. Returns continuation cursor and truncation. | |
| creation_date | No | Optional date entry (in the format YYYY/MM/DD) that filters returned subscriptions by their creation date. | |
| premium_tiers | No | Optionally filter the results by one or multiple premium tiers | |
| publication_id | Yes | The prefixed ID of the publication object | |
| premium_tier_ids | No | Optionally filter the results by one or multiple premium tier ids |