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 Referral Program API

The Referral Program API from beehiiv — 1 operation(s) for referral program.

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

This API exposes 1 operation across 1 path, and defines 9 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.

1 operations 1 paths 9 schemas 1 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 Referral Program API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuthScheme).

Paths & Operations 1

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

Referral Program 1
GET
/publications/{publicationId}/referral_program
Get referral program OAuth Scope: referralprogram:read
show 4 params → 200400401404429500

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are type__MilestoneReward (5 properties), type_referralProgram_ReferralProgramGetResponse (5 properties), type__Milestone (4 properties), type__Error (3 properties). Each schema is shown below with its type and property counts.

type_ids_PublicationId
string
The prefixed ID of the publication.
type_referralProgram_ReferralProgramGetResponse
object
5 properties 5 required
type_ids_RewardId
string
The prefixed ID of the reward.
type__Error
object
The top level error response.
3 properties 3 required
type__Milestone
object
The milestone object.
4 properties 4 required
type_ids_MilestoneId
string
The prefixed ID of the milestone.
type__ErrorDetail
object
2 properties 2 required
type__MilestoneRewardType
string
What type of reward this is. physical - A product which must be sent to the subscriber. promocode - A code that is redeemable for goods or services.
type__MilestoneReward
object
The reward object.
5 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

beehiiv-referral-program-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 Referral Program 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.