BUbuttondown
Snippets

Retrieve Snippet

Changed on

Retrieve a single snippet.

get/snippets/{id}

Request

  • Base URL
    https://api.buttondown.com/v1
  • URL
    https://api.buttondown.com/v1/snippets/{id}
  • Auth
    API key in header Authorization

Path parameters

idstring required

Response

OK

idstring required

A unique TypeID associated with the object.

creation_datestring date-time required

The date and time at which the object was first created.

identifierstring required

A unique, newsletter-scoped slug used to reference the snippet inside email content (e.g. {{ snippets.footer }}). Must be unique per newsletter.

namestring required

A human-readable name for the snippet, shown in the Buttondown UI.

contentstring required

The body of the snippet, substituted wherever the snippet is referenced. Interpreted according to mode.

mode'fancy' | 'naked' | 'plaintext' required

An enumeration.

reference_countinteger

The number of emails that currently reference this snippet.

Changes