2.6 KiB
2.6 KiB
beehiiv Routing Reference
App name: beehiiv
Base URL proxied: api.beehiiv.com
API Path Pattern
/beehiiv/v2/{resource}
Common Endpoints
Publications
List Publications
GET /beehiiv/v2/publications
Get Publication
GET /beehiiv/v2/publications/{publication_id}
Subscriptions
List Subscriptions
GET /beehiiv/v2/publications/{publication_id}/subscriptions
Get Subscription by ID
GET /beehiiv/v2/publications/{publication_id}/subscriptions/{subscription_id}
Get Subscription by Email
GET /beehiiv/v2/publications/{publication_id}/subscriptions/by_email/{email}
Create Subscription
POST /beehiiv/v2/publications/{publication_id}/subscriptions
Content-Type: application/json
{
"email": "subscriber@example.com",
"utm_source": "api"
}
Update Subscription
PATCH /beehiiv/v2/publications/{publication_id}/subscriptions/{subscription_id}
Delete Subscription
DELETE /beehiiv/v2/publications/{publication_id}/subscriptions/{subscription_id}
Posts
List Posts
GET /beehiiv/v2/publications/{publication_id}/posts
Get Post
GET /beehiiv/v2/publications/{publication_id}/posts/{post_id}
Custom Fields
List Custom Fields
GET /beehiiv/v2/publications/{publication_id}/custom_fields
Create Custom Field
POST /beehiiv/v2/publications/{publication_id}/custom_fields
Segments
GET /beehiiv/v2/publications/{publication_id}/segments
GET /beehiiv/v2/publications/{publication_id}/segments/{segment_id}
Tiers
GET /beehiiv/v2/publications/{publication_id}/tiers
POST /beehiiv/v2/publications/{publication_id}/tiers
PATCH /beehiiv/v2/publications/{publication_id}/tiers/{tier_id}
Automations
GET /beehiiv/v2/publications/{publication_id}/automations
GET /beehiiv/v2/publications/{publication_id}/automations/{automation_id}
Pagination
Cursor-based (recommended) or page-based (deprecated):
# Cursor-based
GET /beehiiv/v2/publications/{pub_id}/subscriptions?limit=10&cursor={next_cursor}
# Page-based (max 100 pages)
GET /beehiiv/v2/publications?page=2&limit=10
Notes
- Publication IDs start with
pub_ - Subscription IDs start with
sub_ - Timestamps are Unix timestamps
- Cursor-based pagination is recommended
- Page-based pagination limited to 100 pages