# Beehiiv API API

> Beehiiv API API on Apizie: 47 endpoints (Index, Show, Index, Show, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/open-data:beehiiv/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `open-data:beehiiv`
- Category: Open Data
- Status: byok
- Source: https://beehiiv.com
- Page: https://apizie.tech/api/open-data/beehiiv
- OpenAPI: https://apizie.tech/api/open-data/beehiiv/openapi.json

Swarm public API

## Endpoints

### Index
`GET https://apizie.tech/v1/open-data:beehiiv/publications-get-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| expand[] | array | no | Optional list of expandable objects. `stats` - Returns all statistics about the publication(s) `stat_active_subscriptions` - Total number… |
| limit | integer | no | A limit on the number of objects to be returned. The limit can range between 1 and 100, and the default is 10. |
| page | integer | no | Pagination returns the results in pages. Each page contains the number of results specified by the `limit` (default: 10). If not… |
| direction | string | no | The direction that the results are sorted in. Defaults to asc `asc` - Ascending, sorts from smallest to largest. `desc` - Descending,… |
| order_by | string | no | The field that the results are sorted by. Defaults to created `created` - The time in which the publication was first created. `name` -… |

### Show
`GET https://apizie.tech/v1/open-data:beehiiv/publications-get-single` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| publicationId | string | yes | The prefixed ID of the publication object |
| expand[] | array | no | Optional list of expandable objects. `stats` - Returns all statistics about the publication(s) `stat_active_subscriptions` - Total number… |

### Index
`GET https://apizie.tech/v1/open-data:beehiiv/posts-get-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| publicationId | string | yes | The prefixed ID of the publication object |
| expand[] | array | no | Optional list of expandable objects. `stats` - Returns statistics about the post(s) `free_web_content` - Returns the web HTML rendered to… |
| audience | string | no | Optionally filter the results by audience |
| platform | string | no | Optionally filter the results by platform. `web` - Posts only published to web. `email` - Posts only published to email. `both` - Posts… |
| status | string | no | Optionally filter the results by the status of the post. `draft` - not been scheduled. `confirmed` - The post will be active after the… |
| content_tags[] | array | no | Optionally filter posts by content_tags. Adding a content tag will return any post with that content tag associated to it. Example:… |
| limit | integer | no | A limit on the number of objects to be returned. The limit can range between 1 and 100, and the default is 10. |
| page | integer | no | Pagination returns the results in pages. Each page contains the number of results specified by the `limit` (default: 10). If not… |
| order_by | string | no | The field that the results are sorted by. Defaults to created `created` - The time in which the post was first created. `publish_date` -… |
| direction | string | no | The direction that the results are sorted in. Defaults to asc `asc` - Ascending, sorts from smallest to largest. `desc` - Descending,… |
| hidden_from_feed | string | no | Optionally filter the results by the `hidden_from_feed` attribute of the post. `all` - Does not restrict results by `hidden_from_feed`.… |

### Show
`GET https://apizie.tech/v1/open-data:beehiiv/posts-get-single` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| postId | string | yes | The prefixed ID of the post object |
| publicationId | string | yes | The prefixed ID of the publication object |
| expand[] | array | no | Optional list of expandable objects. `stats` - Returns statistics about the post(s) `free_web_content` - Returns the web HTML rendered to… |

### Destroy
`POST https://apizie.tech/v1/open-data:beehiiv/posts-destroy-post` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| postId | string | yes | The prefixed ID of the post object |
| publicationId | string | yes | The prefixed ID of the publication object |

### Index
`GET https://apizie.tech/v1/open-data:beehiiv/subscriptions-get-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| publicationId | string | yes | The prefixed ID of the publication object |
| expand[] | array | no | Optional list of expandable objects. `subscription_premium_tiers ` - Returns an array of tiers the subscription is associated with.… |
| status | string | no | Optionally filter the results by a status |
| tier | string | no | Optionally filter the results by a their tier |
| premium_tiers[] | array | no | Optionally filter the results by one or multiple premium tiers |
| premium_tier_ids[] | array | no | Optionally filter the results by one or multiple premium tier ids |
| limit | integer | no | A limit on the number of objects to be returned. The limit can range between 1 and 100, and the default is 10. |
| page | integer | no | Pagination returns the results in pages. Each page contains the number of results specified by the `limit` (default: 10). If not… |
| email | string | no | Optional email address to find a subscription. This param must be an exact match and is case insensitive. |
| order_by | string | no | The field that the results are sorted by. Defaults to created `created` - The time in which the subscription was first created. `email` -… |
| direction | string | no | The direction that the results are sorted in. Defaults to asc `asc` - Ascending, sorts from smallest to largest. `desc` - Descending,… |

### Create
`POST https://apizie.tech/v1/open-data:beehiiv/subscriptions-create-new` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| publicationId | string | yes | The prefixed ID of the publication object |
| body | object | yes | JSON request body |

### Bulk Update Status
`POST https://apizie.tech/v1/open-data:beehiiv/subscriptions-bulk-update-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| publicationId | string | yes | The prefixed ID of the publication object |
| body | object | no | JSON request body |

### Bulk Update Status
`POST https://apizie.tech/v1/open-data:beehiiv/subscriptions-bulk-update-status-2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| publicationId | string | yes | The prefixed ID of the publication object |
| body | object | no | JSON request body |

### Show
`GET https://apizie.tech/v1/open-data:beehiiv/subscriptions-get-single` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subscriptionId | string | yes | The prefixed ID of the subscription object |
| publicationId | string | yes | The prefixed ID of the publication object |
| expand[] | array | no | Optional list of expandable objects. `subscription_premium_tiers ` - Returns an array of tiers the subscription is associated with.… |

### Update
`POST https://apizie.tech/v1/open-data:beehiiv/subscriptions-update-subscriber` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subscriptionId | string | yes | The prefixed ID of the subscription object |
| publicationId | string | yes | The prefixed ID of the publication object |
| body | object | yes | JSON request body |

### Update
`POST https://apizie.tech/v1/open-data:beehiiv/subscriptions-update-subscriber-2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subscriptionId | string | yes | The prefixed ID of the subscription object |
| publicationId | string | yes | The prefixed ID of the publication object |
| body | object | yes | JSON request body |

### Delete
`POST https://apizie.tech/v1/open-data:beehiiv/subscriptions-delete-subscription` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subscriptionId | string | yes | The prefixed ID of the subscription object |
| publicationId | string | yes | The prefixed ID of the publication object |

### Show
`GET https://apizie.tech/v1/open-data:beehiiv/subscriptions-show-single-by-subscriber-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| publicationId | string | yes | The prefixed ID of the publication object |
| subscriberId | string | yes | The ID of the subscriber object |
| expand[] | array | no | Optional list of expandable objects. `subscription_premium_tiers ` - Returns an array of tiers the subscription is associated with.… |

### Show
`GET https://apizie.tech/v1/open-data:beehiiv/subscriptions-get-single-by-email` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| publicationId | string | yes | The prefixed ID of the publication object |
| email | string | yes | The ID of the subscriber object |
| expand[] | array | no | Optional list of expandable objects. `subscription_premium_tiers ` - Returns an array of tiers the subscription is associated with.… |

### Bulk Update
`POST https://apizie.tech/v1/open-data:beehiiv/subscriptions-bulk-update-fields` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| publicationId | string | yes | The prefixed ID of the publication object |
| body | object | no | JSON request body |

### Bulk Update
`POST https://apizie.tech/v1/open-data:beehiiv/subscriptions-bulk-update-fields-2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| publicationId | string | yes | The prefixed ID of the publication object |
| body | object | no | JSON request body |

### Index
`GET https://apizie.tech/v1/open-data:beehiiv/segments-get-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| publicationId | string | yes | The prefixed ID of the publication object |
| type | string | no | Optionally filter the results by the segment's type. |
| status | string | no | Optionally filter the results by the segment's status. |
| limit | integer | no | A limit on the number of objects to be returned. The limit can range between 1 and 100, and the default is 10. |
| page | integer | no | Pagination returns the results in pages. Each page contains the number of results specified by the `limit` (default: 10). If not… |
| order_by | string | no | The field that the results are sorted by. Defaults to created `created` - The time in which the segment was first created.… |
| direction | string | no | The direction that the results are sorted in. Defaults to asc `asc` - Ascending, sorts from smallest to largest. `desc` - Descending,… |

### Show
`GET https://apizie.tech/v1/open-data:beehiiv/segments-get-single` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| publicationId | string | yes | The prefixed ID of the publication object |
| segmentId | string | yes | The prefixed ID of the segment object |

### Delete
`POST https://apizie.tech/v1/open-data:beehiiv/segments-delete-segment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| publicationId | string | yes | The prefixed ID of the publication object |
| segmentId | string | yes | The prefixed ID of the segment object |

### Expand Results
`GET https://apizie.tech/v1/open-data:beehiiv/segments-get-subscriber-ids` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| publicationId | string | yes | The prefixed ID of the publication object |
| segmentId | string | yes | The prefixed ID of the segment object |
| limit | integer | no | A limit on the number of objects to be returned. The limit can range between 1 and 100, and the default is 10. |
| page | integer | no | Pagination returns the results in pages. Each page contains the number of results specified by the `limit` (default: 10). If not… |

### Index
`GET https://apizie.tech/v1/open-data:beehiiv/email-blasts-get-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| publicationId | string | yes | The prefixed ID of the publication object |
| expand[] | array | no | Optional list of expandable objects. `stats` - Returns statistics about the email blast(s) `free_email_content` - Returns the email HTML… |
| limit | integer | no | A limit on the number of objects to be returned. The limit can range between 1 and 100, and the default is 10. |
| page | integer | no | Pagination returns the results in pages. Each page contains the number of results specified by the `limit` (default: 10). If not… |
| direction | string | no | The direction that the results are sorted in. Defaults to asc `asc` - Ascending, sorts from smallest to largest. `desc` - Descending,… |
| order_by | string | no | The field that the results are sorted by. Defaults to created `created` - The time in which the segment was first created. `last_sent` -… |

### Show
`GET https://apizie.tech/v1/open-data:beehiiv/email-blasts-get-email-blast` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| publicationId | string | yes | The prefixed ID of the publication object |
| emailBlastId | string | yes | The prefixed ID of the email blast object |
| expand[] | array | no | Optional list of expandable objects. `stats` - Returns statistics about the email blast(s) `free_email_content` - Returns the email HTML… |

### Show
`GET https://apizie.tech/v1/open-data:beehiiv/referral-program-details-retrieve` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| publicationId | string | yes | The prefixed ID of the publication object |
| limit | integer | no | A limit on the number of objects to be returned. The limit can range between 1 and 100, and the default is 10. |
| page | integer | no | Pagination returns the results in pages. Each page contains the number of results specified by the `limit` (default: 10). If not… |

### Index
`GET https://apizie.tech/v1/open-data:beehiiv/custom-fields-get-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| publicationId | string | yes | The prefixed ID of the publication object |

### Create
`POST https://apizie.tech/v1/open-data:beehiiv/custom-fields-create-publication-custom-field` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| publicationId | string | yes | The prefixed ID of the publication object |
| body | object | no | JSON request body |

### Show
`GET https://apizie.tech/v1/open-data:beehiiv/custom-fields-show-specific` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| publicationId | string | yes | The prefixed ID of the publication object |
| id | string | yes | The ID of the Custom Fields object |

### Update
`POST https://apizie.tech/v1/open-data:beehiiv/custom-fields-update-publication-custom-field` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| publicationId | string | yes | The prefixed ID of the publication object |
| id | string | yes | The ID of the Custom Fields object |
| body | object | no | JSON request body |

### Update
`POST https://apizie.tech/v1/open-data:beehiiv/custom-fields-update-publication-custom-field-2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| publicationId | string | yes | The prefixed ID of the publication object |
| id | string | yes | The ID of the Custom Fields object |
| body | object | no | JSON request body |

### Delete
`POST https://apizie.tech/v1/open-data:beehiiv/custom-fields-delete-publication-custom-field` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| publicationId | string | yes | The prefixed ID of the publication object |
| id | string | yes | The ID of the Custom Fields object |

### Index
`GET https://apizie.tech/v1/open-data:beehiiv/bulk-subscription-updates-list-subscription-updates` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| publicationId | string | yes | The prefixed ID of the publication object |

### Show
`GET https://apizie.tech/v1/open-data:beehiiv/bulk-subscription-updates-get-single-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| publicationId | string | yes | The prefixed ID of the publication object |
| id | string | yes | The ID of the Subscription Update object |

### Index
`GET https://apizie.tech/v1/open-data:beehiiv/automation-journeys-get-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| publicationId | string | yes | The prefixed ID of the publication object |
| automationId | string | yes | The prefixed ID of the automation object |
| status | string | no | Optionally filter the results by a status |
| limit | integer | no | A limit on the number of objects to be returned. The limit can range between 1 and 100, and the default is 10. |
| page | integer | no | Pagination returns the results in pages. Each page contains the number of results specified by the `limit` (default: 10). If not… |
| subscription_id | string | no | Optionally filter the results by a subscription id |
| email | string | no | Optionally filter the results by a subscription email address. This param must be an exact match and is case insensitive. |

### Create
`POST https://apizie.tech/v1/open-data:beehiiv/automation-journeys-add-existing-subscription` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| publicationId | string | yes | The prefixed ID of the publication object |
| automationId | string | yes | The prefixed ID of the automation object |
| body | object | no | JSON request body |

### Show
`GET https://apizie.tech/v1/open-data:beehiiv/automation-journeys-show-journey-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| publicationId | string | yes | The prefixed ID of the publication object |
| automationId | string | yes | The prefixed ID of the automation object |
| automationJourneyId | string | yes | The prefixed automation journey id |

### Index
`GET https://apizie.tech/v1/open-data:beehiiv/automations-index` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| publicationId | string | yes | The prefixed ID of the publication object |
| limit | integer | no | A limit on the number of objects to be returned. The limit can range between 1 and 100, and the default is 10. |
| page | integer | no | Pagination returns the results in pages. Each page contains the number of results specified by the `limit` (default: 10). If not… |

### Show
`GET https://apizie.tech/v1/open-data:beehiiv/automations-show-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| publicationId | string | yes | The prefixed ID of the publication object |
| automationId | string | yes | The prefixed ID of the automation object |

### Post
`POST https://apizie.tech/v1/open-data:beehiiv/subscription-tags-create-new` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| publicationId | string | yes |  |
| subscriptionId | string | yes |  |
| body | object | no | JSON request body |

### Index
`GET https://apizie.tech/v1/open-data:beehiiv/tiers-get-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| publicationId | string | yes | The prefixed ID of the publication object |
| expand[] | array | no | Optional list of expandable objects. `stats` - Returns statistics about the tier(s). `prices` - Returns prices for the tier(s). |
| limit | integer | no | A limit on the number of objects to be returned. The limit can range between 1 and 100, and the default is 10. |
| page | integer | no | Pagination returns the results in pages. Each page contains the number of results specified by the `limit` (default: 10). If not… |
| direction | string | no | The direction that the results are sorted in. Defaults to asc `asc` - Ascending, sorts from smallest to largest. `desc` - Descending,… |

### Create
`POST https://apizie.tech/v1/open-data:beehiiv/tiers-create-new-tier` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| publicationId | string | yes | The prefixed ID of the publication object |
| body | object | no | JSON request body |

### Show
`GET https://apizie.tech/v1/open-data:beehiiv/tiers-get-single-tier` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| publicationId | string | yes | The prefixed ID of the publication object |
| tierId | string | yes | The prefixed ID of the tier object |
| expand[] | array | no | Optional list of expandable objects. `stats` - Returns statistics about the tier(s). `prices` - Returns prices for the tier(s). |

### Update
`POST https://apizie.tech/v1/open-data:beehiiv/tiers-update-existing-tier` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| publicationId | string | yes | The prefixed ID of the publication object |
| tierId | string | yes | The prefixed ID of the tier object |
| body | object | no | JSON request body |

### Update
`POST https://apizie.tech/v1/open-data:beehiiv/tiers-update-existing-tier-2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| publicationId | string | yes | The prefixed ID of the publication object |
| tierId | string | yes | The prefixed ID of the tier object |
| body | object | no | JSON request body |

### Index
`GET https://apizie.tech/v1/open-data:beehiiv/webhooks-get-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| publicationId | string | yes | The prefixed ID of the publication object |
| limit | integer | no | A limit on the number of objects to be returned. The limit can range between 1 and 100, and the default is 10. |

### Create
`POST https://apizie.tech/v1/open-data:beehiiv/webhooks-create-new-webhook` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| publicationId | string | yes | The prefixed ID of the publication object |
| body | object | no | JSON request body |

### Show
`GET https://apizie.tech/v1/open-data:beehiiv/webhooks-get-specific` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| publicationId | string | yes | The prefixed ID of the publication object |
| webhookId | string | yes | The prefixed ID of the webhook object |

### Delete
`POST https://apizie.tech/v1/open-data:beehiiv/webhooks-delete-subscription` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| publicationId | string | yes | The prefixed ID of the publication object |
| webhookId | string | yes | The prefixed ID of the webhook object |

## Example
```
curl "https://apizie.tech/v1/open-data:beehiiv/publications-get-all" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Beehiiv API API?
Create a free Apizie key, then send GET https://apizie.tech/v1/open-data:beehiiv/publications-get-all with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Beehiiv API API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Beehiiv API itself also needs your own key from api.beehiiv.com.

### Can AI agents use the Beehiiv API API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key open-data:beehiiv.

### What is the status of the Beehiiv API API?
Needs your own provider key (bring your own key)