Use this endpoint to get a JSON representation of your email template along with a list of campaigns using the template.
API at a glance
Description: This API retrieves a JSON representation of an email template along with a list of campaigns using the template. Returns template metadata, content, and associated campaign information.
Authentication & testing
Testing the API on this page
How to try it here
- Use your User API Key as the Username (leave Password blank).
- Select the appropriate API endpoint based on your Blueshift region.
- Enter the necessary parameters and click Try It to run the request.
Authentication using Base64 encoding
Note for developers
API requests require authentication using HTTP Basic Authentication with an API key.
The API key serves as the username, while the password field should be left empty.
The format to encode is: your_api_key: (note the trailing colon).
This string must be Base64-encoded and included in the request's Authorization header as follows:
Authorization: Basic encoded_valueYou can generate the encoded value using a trusted Base64 encoder.
Postman collection
Try it with Postman: Explore the API using Blueshift's Postman collection.
Things to know before you start
- Finding template UUID: Template UUIDs can be found by querying the List email templates API, or from the URL when viewing a template in Blueshift:
https://app.getblueshift.com/dashboard#/email_template_studio/<TEMPLATE_UUID>/edit/info. - Response includes: Template name, creation/update timestamps, author, subject, content, and list of campaigns using this template.
- Campaign details: For each campaign using the template, the response includes campaign name, UUID, and status (e.g., draft, launched).
- Use case: Best for template auditing, checking template usage across campaigns, retrieving template content for backup or migration, and integration workflows.
Request parameters
Check out the request parameters
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
TEMPLATE_UUID | string | ✅ Yes | The UUID of the email template to retrieve. |
Example requests & responses
Get email template details
Request
curl --request GET \
--url https://api.getblueshift.com/api/v1/email_templates/1da9e1e8-feae-4ec3-be0a-7dba528590bb.json \
--header 'accept: application/json' \
--header 'authorization: Basic <YOUR_API_KEY>'Response
{
"name": "my template",
"created_at": "2023-10-03T04:57:24.000Z",
"updated_at": "2024-05-03T04:57:24.000Z",
"uuid": "1da9e1e8-feae-4ec3-be0a-7dba528590bb",
"author": "Bertram Gilfoyle",
"resource": {
"subject": "Hello",
"content": "<!DOCTYPE html>\n<html>\n<body>\nHello</body></html>"
},
"campaigns": [
{
"names": "my campaign",
"uuid": "f63ebf4f-160b-42d8-b482-cbe0fc7de6b7",
"status": "draft"
},
{
"names": "my other campaign",
"uuid": "ab67f1a7-efbb-46cd-8e9d-9a823e77bf1c",
"status": "launched"
}
]
}