List newsletter list subscriptions
list_newsletter_list_subscriptionsRetrieve subscriptions for a specific Beehiiv newsletter list using publication and list IDs. Supports pagination and reading all pages for subscriber data.
Instructions
List newsletter list subscriptions. Reads account data. OAuth integrations require newsletter_lists:read.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | **Offset-based pagination (deprecated)**: Page number for offset-based pagination. Please migrate to cursor-based pagination using the `cursor` parameter. If not specified, results 1-10 from page 1 will be returned. | |
| 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. | |
| account | No | Named private account from BEEHIIV_ACCOUNTS. Defaults to BEEHIIV_DEFAULT_ACCOUNT or the first configured account. | |
| 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. | |
| publication_id | Yes | The prefixed ID of the publication object | |
| newsletter_list_id | Yes | The prefixed ID of the newsletter list object |