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 Automations API

The Automations API from beehiiv — 3 operation(s) for automations.

beehiiv Automations 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 Automations. 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 3 paths, and defines 19 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 3 paths 19 schemas 3 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 Automations API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuthScheme).

Paths & Operations 3

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

Automations 3
GET
/publications/{publicationId}/automations
List automations OAuth Scope: automations:read
index 5 params → 200400401404429500
GET
/publications/{publicationId}/automations/{automationId}
Get automation OAuth Scope: automations:read
show 4 params → 200400401404429500
GET
/publications/{publicationId}/automations/{automationId}/emails
List automation emails
list-emails 6 params → 200400401404429500

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are type_automations_AutomationEmailStatsEmail (10 properties), type__AutomationStatsEmail (10 properties), type_automations_AutomationEmail (9 properties), type_automations_AutomationEmailsListResponse (7 properties). Each schema is shown below with its type and property counts.

type_automations_AutomationsGetResponse
object
1 property
type__Error
object
The top level error response.
3 properties 3 required
type_automations_AutomationEmailStatsClicks
object
4 properties
type_automations_AutomationsListResponse
object
5 properties
type__AutomationStats
object
Optional statistics for an automation. Retrievable by including expand: [stats] in the automation request.
2 properties
type_automations_AutomationsGetRequestExpandItem
string
type__Automation
object
6 properties 4 required
type_automations_AutomationEmailsListResponse
object
7 properties 1 required
type_ids_AutomationId
string
The prefixed ID of the automation.
type__AutomationTriggerEvent
string
type__ErrorDetail
object
2 properties 2 required
type__AutomationStatsJourneys
object
Journey counts for an automation.
3 properties
type__AutomationStatus
string
type_ids_PublicationId
string
The prefixed ID of the publication.
type_automations_AutomationEmail
object
An email message within an automation.
9 properties 6 required
type_automations_AutomationEmailStatsEmail
object
Email engagement statistics for an automation email.
10 properties
type_automations_AutomationEmailStats
object
Statistics for an automation email message.
2 properties
type__AutomationStatsEmail
object
Aggregate email engagement statistics for an automation.
10 properties
type_automations_AutomationsListRequestExpandItem
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

beehiiv-automations-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 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 Automations 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.