List segment subscribers
get_segment_subscribersRetrieve subscribers in a Beehiiv segment by publication and segment ID, with pagination, limits, and optional expanded data such as stats, tags, or referrals.
Instructions
List segment subscribers. Reads account data. OAuth integrations require segments:read.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Pagination returns the results in pages. Each page contains the number of results specified by the `limit` (default: 10). 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. | |
| expand | No | Optionally expand the response to include additional data. `stats` - Returns statistics about the subscription(s). `custom_fields` - Returns custom field values set on the subscription. `referrals` - Returns referrals made by the subscription. `tags` - Returns tags associated with the subscription. `subscription_premium_tiers` - Returns premium tier(s) the subscription is subscribed to. | |
| account | No | Named private account from BEEHIIV_ACCOUNTS. Defaults to BEEHIIV_DEFAULT_ACCOUNT or the first configured account. | |
| segment_id | Yes | The prefixed ID of the segment object | |
| publication_id | Yes | The prefixed ID of the publication object |