List and filter subscribers
list_subscribersFetch subscribers with dashboard-style filters, free-text search, sorting, and paging. Get a count of matching subscribers to size segments before pulling full data.
Instructions
List subscribers, with the same filtering the Subscribers dashboard offers: 48 columns, free-text search, sorting and paging.
Returns {count, returned, limit, offset, subscribers}. count is the total matching the filters regardless of limit, so calling with limit: 1 is a cheap way to size a segment before pulling it.
Note: Substack takes the fields it returns from the publication's saved Display settings and ignores a per-request column list. Engagement columns can be filtered on here but are usually not present in the records that come back. Use export_subscribers to read their values.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | How many to return. 1 to 100, default 25. | |
| offset | No | Skip this many, for paging. | |
| search | No | Free text matched against subscriber name and email. | |
| filters | No | Conditions, combined with AND. There is no OR and no nesting: anything needing OR has to be issued as separate calls. Operators by column type: - Int: is, is_not, gt, gte, lt, lte - String: is, is_not, is_any_of, contains, starts_with, ends_with, includes_none - DateTime: is_on, is_after, is_on_or_after, is_before, is_on_or_before - Array (tag_ids, emails_enabled): includes_any, includes_all, includes_none - subscription_type and group_membership: is, is_not, is_any_of Columns: user_name (String, "Name"); user_email_address (String, "Email"); country (String, "Country"); state (String, "State/Province"); group_membership (group_membership, "Group membership"); subscription_type (subscription_type, "Type"); subscription_created_at (DateTime, "Start date"); subscription_expires_at (DateTime, "Expiration date"); first_payment_at (DateTime, "First paid date"); last_subscribed_at (DateTime, "Paid upgrade date"); unsubscribed_at (DateTime, "Cancel date"); subscription_interval (String, "Subscription interval"); stripe_plan_name (String, "Stripe plan"); free_attribution (String, "Subscription source (free)"); paid_attribution (String, "Subscription source (paid)"); is_subscribed (Int, "Can see paid content"); bestseller_tier (Int, "Bestseller"); total_revenue_generated (Int, "Revenue"); num_subs_gifted (Int, "Subscriptions gifted"); bundle_id (Int, "Bundle"); is_bundle_parent (Int, "Bundle origin"); num_emails_received (Int, "Emails received (6mo)"); num_emails_dropped (Int, "Emails dropped (6mo)"); num_email_opens (Int, "Emails opened (6mo)"); num_email_opens_last_7d (Int, "Emails opened (7d)"); num_email_opens_last_30d (Int, "Emails opened (30d)"); num_unique_email_posts_seen (Int, "Unique emails seen (6mo)"); num_unique_email_posts_seen_last_7d (Int, "Unique emails seen (7d)"); num_unique_email_posts_seen_last_30d (Int, "Unique emails seen (30d)"); last_opened_at (DateTime, "Last email open"); links_clicked (Int, "Links clicked"); last_clicked_at (DateTime, "Last clicked at"); emails_enabled (Array, "Sections"); num_web_post_views (Int, "Post views"); num_web_post_views_last_7d (Int, "Post views (7d)"); num_web_post_views_last_30d (Int, "Post views (30d)"); num_unique_web_posts_seen (Int, "Unique posts seen"); num_unique_web_posts_seen_last_7d (Int, "Unique posts seen (7d)"); num_unique_web_posts_seen_last_30d (Int, "Unique posts seen (30d)"); num_comments (Int, "Comments"); num_comments_last_7d (Int, "Comments (7d)"); num_comments_last_30d (Int, "Comments (30d)"); num_shares (Int, "Shares"); num_shares_last_7d (Int, "Shares (7d)"); num_shares_last_30d (Int, "Shares (30d)"); days_active_last_30d (Int, "Days active (30d)"); activity_rating (Int, "Activity"); tag_ids (Array, "Tags") | |
| sort_by | No | Any column name to sort by. | |
| publication | No | Which connected publication to act on, matched loosely against its hostname (for example 'example.substack.com' or just 'example'). Defaults to the first connected publication. | |
| sort_direction | No | desc |