Skip to main content
Glama
thenavidm
by thenavidm

List subscriptions

list_subscriptions
Read-onlyIdempotent

Retrieve 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

TableJSON Schema
NameRequiredDescriptionDefault
pageNo**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.
tierNoOptionally filter the results by a their tierall
emailNoOptional email address to find a subscription. This param must be an exact match and is case insensitive.
limitNoA limit on the number of objects to be returned. The limit can range between 1 and 100, and the default is 10.
cursorNo**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.
expandNoOptional 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.
statusNoOptionally filter the results by a statusall
accountNoNamed private account from BEEHIIV_ACCOUNTS. Defaults to BEEHIIV_DEFAULT_ACCOUNT or the first configured account.
order_byNoThe field that the results are sorted by. Defaults to created `created` - The time in which the subscription was first created.created
all_pagesNoRead successive cursor pages, bounded by max_items (default 1000).
directionNoThe 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_itemsNoMaximum records when all_pages=true. Returns continuation cursor and truncation.
creation_dateNoOptional date entry (in the format YYYY/MM/DD) that filters returned subscriptions by their creation date.
premium_tiersNoOptionally filter the results by one or multiple premium tiers
publication_idYesThe prefixed ID of the publication object
premium_tier_idsNoOptionally filter the results by one or multiple premium tier ids

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.0.0

TDQS

B3.2/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint, idempotentHint, openWorldHint and destructiveHint=false, so the safety profile is covered. The description adds the useful auth-scope requirement (subscriptions:read for OAuth integrations) and notes it reads account data, but says nothing about pagination behavior, result size, or rate limits beyond what the schema already documents.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Three short, front-loaded sentences with no filler. "Reads account data" is largely redundant with readOnlyHint=true, slightly diluting an otherwise efficient definition.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a 16-parameter list tool with no output schema, the description relies almost entirely on the schema and annotations. It adds the auth scope but omits any note on the default 10-item limit, pagination strategy, or return shape that would round out the picture.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100% with 16 well-documented parameters, so the schema carries the full parameter burden. The description adds no parameter-level meaning beyond it, making the baseline 3 appropriate.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ("List subscriptions") that an agent can act on immediately. However, it offers no differentiation from close siblings like list_newsletter_list_subscriptions or get_subscription_by_email, so the agent cannot tell which listing endpoint fits a given need from the description alone.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

There is no when-to-use guidance, no exclusions, and no named alternatives. The only extra sentence about OAuth scope is a prerequisite/auth note, not a usage condition that helps select this tool over siblings.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools