Get post template OAuth Scope: posts:read

GET

https://api.beehiiv.com/v2/publications/:publicationId/post_templates/:postTemplateId

GET

/v2/publications/:publicationId/post_templates/:postTemplateId

curl https://api.beehiiv.com/v2/publications/pub_00000000-0000-0000-0000-000000000000/post_templates/post_template_00000000-0000-0000-0000-000000000000 \
     -H "Authorization: Bearer <token>"

{
  "data": {
    "id": "post_template_00000000-0000-0000-0000-000000000000",
    "name": "Newsletter Template",
    "created": 1666800000,
    "updated": 1666800000,
    "authors": [],
    "content_tags": [],
    "email_settings": {
      "display_title_in_email": true,
      "display_byline_in_email": false,
      "display_subtitle_in_email": true,
      "email_header_engagement_buttons": null,
      "email_header_social_share": null,
      "email_preview_text": null,
      "email_subject_line": null,
      "from_address": "[email protected]",
      "reply_to_address": null,
      "sender_name": null
    },
    "web_settings": {
      "title": null,
      "subtitle": null,
      "display_title_on_web": true,
      "display_subtitle_on_web": true,
      "display_thumbnail_on_web": false,
      "paywall_id": null,
      "paywall_break_price_id": null
    },
    "description": "The weekly roundup layout",
    "thumbnail_url": null,
    "newsletter_list_id": null,
    "headers": null,
    "utm_source": null,
    "utm_medium": null,
    "utm_campaign": null,
    "utm_params_enabled": null
  }
}

Retrieve a single post template, including the settings posts built from it start with and, on request, its rendered HTML.

Authentication

AuthorizationBearer

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

Path parameters

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

The prefixed ID of the publication object

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

The prefixed ID of the post template object

Query parameters

expandlist of enumsOptional

Optionally expand the result by adding the rendered HTML of the template.
free_web_content - Adds the web HTML rendered to a free reader.
free_email_content - Adds the email HTML rendered to a free reader.
free_rss_content - Adds the RSS feed HTML.
premium_web_content - Adds the web HTML rendered to a premium reader.
premium_email_content - Adds the email HTML rendered to a premium reader.

Optionally expand the result by adding the rendered HTML of the template. `free_web_content` - Adds the web HTML rendered to a free reader. `free_email_content` - Adds the email HTML rendered to a free reader. `free_rss_content` - Adds the RSS feed HTML. `premium_web_content` - Adds the web HTML rendered to a premium reader. `premium_email_content` - Adds the email HTML rendered to a premium reader.

Allowed values:

Response

dataobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error