List complimentary access
list_complimentary_accessRetrieve complimentary access records for a Beehiiv publication; supports pagination and optional tier/stats expansion. Requires complimentary_access:read for OAuth integrations.
Instructions
List complimentary access. Reads account data. OAuth integrations require complimentary_access:read.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| 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 | Use this opaque cursor token to fetch the next page of results. Obtain the value from `next_cursor` in a previous response. | |
| expand | No | Optional list of expandable objects. `tier` - Returns the full tier object associated with this complimentary access. `stats` - Returns granted subscription counts. | |
| 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). | |
| max_items | No | Maximum records when all_pages=true. Returns continuation cursor and truncation. | |
| publication_id | Yes | The prefixed ID of the publication object |