email-templates

List email templates

Returns a paginated list of email templates, newest first.

The list covers both the workspace's own templates and our built-in system templates. Use scope to get only one of the two, or leave it out to get both. When you leave it out, the workspace's own templates come first, newest first, and our built-in templates fill the rest of the list once the workspace's templates run out.

Filter further by category or authoring format, or search with q, a case-insensitive substring match against the template's slug, name, and description.

Our built-in templates come in five visual themes. Each theme ships its own set of eight emails, and the sets overlap only partly. Use theme to see one of them. A template your workspace authored has no theme, so naming one returns our built-ins alone.

get/v1/email/templates

Request

  • Base URL: https://us1.platform.bird.com
  • URL: https://us1.platform.bird.com/v1/email/templates
  • Auth: one of:
    • HTTP bearer
    • API key in cookie bird_session

Query parameters

scope'system' | 'workspace'

Whether the template is one of our built-in templates (system) or one your workspace created (workspace).

Filter by who owns the template. Use system for our built-in templates and workspace for the ones your workspace created. Leave it out to get both.

category'transactional' | 'marketing'

Whether the template is for transactional email or marketing email.

Return only transactional or marketing templates; omit to return both categories.

sourcestring

The authoring format the template is written in, fixed at creation. html is finished markup you provide, optionally personalized with Liquid.

Return only templates authored in this format.

theme'arcane' | 'barebone' | 'matte' | 'protocol' | 'studio'

Filter by the visual theme a built-in template is designed in. Only built-in system templates have a theme, so naming one returns built-ins alone.

Filter by the visual theme a built-in template is designed in. Only our built-in templates have a theme, so naming one returns built-ins alone.

qstring

A case-insensitive substring search across the template's slug, name, and description.

limitinteger

Maximum number of items to return per page.

starting_afterstring

Cursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order.

ending_beforestring

Cursor from the prev_cursor or refresh_cursor field of a previous list response. Returns items immediately before the cursor position in the current sort order. prev_cursor returns the preceding page. refresh_cursor anchors at the first row of that response, which on a newest-first sort is how to fetch the items that have appeared since.

Headers

X-Workspace-Idstring

Workspace context for the request. Required for dashboard authentication and master keys. Workspace keys and access tokens already identify their workspace; send that workspace or omit the header. A different one is rejected.

X-Organization-Idstring

Organization context for the request. Required for dashboard authentication. An API key or access token carries its own organization, so send either that organization or no header at all; a different one is rejected.

Response

Paginated list of email templates.

next_cursorstring nullable required

Cursor for the next page. Pass back as starting_after to advance forward. null when no next page exists.

prev_cursorstring nullable required

Cursor for the previous page. Pass back as ending_before to step backward. null when no previous page exists.

refresh_cursorstring nullable required

Refresh anchor, the first row of this response. Pass back as ending_before to fetch what precedes it in the current sort order. On a newest-first sort those are the items that have appeared since; on any other sort they are the items that sort earlier, so refreshing such a list means re-fetching it instead. Non-null whenever data is non-empty; null only on an empty page. Distinct from prev_cursor.

Example response

{
  "data": [
    {
      "id": "emt_01krdgeqcxet5s7t44vh8rt9mg",
      "workspace_id": "ws_01krdgeqcxet5s7t44vh8rt9mg",
      "slug": "welcome-email",
      "name": "Welcome email",
      "status": "active",
      "draft_version_id": "emv_01krdgeqcxet5s7t44vh8rt9mg",
      "live_version_id": "emv_01krdgeqcxet5s7t44vh8rt9mg",
      "published_version_id": "emv_01krdgeqcxet5s7t44vh8rt9mg",
      "available_languages": [
        "en"
      ],
      "default_language": "pt-BR",
      "languages": {
        "en": {
          "status": "live"
        },
        "de": {
          "status": "draft"
        }
      }
    }
  ],
  "next_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE0OjAzOjEwWlwiIiwiaSI6IjAxOTJmM2IxLTRjN2UtN2EyYi05ZDYxLThmM2E1YzJlN2I0MCJ9",
  "refresh_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE2OjQyOjAxWlwiIiwiaSI6IjAxOTJmM2IxLTllMDQtN2NkMy1iODE3LTJhNmY0ZDFjOGUwOSJ9"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.