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 Automation Journeys API

The Automation Journeys API from beehiiv — 2 operation(s) for automation journeys.

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

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

3 operations 2 paths 12 schemas 2 GET1 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 Automation Journeys API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuthScheme).

Paths & Operations 3

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

Automation Journeys 3
POST
/publications/{publicationId}/automations/{automationId}/journeys
Add subscription to an automation OAuth Scope: automations:write
create 3 params body → 200400401404429500
GET
/publications/{publicationId}/automations/{automationId}/journeys
List automation journeys OAuth Scope: automations:read
index 6 params → 200400401404429500
GET
/publications/{publicationId}/automations/{automationId}/journeys/{automationJourneyId}
Get automation journey OAuth Scope: automations:read
show 4 params → 200400401404429500

Schemas 12

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

type__DoubleOptOverride
string
Override publication double-opt settings for this subscription.
type_automationJourneys_AutomationJourneysIndexResponse
object
5 properties 5 required
type__AutomationJourneyStatus
string
type_ids_PublicationId
string
The prefixed ID of the publication.
type_automationJourneys_AutomationJourneysGetRequestStatus
string
type__Error
object
The top level error response.
3 properties 3 required
type_ids_SubscriptionId
string
The prefixed ID of the subscription.
type__AutomationJourney
object
A subscribers' journey through an automation flow.
7 properties 3 required
type__ErrorDetail
object
2 properties 2 required
type_ids_AutomationJourneyId
string
The prefixed ID of the automation journey.
type_ids_AutomationId
string
The prefixed ID of the automation.
type_automationJourneys_AutomationJourneysResponse
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

beehiiv-automation-journeys-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 Automations API
beehiiv Bulk Subscription Updates API
beehiiv Bulk Subscriptions API
beehiiv Complimentary Access API
beehiiv Condition Sets API
Where this information came from

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