beehiiv Workspaces 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 Workspaces. 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 36 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 operations3 paths36 schemas3 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 Workspaces 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.
workspaces 3
GET
/workspaces/identify
Identify workspace OAuth Scope: identify:read
identify1 param→ 200401403404429500
GET
/workspaces/permissions
Get workspace permissions OAuth Scope: identify:read
The contract defines 36 schemas that model the data the API accepts and returns. The most detailed are type__Subscription (19 properties), type__PublicationStats (8 properties), type_workspaces_PublicationsBySubscriptionEmailResponseItem (6 properties), type__Publication (6 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__ActivePremiumSubscriptionCount
Total number of active premium/paid subscriptions
type_workspaces_WorkspaceIdentity
object
3 properties3 required
type__SubscriptionCustomFieldList
array
Optional list of custom fields for a subscription. Retrievable by including expand: [customfield] in the request body.
type__ActiveFreeSubscriptionCount
Total number of active free subscriptions
type__SubscriptionTierList
array
Optional list of tiers for a subscription. Retrievable by including expand: [subscriptionpremiumtiers] in the request body.
type__Error
object
The top level error response.
3 properties3 required
type__SubscriptionTierInfoStatus
string
Returns whether or not the tier has any active prices.
type_workspaces_WorkspaceIdentifyResponse
object
1 property1 required
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__Publication
object
6 properties5 required
type_ids_WorkspaceId
string
The prefixed ID of the workspace.
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_workspaces_PermissionAction
string
type__AverageOpenRate
The publications historical average open rate
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…
Optional list of stats for a publication. Retrievable by including an expand array in the publication request body. Add "stats" to the array to retrieve all, o…
8 properties
type_ids_PublicationId
string
The prefixed ID of the publication.
type_workspaces_WorkspacePermissions
object
A map of OAuth resources to the permission actions granted for each. Keys are resource names (e.g. posts, segments) and values are arrays of granted actions (r…
type_ids_SubscriptionId
string
The prefixed ID of the subscription.
type__ActiveSubscriptionCount
Total number of active free and premium subscriptions
type__TotalEmailsSent
Total number of emails sent
type__TotalClicks
The total number of links clicked from emails.
type_workspaces_WorkspacePermissionsResponse
object
1 property1 required
type__AverageClickRate
The publications historical average click through rate
type__TotalUniqueOpens
Total number of uniquely opened emails. Only counts the first open for each subscriber.
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 Workspaces 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.
