List email templates
GET
/v1/email/templates
curl -X GET "https://us1.platform.bird.com/v1/email/templates" \
-H "Authorization: Bearer $TOKEN" \
--url-query "limit=25"Returns a paginated list of the workspace's email templates, newest first. Filter by category, source, or a case-insensitive name prefix.
Parámetros de consulta
category
string
Filter by template category.
source
string
Filter by authoring format.
name
string
Filter by name prefix (case-insensitive).
limit
integer
Maximum number of items to return per page.
starting_after
string
Cursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order.
ending_before
string
Cursor from the prev_cursor field of a previous list response. Returns items immediately before the cursor position in the current sort order.
Carga de respuesta
data
array of object
obligatorio
Page of email templates.
Mostrar atributos secundarios
data.id
string
obligatorio
Template ID.
data.workspace_id
string
obligatorio
Workspace that owns the template.
data.name
string
obligatorio
Human-readable template name, unique within the workspace.
data.alias
nullable string
The template's workspace-unique slug handle for send-by-template, or null if unset.
data.description
nullable string
Optional description of the template's purpose. Null when unset.
data.category
string
obligatorio
Whether the template is transactional or marketing email.
data.source
string
obligatorio
The authoring format the template is written in. Fixed at creation.
data.draft_version_id
string
obligatorio
The current editable draft version.
data.published_version_id
nullable string
The currently published version, or null if never published.
data.created_at
string
obligatorio
When the template was created.
data.updated_at
string
obligatorio
When the template was last modified.
next_cursor
nullable string
obligatorio
Cursor for the next page. Pass back as starting_after to advance forward. Null when no next page exists.
prev_cursor
nullable string
obligatorio
Cursor for the previous page. Pass back as ending_before to step backward. Null when no previous page exists.
refresh_cursor
nullable string
obligatorio
Refresh anchor. Pass back as ending_before later to fetch items that have appeared since this response. Non-null whenever data is non-empty; null only on an empty page. Distinct from prev_cursor.