How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
beehiiv

beehiiv Newsletter List Subscriptions API

The Newsletter List Subscriptions API from beehiiv — 3 operation(s) for newsletter list subscriptions.

Documentation Provider Profile APIs.io OpenAPI GitHub

beehiiv Newsletter List Subscriptions 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 Newsletter List Subscriptions. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, and 2 JSON Schemas.

This API exposes 5 operations across 3 paths, and defines 11 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.

5 operations 3 paths 11 schemas 2 GET2 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.beehiiv.com/v2
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

beehiiv Newsletter List Subscriptions API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuthScheme).

Paths & Operations 5

Across 3 paths, the API surfaces 5 operations — 2 GET, 2 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Newsletter List Subscriptions 5
POST
/publications/{publicationId}/newsletter_lists/{newsletterListId}/subscriptions
Create newsletter list subscription OAuth Scope: newsletterlists:write
create 3 params body → 200400401404422429500
GET
/publications/{publicationId}/newsletter_lists/{newsletterListId}/subscriptions
List newsletter list subscriptions OAuth Scope: newsletterlists:read
index 7 params → 200400401404429500
GET
/publications/{publicationId}/newsletter_lists/{newsletterListId}/subscriptions/{newsletterListSubscriptionId}
Get newsletter list subscription OAuth Scope: newsletterlists:read
show 4 params → 200400401404429500
PATCH
/publications/{publicationId}/newsletter_lists/{newsletterListId}/subscriptions/{newsletterListSubscriptionId}
Update newsletter list subscription OAuth Scope: newsletterlists:write
update 4 params body → 200400401404422429500
PATCH
/publications/{publicationId}/newsletter_lists/{newsletterListId}/subscriptions/by_subscription_id/{subscriptionId}
Update newsletter list subscription by subscription ID OAuth Scope: newsletterlists:write
update-by-subscription-id 4 params body → 200400401404422429500

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are type_newsletterListSubscriptions_NewsletterListSubscriptionInfo (7 properties), type_newsletterListSubscriptions_NewsletterListSubscriptionIndexResponse (5 properties), type__Error (3 properties), type__ErrorDetail (2 properties). Each schema is shown below with its type and property counts.

type_newsletterListSubscriptions_NewsletterListSubscriptionResponse
object
1 property 1 required
type_newsletterListSubscriptions_NewsletterListSubscriptionIndexResponse
object
5 properties 1 required
type_ids_PublicationId
string
The prefixed ID of the publication.
type__Error
object
The top level error response.
3 properties 3 required
type__RequestDirection
string
The direction of the request. Defaults to asc.
type_ids_NewsletterListId
string
The prefixed ID of the newsletter list.
type_ids_NewsletterListSubscriptionId
string
The prefixed ID of the newsletter list subscription.
type_ids_SubscriptionId
string
The prefixed ID of the subscription.
type__ErrorDetail
object
2 properties 2 required
type_newsletterListSubscriptions_NewsletterListSubscriptionInfo
object
7 properties 5 required
type_newsletterListSubscriptions_NewsletterListSubscriptionStatus
string
The status of the newsletter list subscription.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

beehiiv-newsletter-list-subscriptions-api-openapi.yml Raw ↑

Other APIs beehiiv publishes across the network.

beehiiv Authorizations API
AE Profile APIs.io
beehiiv Tokens API
AE Profile APIs.io
beehiiv Webhooks API
AE Profile APIs.io
beehiiv Ad Network Offers API
AE Profile APIs.io
beehiiv Ad Network Reports API
AE Profile APIs.io
beehiiv Advertisement Opportunities API
AE Profile APIs.io
beehiiv Authors API
AE Profile APIs.io
beehiiv Automation Journeys API
AE Profile APIs.io
beehiiv Automations API
AE Profile APIs.io
beehiiv Bulk Subscription Updates API
AE Profile APIs.io
beehiiv Bulk Subscriptions API
AE Profile APIs.io
beehiiv Complimentary Access API
AE Profile APIs.io
#Newsletter List Subscriptions
← Back to B APIs
API Details
ID
beehiiv:beehiiv-newsletter-list-subscriptions-api
Base URL
https://api.beehiiv.com/v2
Docs
https://developers.beehiiv.com/api-reference/publications
Provider
beehiiv
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=beehiiv-newsletter-list-subscriptions-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/beehiiv-newsletter-list-subscriptions-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of beehiiv Newsletter List Subscriptions API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.