List Available Email Templates
/templates/email/list
Use this endpoint to get a list of available templates in your Braze account.
Use the Template REST APIs to programmatically manage the email templates that you have stored on the Braze dashboard, on the Templates & Media page. Braze provides two endpoints for creating and updating your email templates.
Looking for the api_key parameter?
As of May 2020, Braze has changed how we read API keys to be more secure. Now API keys must be passed as a request header, please see YOUR_REST_API_KEY within the Example Request below.
Braze will continue to support the api_key being passed through the request body and URL parameters, but will eventually be sunset. Please update your API calls accordingly.
Request Parameters
| Parameter | Required | Data Type | Description |
|---|---|---|---|
modified_after |
No | String in ISO 8601 | Retrieve only templates updated at or after the given time. |
modified_before |
No | String in ISO 8601 | Retrieve only templates updated at or before the given time. |
limit |
No | Positive Number | Maximum number of templates to retrieve, default to 100 if not provided, maximum acceptable value is 1000. |
offset |
No | Positive Number | Number of templates to skip before returning rest of the templates that fit the search criteria. |
Example URL
https://rest.iad-01.braze.com/templates/email/list?modified_after=2020-01-01T01:01:01.000000&modified_before=2020-02-01T01:01:01.000000&limit=100&offset=0
Example Request
1
2
curl --location --request GET 'https://rest.iad-01.braze.com/templates/email/list?modified_after=2020-01-01T01:01:01.000000&modified_before=2020-02-01T01:01:01.000000&limit=100&offset=0' \
--header 'Authorization: Bearer YOUR_REST_API_KEY'
Successful Response Properties
1
2
3
4
5
6
7
8
9
10
11
12
GET https://YOUR_REST_API_URL/templates/email/list
Content-Type: application/json
Authorization: Bearer YOUR_REST_API_KEY
{
"count": number of templates returned
"templates": [template with the following properties]:
"email_template_id": (string) your email template's API Identifier,
"template_name": (string) the name of your email template,
"created_at": (string, in ISO 8601),
"updated_at": (string, in ISO 8601),
"tags": (array of strings) tags appended to the template
}
Edit this page on GitHub