Official vendor OpenAPI document · agent-readyMarketingEmail Marketingbearer67 EndpointsREST
For Agents
Manage newsletter subscriptions, publish posts, run automations, segment audiences, and operate paid tiers and referral programmes through beehiiv's 67 publication-scoped endpoints.
Use for: Add a new subscriber to my newsletter publication, Bulk import 5000 subscribers from a CSV export, Find all subscribers tagged premium-readers, Publish a draft post to my publication this Friday
Not supported: Does not handle SMS, push notifications, e-commerce checkout, or website hosting - use for newsletter subscriptions, posts, segments, paid tiers, and creator-monetisation operations only.
beehiiv is a newsletter and creator-monetisation platform that publishers use to send email newsletters, manage paid tiers, run referral programmes, and serve advertisements. The 67-endpoint API is publication-scoped and exposes operations across subscriptions, posts, segments, custom fields, tiers, webhooks, automations, polls, and bulk subscription updates, secured by a bearer API key issued from the publication settings.
Install Jentic One Beta
Connect the beehiiv API to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the beehiiv API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.
Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.
1
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fbeehiiv.com%2Fbeehiiv" | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fbeehiiv.com%2Fbeehiiv" | sh
jentic register # connects your agent to your Jentic One instanceJentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.
Capabilities
What an agent can do with beehiiv API.
Add, update, and tag newsletter subscriptions for a publication
Run bulk subscription imports and read job status from the bulk-update endpoints
Publish, schedule, and manage posts on a publication
Build and apply audience segments using condition sets and custom fields
Operate paid tiers and pull subscription tier history for revenue reporting
Drive automation journeys and publish polls embedded in newsletter posts
Register webhooks to receive subscriber and post events
Use Cases
Patterns agents use beehiiv API for, with concrete tasks.
★ Subscriber acquisition and CRM sync
Newsletter operators sync subscribers into beehiiv from website forms, lead magnets, and CRM exports so the audience of record stays in beehiiv. POST /publications/{publicationId}/subscriptions adds individuals, POST /publications/{publicationId}/bulk_subscriptions handles list imports, and the bulk_subscription_updates endpoints expose job status so the integration knows when an import has completed.
Add subscriber jane@example.com to publication pub_123 with custom field source set to landing_page_a and tag launch_2026
Audience segmentation for targeted sends
Operators segment their list using custom fields and behavioural signals so each post is sent to the readers most likely to engage. The /custom_fields and /condition_sets endpoints let an integration define attributes and rule sets, and /segments expose saved segments referenced when scheduling a post. This drives both engagement and reduced unsubscribe rates.
Create a custom field signup_source on publication pub_123 and build a segment of subscribers where signup_source equals podcast for a targeted promo send
Paid tiers and revenue reporting
Creators monetise through paid tiers on beehiiv and need revenue and tier-membership data for finance reporting. The /tiers endpoints expose tier configuration and per-subscription tier history, so an integration can build a monthly recurring revenue snapshot or detect downgrade and churn events for save-flow automations.
List all active paid subscriptions on publication pub_123, group by tier, and calculate the implied monthly recurring revenue
AI agent integration for creator operations
Independent creators and small newsletter teams use AI agents through Jentic to handle the long tail of operational tasks: tagging new subscribers, exporting weekly engagement reports, and setting up automation journeys for new signups. The agent searches Jentic for the right beehiiv operation, loads the schema, and executes with the bearer API key held in your Jentic One instance, so the key never appears in agent context.
Through Jentic, find beehiiv's segments operation and produce a weekly report of subscriber growth, segmented by signup source, for publication pub_123
Key Endpoints
67 endpoints — beehiiv is a newsletter and creator-monetisation platform that publishers use to send email newsletters, manage paid tiers, run referral programmes, and serve advertisements.
METHOD
PATH
DESCRIPTION
POST
/publications/{publicationId}/subscriptions
Add a subscriber
GET
/publications/{publicationId}/subscriptions
List subscribers with filters
POST
/publications/{publicationId}/bulk_subscriptions
Bulk import subscribers
GET
/publications/{publicationId}/posts
List newsletter posts
POST
/publications/{publicationId}/custom_fields
Define a custom subscriber field
GET
/publications/{publicationId}/segments
List saved audience segments
GET
/publications/{publicationId}/tiers
List paid tiers
POST
/publications/{publicationId}/webhooks
Register a webhook
POST
/publications/{publicationId}/subscriptions
Add a subscriber
GET
/publications/{publicationId}/subscriptions
List subscribers with filters
POST
/publications/{publicationId}/bulk_subscriptions
Bulk import subscribers
GET
/publications/{publicationId}/posts
List newsletter posts
POST
/publications/{publicationId}/custom_fields
Define a custom subscriber field
GET
/publications/{publicationId}/segments
List saved audience segments
GET
/publications/{publicationId}/tiers
List paid tiers
POST
/publications/{publicationId}/webhooks
Register a webhook
Jentic AI Readiness Score
This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.
A
API Reference
- Foundational (C)55/100
57
Foundational Compliance67
Developer Experience & Jentic Compatibility32
AI-Readiness & Agent Experience91
Agent Usability60
Security100
AI DiscoverabilityPowered by JenticScoring Framework 1.0.0 | Scoring Engine 0.4.0
Show dimension breakdown
57
Foundational Compliance
Base layer of spec validity and structural soundness.
Grade: CSignals: 4
27%
Lint Results
Aggregated quality score from linter diagnostics, weighted by severity.
100%
Resolution Completeness
Percentage of `$ref` references that resolve successfully.
0%
Specification Validity
Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).
100%
Structural Integrity
Structural correctness score based on schema issues using logarithmic dampening.
67
Developer Experience & Jentic Compatibility
Clarity, completeness, and ingestion readiness for developers and tooling.
Grade: BSignals: 4
0%
Example Density
How richly the API is illustrated with examples.
100%
Example Validity
Percentage of examples that conform to their schemas.
74%
Response Coverage
Percentage of operations with complete response definitions (success, client error, server error).
93%
Tooling Readiness
Health of API ingestion, bundling, and resolution within Jentic pipelines.
32
AI-Readiness & Agent Experience
Semantic breadth, depth, and agent comprehension for AI systems.
Grade: FSignals: 4
69%
Description Coverage
Coverage of descriptions across API elements.
0%
Error Standardization
Coverage of RFC 9457 Problem Details for error responses.
0%
OperationId Quality
Coverage, uniqueness, and casing consistency of operationIds for AI inference.
60%
Summary Coverage
Coverage of summaries across operations/tags/info.
91
Agent Usability
Functional utility, complexity comfort, and AI orchestration readiness.
Grade: A+Signals: 1
91%
Complexity Comfort
Agent comfort level based on API operational and structural complexity.
60
Security
Trust, risk posture, and security compliance.
Grade: B-Signals: 1
60%
Authentication Strength
Average quality of security schemes based on authentication method strength (weakest link for OAuth2).
100
AI Discoverability
Findability, semantic richness, and reasoning readiness.
Grade: A+Signals: 1
100%
Descriptive Richness
Clarity and depth of descriptions across API elements.
Score it yourself
Every API in the directory is allowlisted, so you can re-score it with no key required.
npx @jentic/api-scorecard-cli score <openapi-url>Why Jentic?
What agents get from Jentic-routed access to this vendor.
Setup
Wiring the beehiiv API by hand means carrying a bearer key, learning the subscription, post, segment, and tier endpoints, and threading the publication id through every call yourself. Through Jentic you install once, import the beehiiv API from the API Directory, store the key once, and your agent calls it.
Permission scoping
beehiiv puts the publication id in the URL path (/publications/{publicationId}/subscriptions), so a rule can pin your agent to one publication: it reads and adds subscribers for that publication and nothing else. You choose the operations it may call, so bulk subscriptions or webhook creation are not included unless you add them.
Credential isolation
Your beehiiv bearer key is stored once, encrypted, by your own Jentic One instance and injected as the Authorization header at execution time. It never enters the agent's prompt, logs, or context.
Intent-based discovery
Agents search Jentic by intent such as 'add a newsletter subscriber' or 'create an audience segment', and Jentic returns the matching beehiiv operation with its input schema so the agent calls /publications/{publicationId}/subscriptions or /publications/{publicationId}/segments without browsing the reference docs.
Related APIs
Alternatives and complements available in the Jentic catalogue.
FAQs
Specific to using beehiiv API through Jentic.
Where is beehiiv's official OpenAPI specification?
beehiiv publishes one at https://developers.beehiiv.com/openapi/api-reference.yaml, an OpenAPI 3.1 document served from its own developer site. This page's specification is derived from that same beehiiv API Reference document, so its operations, paths, and schemas come from beehiiv rather than being written by Jentic; Jentic bundles it, validates it, and keeps it agent-ready. beehiiv's published document currently covers more operations than the snapshot this page was built from, so treat the URL above as the fuller reference. Get started with Jentic One, the self-hosted execution layer.
What authentication does the beehiiv API use?
beehiiv uses HTTP bearer authentication. Generate an API key from your publication's API integrations settings and pass it as Authorization: Bearer <token>. Jentic stores the key in its vault and injects the header at execution time so it never enters agent context.
Can I bulk import subscribers with the beehiiv API?
Yes. POST /publications/{publicationId}/bulk_subscriptions accepts a list payload and returns a job ID. Read /publications/{publicationId}/bulk_subscription_updates and /publications/{publicationId}/bulk_subscription_updates/{id} to track progress until the job completes.
How do I segment my audience through Jentic?
Search Jentic for create a beehiiv audience segment to find the segments and condition_sets endpoints. Load the schema and execute with your custom_field IDs and condition rules. Segments referenced when scheduling a post will narrow the recipient list to the matching subscribers.
Does the beehiiv API expose paid tier and revenue data?
Yes. /publications/{publicationId}/tiers lists configured tiers, and the subscriptions endpoints include tier membership per subscriber. Combine these to compute MRR, churn, and tier-distribution snapshots without exporting CSVs.
Can I register webhooks for subscription events?
Yes. POST /publications/{publicationId}/webhooks registers a webhook URL and event filter. The supported events cover subscription lifecycle changes and post events; consult the response schema to choose the events your integration cares about.
What are the rate limits for the beehiiv API?
beehiiv enforces per-publication rate limits described in its developer docs rather than in the OpenAPI spec. If you receive HTTP 429 responses, back off and retry with exponential delay, and contact beehiiv support if a sustained sync needs higher headroom.
Can I limit what my agent is allowed to do with the beehiiv API?
Yes. Because you run Jentic One yourself, your own rules decide which beehiiv operations and credentials the agent may use. Since beehiiv puts the publication id in the URL path, such as /publications/{publicationId}/subscriptions, you can pin the agent to a single publication so it only reads and adds subscribers there. You also choose the exact operations it may call, so higher-impact actions like POST /publications/{publicationId}/bulk_subscriptions or POST /publications/{publicationId}/webhooks stay off limits unless you explicitly grant them.
GET STARTED