beehiiv Posts API is one of 30 APIs that beehiiv publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.
This API exposes 2 JSON Schema definitions.
Tagged areas include Posts. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, and 2 JSON Schemas.
This API exposes
8 operations
across 5 paths,
and defines 89 schemas.
It is described by OpenAPI 3.2.0, at version 1.0.0.
Requests are made against a single base URL, https://api.beehiiv.com/v2.
The identity and technical contract details declared by the specification.
type__PostClickStatsWeb
object
Stats scoped only to web views. Not relevant for posts published only to email
3 properties
type_posts_ColumnVerticalAlignment
string
type_ids_ExternalRssFeedId
string
The prefixed ID of the external RSS feed.
type_posts_PostEmailCaptureTypeOverride
string
type_posts_BorderStyle
string
type_posts_ColumnPosition
string
type_posts_ReferralCondition
string
type__PostEmailRecipientsResponse
object
3 properties
type_posts_PostsListResponse
object
5 properties
5 required
type_posts_PostsCreateResponse
object
1 property
1 required
type__PostRecipientsResponse
object
The targeting configuration currently set on the post.
2 properties
type_posts_VisualSettings
object
24 properties
type__PremiumPostContent
object
The requested premium post HTML. This HTML does not have paywalls enforced.
2 properties
type_posts_PostEmailRecipients
object
3 properties
type__PostCreate
object
2 properties
1 required
type_posts_HeadingLevel
string
The level of the header.
type__ErrorDetail
object
2 properties
2 required
type_posts_PostEmailSettings
object
10 properties
type_posts_ConditionSetOperator
string
How multiple condition sets are combined when evaluating dynamic content targeting.
type_posts_PostWebSettings
object
7 properties
type_posts_RssCtaStyle
string
The style of the call to action.
type_posts_PostMetadata
object
6 properties
type_ids_SubscriptionId
string
The prefixed ID of the subscription.
type_posts_PostsDeleteResponse
object
type_posts_PostPlatformFilter
string
type_ids_TierId
string
The prefixed ID of the tier.
type_posts_PostRecipients
object
Controls who receives the post. If omitted entirely, defaults to free tier only on both web and email. If a channel key (web or email) is provided but empty, n…
2 properties
2 required
type_posts_PostSocialShare
string
type__PostProcessingState
string
The background creation state of the post.
type__FreePostContent
object
The requested free post HTML. This HTML has paywalls enforced.
3 properties
type__PostPlatform
string
The platform that the post is or will be published to.
type_posts_ColumnBlock
object
4 properties
1 required
type__PostStatsWeb
object
Stats scoped only to web views. Not relevant for posts published only to email
2 properties
type_posts_PostExpandField
string
type_posts_PostsPreviewResponse
object
1 property
1 required
type_posts_SectionableBlock
A block that can appear inside a section. Excludes section and columns (TipTap's schema does not allow nested sections).
type_ids_PostId
string
The prefixed ID of the post.
type_ids_PollId
string
The prefixed ID of the poll.
type_ids_PublicationId
string
The prefixed ID of the publication.
type__ClickStats
object
Details about specific URL's click stats from a post.
7 properties
type_posts_PostsAggregateStatsResponseStats
object
1 property
1 required
type_posts_ParagraphBlockTextSection
object
5 properties
1 required
type_posts_PostPublishStatus
string
type_ids_PostTemplateId
string
The prefixed ID of the post template.
type__PostStatsEmail
object
Stats scoped only to email recipients. Not relevant for posts published only to web
12 properties
type_ids_PaywallId
string
The prefixed ID of the paywall.
type__Error
object
The top level error response.
3 properties
3 required
type_posts_ParagraphBlockTextStyle
string
Inline formatting to apply to a formatted text section. strikethrough renders as a strike mark.
type_posts_ContentMergeStrategy
string
Controls how provided blocks interact with the post's existing content on update.
type_posts_PostsGetResponse
object
1 property
1 required
type__PostStatus
string
The status of the post. draft - not been scheduled. confirmed - The post will be active after the scheduledat. archived - The post is no longer active.
type_posts_PostsPreviewData
object
1 property
1 required
type_posts_PostStatusFilter
string
type_posts_PostsTestSendResponse
object
1 property
1 required
type_posts_RssThumbnailPosition
string
The position of the thumbnail.
type_posts_AutomatedAdvertisementKind
string
type_ids_TeamAuthorId
string
The prefixed ID of the team author (platform user).
type_posts_ListBlockItem
A list item as either plain text or formatted text data.
type_posts_RssCtaAlignment
string
The alignment of the call to action.
type_ids_GuestAuthorId
string
The prefixed ID of the guest author.
type_posts_Block
A block in the post content.
type__PostAudience
string
The audience that the post is available to on the web. Only applicable if the platform is web or both.
type_posts_RssSelectionMode
string
How feed articles are selected, by count or time window.
type__Post
object
31 properties
18 required
type_posts_PostsAggregateStatsResponse
object
1 property
1 required
type_posts_PostOrderBy
string
type_ids_PriceId
string
The prefixed ID of the price.
type_ids_SegmentId
string
The prefixed ID of the segment.
type_posts_QuoteVariant
string
The variant of the quote block.
type__PostStats
object
Optional list of stats for a post. Retrievable by including expand: [stats] in the post request body. Note: If a timeout occurs while aggregating stats, subseq…
4 properties
type_posts_PostsListRequestHiddenFromFeed
string
type_posts_Sizes
string
The sizes of the button.
type_posts_Link
object
2 properties
1 required
type_posts_RssBlockLayout
string
The layout of the articles from the feed.
type_posts_TextAlignment
string
The text alignment of the content.
type_posts_ListBlockItemData
object
2 properties
type_posts_PostsTestSendData
object
2 properties
1 required
type_posts_PostWebRecipients
object
3 properties
type_posts_PostAudienceFilter
string
type__RequestDirection
string
The direction of the request. Defaults to asc.
type_posts_EmbeddableBlocks
A block in the post content that can be embedded within a column.
type__PostContent
object
Optional html content for a post. Retrievable by including any of expand: [freewebcontent, freeemailcontent, freersscontent, premiumwebcontent, premiumemailcon…
2 properties
type__PostProcessing
object
Returned when a Send API post is still being created in the background.
3 properties
3 required
type__PostClickStatsEmail
object
URL stats scoped only to email recipients. Not relevant for posts published only to web
5 properties
type_posts_VisibilitySettings
object
9 properties
type_posts_ListType
string
The type of list (e.g., ordered, unordered).
type_posts_TableCellData
object
5 properties
type__PostWebRecipientsResponse
object
3 properties
type__PostProcessingData
object
2 properties
2 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs beehiiv publishes across the network.
