Skip to contentSkip to navigationSkip to topbar
Rate this page:
On this page

Retrieve paged transactional templates.



API Overview

api-overview page anchor

An HTML template that can establish a consistent design for transactional emails(link takes you to an external page).

Each parent account, as well as each Subuser, can create up to 300 different transactional templates. Templates are specific to the parent account or Subuser, meaning templates created on a parent account will not be accessible from the parent's Subuser accounts.

Transactional templates are templates created specifically for transactional email and are not to be confused with Marketing Campaigns designs. For more information about transactional templates, please see our Dynamic Transactional Templates documentation.


GET/v3/templates

Base url: https://api.sendgrid.com

This endpoint allows you to retrieve all transactional templates.


Authentication

authentication page anchor
Property nameTypeRequiredDescription
Authorizationstringrequired
Default: Bearer <<YOUR_API_KEY_HERE>>

on-behalf-ofstringOptional

The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.

Property nameTypeRequiredDescription
generationsenum<string>Optional

Comma-delimited list specifying which generations of templates to return. Options are legacy, dynamic or legacy,dynamic.

Default: legacyPossible values:
legacydynamiclegacy,dynamic

page_sizenumberrequired

The number of templates to be returned in each page of results

Minimum: 1Maximum: 200

page_tokenstringOptional

A token corresponding to a specific page of results, as provided by metadata

200400
SchemaExample
Property nameTypeRequiredDescriptionChild properties
resultarray[object]

_metadataobject

Retrieve paged transactional templates.

retrieve-paged-transactional-templates page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
curl

_22
const client = require('@sendgrid/client');
_22
client.setApiKey(process.env.SENDGRID_API_KEY);
_22
_22
const queryParams = {
_22
"generations": "legacy",
_22
"page_size": 18
_22
};
_22
_22
const request = {
_22
url: `/v3/templates`,
_22
method: 'GET',
_22
qs: queryParams
_22
}
_22
_22
client.request(request)
_22
.then(([response, body]) => {
_22
console.log(response.statusCode);
_22
console.log(response.body);
_22
})
_22
.catch(error => {
_22
console.error(error);
_22
});


Rate this page: