Templates are the email templates found in your Dyspatch account. Only the published Template Draft is returned. A typical integration will start with using the Templates list endpoint to iterate through and sync Templates.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/dyspatch:dyspatch-templates-api"curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
version: '2026.06'
title: Dyspatch Templates API
description: '# Introduction
The Dyspatch API is based on the REST paradigm, and features resource based URLs with standard HTTP response
codes to indicate errors.'
contact:
name: Dyspatch Support
url: https://docs.dyspatch.io
email: support@dyspatch.io
termsOfService: https://www.dyspatch.io/legal/terms-of-service/
servers:
- url: https://api.dyspatch.io
tags:
- name: Templates
description: 'Templates are the email templates found in your Dyspatch account. Only the
published Template Draft is returned.
A typical integration will start with using the Templates list endpoint to iterate through and sync Templates.'
paths:
/templates:
get:
operationId: getTemplates
security:
- Bearer: []
summary: List Templates
description: Gets a list of Template Metadata objects for all published templates. Up to 25 results returned before results are paginated.
tags:
- Templates
parameters:
- $ref: '#/components/parameters/cursor'
- $ref: '#/components/parameters/version'
- $ref: '#/components/parameters/templateNameFilter'
- $ref: '#/components/parameters/templateFolderFilter'
- $ref: '#/components/parameters/templateWorkspaceFilter'
responses:
'200':
description: A list of templates
headers:
X-RateLimit-Remaining:
description: The number of requests left for the time window.
schema:
type: integer
content:
application/vnd.dyspatch.2026.06+json:
schema:
$ref: '#/components/schemas/TemplatesRead'
'400':
$ref: '#/components/responses/InvalidRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'429':
$ref: '#/components/responses/RateLimited'
'500':
$ref: '#/components/responses/InternalError'
default:
$ref: '#/components/responses/InternalError'
/templates/{templateId}:
get:
operationId: getTemplateById
security:
- Bearer: []
summary: Get Template by ID
description: Gets a template object with the matching ID. Templates without a published draft will result in an error.
tags:
- Templates
parameters:
- $ref: '#/components/parameters/templateId'
- $ref: '#/components/parameters/targetLanguage'
- $ref: '#/components/parameters/renderThemeId'
- $ref: '#/components/parameters/version'
responses:
'200':
description: A template object with the requested ID. Templates without a published draft will result in an error.
headers:
X-RateLimit-Remaining:
description: The number of requests left for the current time window
schema:
type: integer
content:
application/vnd.dyspatch.2026.06+json:
schema:
$ref: '#/components/schemas/TemplateRead'
'400':
$ref: '#/components/responses/InvalidRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'429':
$ref: '#/components/responses/RateLimited'
'500':
$ref: '#/components/responses/InternalError'
default:
$ref: '#/components/responses/InternalError'
/render/template/{templateId}:
post:
operationId: renderTemplate
security:
- Bearer: []
summary: Render Template by ID
description: Renders a template into HTML using the provided data.
tags:
- Templates
parameters:
- $ref: '#/components/parameters/templateId'
- $ref: '#/components/parameters/renderThemeId'
- $ref: '#/components/parameters/version'
requestBody:
description: JSON object containing template data for the render
content:
application/json:
schema:
$ref: '#/components/schemas/RenderBody'
required: false
responses:
'200':
description: Rendered template contents incorporating the data passed in the request body.
headers:
X-RateLimit-Remaining:
description: The number of requests left for the current time window
schema:
type: integer
content:
application/vnd.dyspatch.2026.06+json:
schema:
$ref: '#/components/schemas/TemplateRender'
'400':
$ref: '#/components/responses/InvalidRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'429':
$ref: '#/components/responses/RateLimited'
'500':
$ref: '#/components/responses/InternalError'
default:
$ref: '#/components/responses/InternalError'
/render/template/{templateId}/{languageId}:
post:
operationId: renderTemplateByLCID
security:
- Bearer: []
summary: Render Localized Template by ID
description: Renders a template into HTML for the selected language using the provided data.
tags:
- Templates
parameters:
- $ref: '#/components/parameters/templateId'
- $ref: '#/components/parameters/languageId'
- $ref: '#/components/parameters/renderThemeId'
- $ref: '#/components/parameters/version'
requestBody:
description: JSON object containing template data for the render
content:
application/json:
schema:
$ref: '#/components/schemas/RenderBody'
required: false
responses:
'200':
description: Rendered template contents in the selected language, incorporating the data passed in the request body.
headers:
X-RateLimit-Remaining:
description: The number of requests left for the current time window
schema:
type: integer
content:
application/vnd.dyspatch.2026.06+json:
schema:
$ref: '#/components/schemas/TemplateRender'
'400':
$ref: '#/components/responses/InvalidRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'429':
$ref: '#/components/responses/RateLimited'
'500':
$ref: '#/components/responses/InternalError'
default:
$ref: '#/components/responses/InternalError'
components:
parameters:
templateNameFilter:
name: name
in: query
description: Filter templates by name (case-insensitive partial match)
required: false
schema:
type: string
renderThemeId:
name: themeId
in: query
description: A theme ID to use when rendering
required: false
schema:
type: string
version:
in: header
name: Accept
required: true
description: A version of the API that should be used for the request. For example, to use version "2026.06", set the value to "application/vnd.dyspatch.2026.06+json"
schema:
type: string
targetLanguage:
name: targetLanguage
in: query
description: The type of templating language to use when compiling the content.
required: true
schema:
type: string
enum:
- html
- handlebars
- ampscript
- freemarker
- cheetah
- jinja
- liquid
- mandrillhandlebars
- handlebarsjava
languageId:
name: languageId
in: path
description: 'A language ID (eg: en-US)'
required: true
schema:
type: string
templateFolderFilter:
name: folderId
in: query
description: Filter templates by folder ID (immediate children only)
required: false
schema:
type: string
cursor:
name: cursor
in: query
description: A cursor value used to retrieve a specific page from a paginated result set.
required: false
schema:
type: string
templateWorkspaceFilter:
name: workspaceId
in: query
description: Filter templates by workspace ID (includes all nested folders)
required: false
schema:
type: string
templateId:
name: templateId
in: path
description: A template ID
required: true
schema:
type: string
schemas:
templateId:
type: string
description: An opaque, unique identifier for a template
example: tem_g3L7Cw6Hp5wU
localizationName:
type: string
example: English (US)
description: The user-specified name of a localization
TemplateRender:
type: object
description: rendered template with data
properties:
html:
type: string
description: Rendered HTML template body
example: <html>Hello, world!<html>
ampHtml:
type: string
description: Rendered AMP HTML template body
example: <html ⚡4email>Hello, world!<html>
text:
type: string
example: Hello, world!
description: Rendered template text body
subject:
type: string
example: Email Subject Line
description: Template subject line
sender:
type: string
example: example@example.com
description: Sender address
replyTo:
type: string
example: example@example.com
description: Reply-To address
TemplateMetaRead:
type: object
description: the template metadata
properties:
id:
$ref: '#/components/schemas/templateId'
name:
$ref: '#/components/schemas/templateName'
description:
$ref: '#/components/schemas/templateDescription'
url:
$ref: '#/components/schemas/templateUrl'
path:
$ref: '#/components/schemas/path'
workspaceId:
$ref: '#/components/schemas/workspaceId'
localizations:
type: array
items:
$ref: '#/components/schemas/LocalizationMetaRead'
description: A list of the template's available localization objects
createdAt:
$ref: '#/components/schemas/createdAt'
updatedAt:
$ref: '#/components/schemas/updatedAt'
publishedDraftId:
$ref: '#/components/schemas/draftId'
tags:
type: array
items:
$ref: '#/components/schemas/AssignedTagsMetaRead'
description: A list of Tags assigned to the Template
updatedAt:
type: string
format: date-time
description: The time of last update
TemplateRead:
type: object
description: list of template metadata
properties:
id:
$ref: '#/components/schemas/templateId'
name:
$ref: '#/components/schemas/templateName'
description:
$ref: '#/components/schemas/templateDescription'
url:
$ref: '#/components/schemas/templateUrl'
compiled:
$ref: '#/components/schemas/CompiledRead'
path:
$ref: '#/components/schemas/path'
workspaceId:
$ref: '#/components/schemas/workspaceId'
createdAt:
$ref: '#/components/schemas/createdAt'
updatedAt:
$ref: '#/components/schemas/updatedAt'
publishedDraftId:
$ref: '#/components/schemas/draftId'
localizations:
type: array
items:
$ref: '#/components/schemas/LocalizationMetaRead'
description: A list of the Template's available localizations
tags:
type: array
items:
$ref: '#/components/schemas/AssignedTagsMetaRead'
description: A list of Tags assigned to the Template
draftId:
type: string
description: An opaque, unique identifier for a draft
example: tdft_g3L7Cw6Hp5wU
createdAt:
type: string
format: date-time
description: The time of initial creation
tagName:
type: string
example: My Tag
description: The user-specified name of a tag
APIError:
type: object
description: possible errors from the api
properties:
code:
type: string
enum:
- server_error
- invalid_parameter
- invalid_body
- invalid_request
- unauthorized
- unauthenticated
- not_found
- rate_limited
- prohibited_action
description: "Error code:\n * server_error - Internal server error.\n * invalid_parameter - Validation error, parameter will contain invalid field and message will contain the reason.\n * invalid_body - Body could not be parsed, message will contain the reason.\n * invalid_request - Validation error, the protocol used to make the request was not https.\n * unauthorized - Credentials were found but permissions were not sufficient.\n * unauthenticated - Credentials were not found or were not valid.\n * not_found - The requested resource was not found.\n * rate_limited - The request was refused because a rate limit was exceeded. There is an account wide rate limit of 3600 requests per-minute, although that is subject to change. The current remaining rate limit can be viewed by checking the X-Ratelimit-Remaining header.\n * prohibited_action - The request was refused because an action was not valid for the requested resource. Typically this will happen if you try to make changes to a locked resource.\n"
message:
type: string
description: Human readable error message
parameter:
type: string
description: The invalid parameter, if 'code' is invalid_parameter
localeGroupId:
description: the locale group this localization belongs to, if this field is empty the localization does not belong to any locale group
type: string
example: lgr_alka38ajla301
AssignedTagsMetaRead:
type: object
description: assigned tags metadata
properties:
id:
$ref: '#/components/schemas/tagId'
name:
$ref: '#/components/schemas/tagName'
cursor:
type: object
description: Information about paginated results
properties:
next:
type: string
description: A cursor to fetch the next page of results
hasMore:
type: boolean
description: Whether there is a next page of results
workspaceId:
type: string
description: The workspace this object belongs to
example: fdr_01gb8vd6pz
templateDescription:
type: string
description: A description of the template
example: Description of Template
TemplatesRead:
type: object
description: list of template metadata
properties:
cursor:
$ref: '#/components/schemas/cursor'
data:
type: array
items:
$ref: '#/components/schemas/TemplateMetaRead'
description: A list of template metadata objects
path:
type: string
description: The folder path location for this object
example: fdr_01gb8vd6pz/fdr_01gqjmdbq/fdr_01gqjmg1
CompiledRead:
type: object
description: revision data
properties:
sender:
type: string
example: example@example.com
description: Sender address
replyTo:
type: string
example: example@example.com
description: Reply-To address
subject:
type: string
format: byte
example: PGh0bWw+PC9odG1sPgo=
description: Base64 encoded template subject line
html:
type: string
format: byte
example: PGh0bWw+PC9odG1sPgo=
description: Base64 encoded template HTML body
ampHtml:
type: string
format: byte
example: PGh0bWwg4pqhNGVtYWlsPjwvaHRtbD4=
description: Base64 encoded template AMP body
text:
type: string
format: byte
example: dGV4dCBjb250ZW50
description: Base64 encoded template text body
variables:
$ref: '#/components/schemas/variables'
tagId:
type: string
example: /An opaque, unique identifier for a tag
description: tag_01gpe172x7p6aa1c9grr48efq8
languages:
type: array
items:
type: string
example: fr-FR
description: 'a list of locale codes that are available in the localization. See [supported languages](https://docs.dyspatch.io/localization/supported_languages/) for an exhaustive list of locale codes.
'
localizationId:
type: string
description: An opaque, unique identifier for a localization
example: loc_g3L7Cw6Hp5wUaf395LehwK
localizationUrl:
type: string
example: /localizations/loc_g3L7Cw6Hp5wUaf395LehwK
description: The API url for a specific localization
LocalizationMetaRead:
type: object
description: localization metadata
properties:
id:
$ref: '#/components/schemas/localizationId'
name:
$ref: '#/components/schemas/localizationName'
url:
$ref: '#/components/schemas/localizationUrl'
localeGroup:
$ref: '#/components/schemas/localeGroupId'
languages:
$ref: '#/components/schemas/languages'
updatedAt:
$ref: '#/components/schemas/updatedAt'
templateUrl:
type: string
example: /templates/tem_g3L7Cw6Hp5wUaf395LehwK
description: The API url for a specific template
variables:
type: array
items:
type: string
example: myVar
description: 'a list of variables used in the template
'
RenderBody:
type: object
properties:
variable name:
description: string, number, boolean, array, object or null
example:
var1: value 1
var2: value 2
templateName:
type: string
description: The name of a template
example: Template Name
responses:
InvalidRequest:
description: Invalid request
headers:
X-RateLimit-Remaining:
description: The number of requests left for the time window.
schema:
type: integer
content:
'*/*':
schema:
$ref: '#/components/schemas/APIError'
Unauthorized:
description: Unauthorized
headers:
X-RateLimit-Remaining:
description: The number of requests left for the time window.
schema:
type: integer
content:
'*/*':
schema:
$ref: '#/components/schemas/APIError'
NotFound:
description: Resource not found
headers:
X-RateLimit-Remaining:
description: The number of requests left for the time window.
schema:
type: integer
content:
'*/*':
schema:
$ref: '#/components/schemas/APIError'
InternalError:
description: Server error
headers:
X-RateLimit-Remaining:
description: The number of requests left for the time window.
schema:
type: integer
content:
'*/*':
schema:
$ref: '#/components/schemas/APIError'
RateLimited:
description: Rate limit exceeded
headers:
X-RateLimit-Remaining:
description: The number of requests left for the time window.
schema:
type: integer
content:
'*/*':
schema:
$ref: '#/components/schemas/APIError'
securitySchemes:
Bearer:
type: apiKey
name: Authorization
in: header
description: 'Set Bearer followed by your API key as the Authorization header in your
API requests.
```shell
Authorization: Bearer EXAMPLEAPIKEYXXXXXXXX12345678
```
Below is an example curl request with an API key in the Authorization header.
```shell
curl --request GET \
--url https://api.dyspatch.io/templates \
--header ''Authorization: Bearer EXAMPLEAPIKEYXXXXXXXX12345678'' \
--header ''Accept: application/vnd.dyspatch.2026.06+json''
```
'
x-tagGroups:
- name: Email
tags:
- Templates
- Drafts
- Localizations
- name: Platform
tags:
- Workspaces
- Blocks
- Tags
- Customer Profiles
- Themes
- name: Other Communication Channels
tags:
- SMS Templates
- SMS Drafts
- SMS Localizations
- Push Templates
- Push Drafts
- Push Localizations
- Live Activity Templates
- Live Activity Drafts
- Live Activity Localizations
- Voice Templates
- Voice Drafts
- Voice Localizations