beehiiv

beehiiv Segments API

The Segments API from beehiiv — 5 operation(s) for segments.

GitHub OpenAPI
Business capability
Customer Segmentation Management BC-420.20

Operations 7

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /publications/{publicationId}/segments Create a subscriber segment · Create segment #
Ask an LLM
“How do I build a segment from a list of email addresses?”
“Can I create a dynamic segment that filters subscribers by custom field values?”
Tell an agent
Create a segment named {name} on publication {publication} from {input}.
Build a new segment called {name} using this input: {input}.
GET /publications/{publicationId}/segments List a publication's segments · List segments OAuth Scope: segments:read #
Ask an LLM
“What subscriber segments have I built?”
“Can I filter segments by type, like only manual or dynamic ones?”
Tell an agent
List segments on publication {publication}.
Show {type} segments on {publication}.
GET /publications/{publicationId}/segments/{segmentId} Get one segment · Get segment OAuth Scope: segments:read #
Ask an LLM
“What is the status and size of a specific segment?”
“Can I look up a single segment by its ID?”
Tell an agent
Get segment {segment} on publication {publication}.
Show the status and size of segment {segment} with {expand} expanded.
DELETE /publications/{publicationId}/segments/{segmentId} Delete a segment · Delete segment OAuth Scope: segments:write #
Ask an LLM
“How do I remove a segment I no longer need?”
“Does deleting a segment unsubscribe the people in it?”
Tell an agent destructive · confirm first
Delete segment {segment} from publication {publication}.
Remove segment {segment} without affecting its subscribers.
PUT /publications/{publicationId}/segments/{segmentId}/recalculate Recalculate a segment · Recalculate segment OAuth Scope: segments:write #
Ask an LLM
“How do I refresh a segment so it reflects current subscriber data?”
“Can I force a segment's membership to be recomputed?”
Tell an agent
Recalculate segment {segment} on publication {publication}.
Refresh the membership of segment {segment}.
GET /publications/{publicationId}/segments/{segmentId}/members List a segment's subscribers with full details · List segment subscribers OAuth Scope: segments:read #
Ask an LLM
“Who is in a segment, with their full subscriber profiles?”
“Can I get segment members along with their custom fields and tags?”
Tell an agent
List the full subscriber records in segment {segment} on publication {publication}.
Show the members of segment {segment} with {expand} included.
GET /publications/{publicationId}/segments/{segmentId}/results List only the subscriber IDs in a segment · List segment subscriber IDs OAuth Scope: segments:read #
Ask an LLM
“Is there a lightweight way to get just the subscription IDs in a segment?”
“How can I count a segment's members without pulling full profiles?”
Tell an agent
Get just the subscription IDs in segment {segment} on {publication}.
Count the subscribers in segment {segment} using only their IDs.

Documentation

📖
Documentation
https://developers.beehiiv.com/api-reference/publications
📖
Documentation
https://developers.beehiiv.com/api-reference/subscriptions
📖
Documentation
https://developers.beehiiv.com/api-reference/posts
📖
Documentation
https://developers.beehiiv.com/api-reference/automations
📖
Documentation
https://developers.beehiiv.com/api-reference/custom_fields
📖
Documentation
https://developers.beehiiv.com/api-reference/segments
📖
Documentation
https://developers.beehiiv.com/api-reference/tiers
📖
Documentation
https://developers.beehiiv.com/api-reference/polls
📖
Documentation
https://developers.beehiiv.com/api-reference/webhooks
📖
Documentation
https://developers.beehiiv.com/api-reference

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/beehiiv/refs/heads/main/openapi/beehiiv-segments-api-openapi.yml
⚙
AsyncAPI
https://raw.githubusercontent.com/api-evangelist/beehiiv/refs/heads/main/asyncapi/beehiiv-asyncapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/beehiiv/refs/heads/main/json-schema/beehiiv-subscription-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/beehiiv/refs/heads/main/json-schema/beehiiv-post-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/beehiiv:beehiiv-segments-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

beehiiv-segments-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Reference Segments API
  version: 1.0.0
servers:
- url: https://api.beehiiv.com/v2
  description: Default
tags:


# --- truncated at 32 KB (40 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/beehiiv/refs/heads/main/openapi/beehiiv-segments-api-openapi.yml