beehiiv Developer Documentation

[
  {
    "publication_id": "pub_00000000-0000-0000-0000-000000000000",
    "publication_name": "Publication Name 1",
    "subscription_id": "sub_00000000-0000-0000-0000-000000000000",
    "status": "active",
    "publication": {
      "id": "pub_00000000-0000-0000-0000-000000000000",
      "name": "Publication Name 1",
      "organization_name": "Organization Name",
      "referral_program_enabled": true,
      "created": 1234567890
    },
    "subscription": {
      "id": "sub_00000000-0000-0000-0000-000000000000",
      "email": "bruce.wayne@wayneenterprise.com",
      "status": "active",
      "created": 1234567890,
      "subscription_tier": "free",
      "subscription_premium_tier_names": [],
      "utm_source": "",
      "utm_medium": "",
      "utm_channel": "",
      "utm_campaign": "",
      "utm_term": "",
      "utm_content": "",
      "referring_site": "",
      "referral_code": "",
      "custom_fields": [
        {
          "name": "First Name",
          "kind": "string",
          "value": "Bruce"
        },
        {
          "name": "Last Name",
          "kind": "string",
          "value": "Wayne"
        }
      ]
    }
  }
]

Retrieve all publications in the workspace that have a subscription for the specified email address. The workspace is determined by the provided API key.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

emailstringRequired

The email address to search for subscriptions

Query parameters

expandlist of enumsOptional

Optionally expand the results by adding additional information.
subscription - Returns the full Subscription object for the email address in each publication.
publication - Returns the full Publication object instead of just ID and name.
subscription_custom_fields - Returns custom field values nested within the subscription object. (Returns the subscription object regardless of whether subscription is requested.)

Allowed values:

Response

publication_idstringformat: "^(pub_[0-9a-fA-F\-]+)$"

The prefixed ID of the publication

publication_namestring

The name of the publication

subscription_idstringformat: "^(sub_[0-9a-fA-F\-]+)$"

The prefixed ID of the subscription matching the email address for this publication

statusenum

The status of the subscription matching the email address for this publication

publicationobjectOptional

The full Publication object. Only present when expand includes publication.

subscriptionobjectOptional

The Subscription object matching the email address for this publication. Only present when expand includes subscription or subscription_custom_fields.

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error