Sign in

v1

latestOpenAPI 3.1.0MIT2026-07-243952451019.0 KB
Emails::Template

List Email Templates

List all email templates for a workspace

get/workspaces/{workspace_id}/emails/templates

Path parameters

workspace_idinteger required

Query parameters

afterstring

ID of item after which the collection should be returned. More examples and info about pagination in our guides.

sort_order'asc' | 'desc'

Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples in our guides.

sort_property'id' | 'updated_at'

Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Response

OK

idinteger

Template ID

public_idstring nullable

Template public ID

workspace_idinteger

Workspace ID

namestring nullable

Template name

template_typestring

Template type

created_atstring date-time nullable

Created at datetime

updated_atstring date-time nullable

Updated at datetime

subjectstring nullable

Default email subject line for the template

html_bodystring nullable

Expandable The template's rendered HTML body. Only returned when expand[]=html_body is provided. get_html is a per-template cloud-storage read, so this is omitted from list and show by default; expanding it on a list fans out to one read per row — use sparingly.

text_bodystring nullable

Expandable The template's plain text body. Only returned when expand[]=text_body is provided.

created_via_apiboolean

Whether this template was authored via the public API. API-created templates are hidden from the visual template pickers and cannot be edited in the visual (BeeFree) editor.

Example response

[
  {
    "id": 1,
    "public_id": "MnOpQr",
    "workspace_id": 42000,
    "name": "Welcome Email",
    "template_type": "email",
    "created_at": "2025-01-01T00:00:00.000Z",
    "updated_at": "2025-01-01T00:00:00.000Z",
    "subject": "Welcome aboard!",
    "html_body": "<h1>Hello</h1>",
    "text_body": "Hello",
    "created_via_api": true,
    "from_address": {
      "id": 4001,
      "public_id": "FrAd01",
      "email_address": "marketing@example.com",
      "name": "Marketing Team"
    }
  }
]