Easily Integrate
beehiiv's API using Konfig's TypeScript SDK
Growing API Companies trust Konfig's SDKs to onboard developers to their API.
First, instantiate the SDK
It only takes a few lines of code.
Then, send your first request
We made it really easy.
Enjoy a buttery smooth developer experience with 38 SDK methods
Parameter
Optional list of expandable objects.stats - Returns all statistics about the publication(https://developers.beehiiv.com/docs/v2stat_active_subscriptions - Total number of active free and premium subscriptionsstat_active_premium_subscriptions - Total number of active premium/paid subscriptionsstat_active_free_subscriptions - Total number of active free subscriptionsstat_average_open_rate - The publications historical average open ratestat_average_click_rate - The publications historical average click through ratestat_total_sent - Total number of emails sentstat_total_unique_opened - Total number of uniquely opened emails. Only counts the first open for each subscriber.stat_total_clicked - The total number of links clicked from emails.
A limit on the number of objects to be returned. The limit can range between 1 and 100, and the default is 10.
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.
The direction that the results are sorted in. Defaults to asc
asc - Ascending, sorts from smallest to largest.
desc - Descending, sorts from largest to smallest.
The field that the results are sorted by. Defaults to created
created - The time in which the publication was first created.
name - The name of the publication.
Response
The top level error response.
The top level error response.
The top level error response.
The top level error response.
Endpoint
Parameter
Optional list of expandable objects.stats - Returns all statistics about the publication(https://developers.beehiiv.com/docs/v2stat_active_subscriptions - Total number of active free and premium subscriptionsstat_active_premium_subscriptions - Total number of active premium/paid subscriptionsstat_active_free_subscriptions - Total number of active free subscriptionsstat_average_open_rate - The publications historical average open ratestat_average_click_rate - The publications historical average click through ratestat_total_sent - Total number of emails sentstat_total_unique_opened - Total number of uniquely opened emails. Only counts the first open for each subscriber.stat_total_clicked - The total number of links clicked from emails.
Response
The top level error response.
The top level error response.
The top level error response.
The top level error response.
Endpoint
Parameter
Optional list of expandable objects.stats - Returns statistics about the post(https://developers.beehiiv.com/docs/v2
free_web_content - Returns the web HTML rendered to a free reader
free_email_content - Returns the email HTML rendered to a free reader
free_rss_content - Returns the RSS feed HTML
premium_web_content - Returns the web HTML rendered to a premium reader
premium_email_content - Returns the email HTML rendered to a premium reader
Optionally filter the results by audience
Optionally filter the results by platform.web - Posts only published to web.email - Posts only published to email.both - Posts published to email and web.all - Does not restrict results by platform.
Optionally filter the results by the status of the post.draft - not been scheduled.confirmed - The post will be active after the scheduled_at.archived - The post is no longer active.all - Does not restrict results by status.
Optionally filter posts by content_tags. Adding a content tag will return any post with that content tag associated to it.
Example: Filtering for content_tags: ["sales","closing"] will return results of posts that have either sales or closing content_tags.
A limit on the number of objects to be returned. The limit can range between 1 and 100, and the default is 10.
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.
The field that the results are sorted by. Defaults to created
created - The time in which the post was first created.
publish_date - The time the post was set to be published.
displayed_date - The time displayed in place of the publish_date. If no displayed_date was set, it will default to the publish_date
The direction that the results are sorted in. Defaults to asc
asc - Ascending, sorts from smallest to largest.
desc - Descending, sorts from largest to smallest.
Optionally filter the results by the hidden_from_feed attribute of the post.all - Does not restrict results by hidden_from_feed.true - Only return posts hidden from the feed.false - Only return posts that are visible on the feed.
Response
The top level error response.
The top level error response.
The top level error response.
The top level error response.
Endpoint
No Parameters
Response
The top level error response.
The top level error response.
The top level error response.
The top level error response.
Endpoint
Parameter
Optional list of expandable objects.stats - Returns statistics about the post(https://developers.beehiiv.com/docs/v2
free_web_content - Returns the web HTML rendered to a free reader
free_email_content - Returns the email HTML rendered to a free reader
free_rss_content - Returns the RSS feed HTML
premium_web_content - Returns the web HTML rendered to a premium reader
premium_email_content - Returns the email HTML rendered to a premium reader
Response
The top level error response.
The top level error response.
The top level error response.
The top level error response.
Endpoint
Parameter
Optional list of expandable objects.stats - Returns statistics about the subscription(https://developers.beehiiv.com/docs/v2.custom_fields - Returns an array of custom field values that have been set on the subscription.referrals - Returns an array of subscriptions with limited data - id, email, and status. These are the subscriptions that were referred by this subscription.
Optionally filter the results by a status
Optionally filter the results by a their tier
A limit on the number of objects to be returned. The limit can range between 1 and 100, and the default is 10.
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.
Optional email address to find a subscription.
This param must be an exact match and is case insensitive.
The field that the results are sorted by. Defaults to created
created - The time in which the subscription was first created.
email - The email address of the subscription.
The direction that the results are sorted in. Defaults to asc
asc - Ascending, sorts from smallest to largest.
desc - Descending, sorts from largest to smallest.
Response
The top level error response.
The top level error response.
The top level error response.
The top level error response.
Endpoint
How Konfig Works
Konfig collects APIs and automatically generates SDKs so you can focus on building your application.
Konfig maintains the highest quality collection of OpenAPI Specifications on the internet in a GitHub repository
We pull OpenAPI Specifications from public sources, fix any errors, and make sure they pass our lint rules. We continually make sure the repository is up-to-date and collect up-time and response time metrics for every API.
Generates AI-Augmented SDKs from openapi-examples
Our SDK generator is trusted by growing API companies and goes through a rigorous testing process to ensure the generated SDKs are high-quality and easy to use.
Publishes to standard package managers
We publish to standard package managers like npm, PyPI, and Maven so you can easily integrate the SDK into your application.
About beehiiv
beehiiv is a New York-based digital platform that enables users to write, monetize and distribute newsletters.