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 Complimentary Access API

The Complimentary Access API from beehiiv — 2 operation(s) for complimentary access.

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

This API exposes 2 operations across 2 paths, and defines 17 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.

2 operations 2 paths 17 schemas 2 GET

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 Complimentary Access API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuthScheme).

Paths & Operations 2

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

Complimentary Access 2
GET
/publications/{publicationId}/complimentary_access
List complimentary access OAuth Scope: complimentaryaccess:read
index 5 params → 200400401404429500
GET
/publications/{publicationId}/complimentary_access/{complimentaryAccessId}
Get complimentary access OAuth Scope: complimentaryaccess:read
show 4 params → 200400401404429500

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are type_tiers_TierPrice (8 properties), type_complimentaryAccess_ComplimentaryAccess (7 properties), type_tiers_Tier (6 properties), type_complimentaryAccess_IndexComplimentaryAccessResponse (5 properties). Each schema is shown below with its type and property counts.

type_tiers_TierPriceCurrency
string
type_tiers_TierStatus
string
Returns whether or not the tier has any active prices.
type_complimentaryAccess_ComplimentaryAccessStats
object
Optional stats for a complimentary access object. Retrievable by including expand: [stats] in the request.
2 properties 2 required
type_ids_PublicationId
string
The prefixed ID of the publication.
type_ids_PriceId
string
The prefixed ID of the price.
type__Error
object
The top level error response.
3 properties 3 required
type_ids_ComplimentaryAccessId
string
The prefixed ID of the complimentary access object.
type_complimentaryAccess_IndexComplimentaryAccessResponse
object
5 properties 1 required
type_complimentaryAccess_ComplimentaryAccess
object
The complimentary access object.
7 properties 3 required
type_tiers_TierStats
object
Optional list of stats for a tier. Retrievable by including expand: [stats] in the tier request body.
1 property 1 required
type__ErrorDetail
object
2 properties 2 required
type_tiers_TierPrice
object
Price belonging to a Tier
8 properties
type_tiers_TierPriceInterval
string
type_complimentaryAccess_ComplimentaryAccessTimeUnit
string
The unit of time for the gift duration. days - Duration in days. months - Duration in months. years - Duration in years. forever - Lifetime access with no expi…
type_complimentaryAccess_ComplimentaryAccessResponse
object
1 property
type_tiers_Tier
object
The subscription tier object.
6 properties 3 required
type_ids_TierId
string
The prefixed ID of the tier.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

beehiiv-complimentary-access-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 Condition Sets API
Where this information came from

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