On this page

Retrieve paged transactional templates.

API Overview

An HTML template that can establish a consistent design for transactional emails.

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.

Operation overview

GET/v3/templates

Base url: https://api.sendgrid.com (for global users and subusers)

Base url: https://api.eu.sendgrid.com (for EU regional subusers)

This endpoint allows you to retrieve all transactional templates.

Operation details

Authentication

API Key

Headers

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.

Query string

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

Responses

200400

SchemaExample

Property nameTypeRequiredDescriptionChild properties

resultarray[object]

Show child properties for result

_metadataobject

Show child properties for _metadata

Retrieve paged transactional templates.

1const client = require("@sendgrid/client");
2client.setApiKey(process.env.SENDGRID_API_KEY);
3
4const queryParams = {
5  page_size: 18,
6};
7
8const request = {
9  url: `/v3/templates`,
10  method: "GET",
11  qs: queryParams,
12};
13
14client
15  .request(request)
16  .then(([response, body]) => {
17    console.log(response.statusCode);
18    console.log(response.body);
19  })
20  .catch((error) => {
21    console.error(error);
22  });