beehiiv Segments 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 Segments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, and 2 JSON Schemas.
This API exposes
7 operations
across 5 paths,
and defines 37 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.
7 operations5 paths37 schemas1 DELETE4 GET1 POST1 PUT
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 Segments API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (BearerAuthScheme).
Paths & Operations 7
Across 5 paths, the API surfaces 7 operations — 1 DELETE, 4 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
List segment subscriber IDs OAuth Scope: segments:read
expand-results5 params→ 200400401404429500
Schemas 37
The contract defines 37 schemas that model the data the API accepts and returns. The most detailed are type__Subscription (19 properties), type__SegmentStats (14 properties), type__Segment (8 properties), type_segments_SegmentsGetResponse (5 properties). Each schema is shown below with its type and property counts.
type__CustomFieldType
string
The type of value being stored in the custom field.
type_segments_SegmentsGetResponse
object
5 properties5 required
type_segments_SegmentRequestStatus
string
type__Error
object
The top level error response.
3 properties3 required
type__SubscriptionCustomFieldList
array
Optional list of custom fields for a subscription. Retrievable by including expand: [customfield] in the request body.
type__SubscriptionTierList
array
Optional list of tiers for a subscription. Retrievable by including expand: [subscriptionpremiumtiers] in the request body.
type__SubscriptionTierInfoStatus
string
Returns whether or not the tier has any active prices.
type__SubscriptionTags
array
Optional list of tags for a subscription. Retrievable by including expand: [tags] in the request body. Max limit of 100 unique tags per publication.
type_segments_SegmentsListResponse
object
5 properties5 required
type__SubscriptionTierInfo
object
3 properties3 required
type__SubscriptionStats
object
Optional list of stats for a subscription. Retrievable by including expand: [stats] in the request body.
3 properties
type__RequestDirection
string
The direction of the request. Defaults to asc.
type_segments_SegmentRecalculateResponse
object
1 property
type_segments_SegmentDeleteResponse
object
1 property
type__SubscriptionExpandedStatus
string
The status of the subscription. validating - The email address is being validated. invalid - The email address is invalid. pending - The email address is valid…
type__CustomField
object
3 properties
type__CustomFieldDataType
type_segments_SegmentMembersResponse
object
5 properties5 required
type__SegmentType
string
The type of segment. dynamic - The segment is recalculated at set intervals. static - The segment is calculated once at creation. manual - The segment is not c…
type__SegmentStats
object
14 properties14 required
type_segments_SegmentShowResponse
object
1 property1 required
type__ErrorDetail
object
2 properties2 required
type_segments_SegmentsExpandItems
string
type__SubscriptionExpandedUtmChannel
string
The acquisition channel
type_segments_CustomFieldFilter
object
A single custom field filter condition.
3 properties2 required
type__SubscriptionExpandedSubscriptionTier
string
The current tier of the subscription.
type_segments_SegmentOrderBy
string
type_ids_PublicationId
string
The prefixed ID of the publication.
type_ids_SegmentId
string
The prefixed ID of the segment.
type_ids_SubscriptionId
string
The prefixed ID of the subscription.
type__SegmentStatus
string
The status of the segment's most recent calculation. pending - The segment has not been calculated yet. processing - The calculation is in progress, and has no…
type_segments_SegmentSubscriptionInput
Input for segment creation. Use subscriptions or emails to create a manual segment from explicit lists, or customfields to create a dynamic segment filtered by…
type__Segment
object
The segment object. To expand results, see the results endpoint.
8 properties6 required
type_segments_CustomFieldsLogicalOperator
string
type_segments_SegmentMembersExpandItems
string
type__Subscription
object
The subscription object
19 properties14 required
type_ids_TierId
string
The prefixed ID of the tier.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.
Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.
MCP tools for apis
4 tools reach this content
search_api_evangelistSearch every content type across the network at once.
find_relatedThe shared-tag relevance graph — what else covers this.
get_tagEverything one tag labels, across all content types.
guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
A second provider on the same verified email joins the account you already have.
Your account
ⓘWhere this information came from
This is an independent, third-party profile of beehiiv Segments 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.
