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

beehiiv Newsletter Lists API

The Newsletter Lists API from beehiiv — 2 operation(s) for newsletter lists.

beehiiv Newsletter Lists 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 Lists. 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 2 paths, and defines 10 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 2 paths 10 schemas 1 DELETE2 GET1 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 Lists API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuthScheme).

Paths & Operations 5

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

Newsletter Lists 5
GET
/publications/{publicationId}/newsletter_lists
List newsletter lists OAuth Scope: newsletterlists:read
index 5 params → 200400401404429500
POST
/publications/{publicationId}/newsletter_lists
Create newsletter list OAuth Scope: newsletterlists:write
create 2 params body → 201400401404422429500
GET
/publications/{publicationId}/newsletter_lists/{newsletterListId}
Get newsletter list OAuth Scope: newsletterlists:read
show 3 params → 200400401404429500
PATCH
/publications/{publicationId}/newsletter_lists/{newsletterListId}
Update newsletter list OAuth Scope: newsletterlists:write
update 3 params body → 200400401404422429500
DELETE
/publications/{publicationId}/newsletter_lists/{newsletterListId}
Delete newsletter list OAuth Scope: newsletterlists:write
delete 3 params → 200401404429500

Schemas 10

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

type_newsletterLists_NewsletterListStatus
string
The status of the newsletter list.
type_ids_PublicationId
string
The prefixed ID of the publication.
type_newsletterLists_NewsletterListInfo
object
9 properties 8 required
type_newsletterLists_NewsletterListWritableStatus
string
Valid status values when updating a newsletter list. draft is not permitted.
type__Error
object
The top level error response.
3 properties 3 required
type_ids_NewsletterListId
string
The prefixed ID of the newsletter list.
type__RequestDirection
string
The direction of the request. Defaults to asc.
type_newsletterLists_NewsletterListIndexResponse
object
5 properties 5 required
type_newsletterLists_NewsletterListResponse
object
1 property 1 required
type__ErrorDetail
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

beehiiv-newsletter-lists-api-openapi.yml Raw ↑

Other APIs beehiiv publishes across the network.

beehiiv Authorizations API
beehiiv Tokens API
beehiiv Webhooks API
beehiiv Ad Network Offers API
beehiiv Ad Network Reports API
beehiiv Advertisement Opportunities API
beehiiv Authors API
beehiiv Automation Journeys API
beehiiv Automations API
beehiiv Bulk Subscription Updates API
beehiiv Bulk Subscriptions API
beehiiv Complimentary Access API
Where this information came from

This is an independent, third-party profile of beehiiv Newsletter Lists 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.