Skip to contentSkip to navigationSkip to topbar
Twilio SendGrid Docs
On this page

Get Design

API Overview

api-overview page anchor

The Designs API offers the ability to manage assets stored in the Twilio SendGrid Design Library(link takes you to an external page).

The Design Library is a feature-rich email layout tool and media repository. You can build designs for all your email needs, including Single Sends, Automations, and Dynamic Templates.

You can also duplicate and then modify one of the pre-built designs provided by Twilio SendGrid to get you started.

The Designs API provides a RESTful interface for creating new designs, retrieving a list of existing designs, duplicating or updating a design, and deleting a design.

Operation overview

operation-overview page anchor

GET/v3/designs/{id}

Base url: https://api.sendgrid.com (The Twilio SendGrid v3 API)

This endpoint allows you to retrieve a single design.

A GET request to /designs/{id} will retrieve details about a specific design in your Design Library.

This endpoint is valuable when retrieving information stored in a field that you wish to update using a PATCH request.

Operation details

operation-details page anchor

Authentication

authentication page anchor

Headers

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

Path parameters

path-parameters page anchor
Property nameTypeRequiredDescription
idstring<uuid>required

The ID of the Design you want to duplicate.

Responses

responses page anchor
200400404
SchemaExample
Property nameTypeRequiredDescriptionChild properties
namestring

The name of the new design.

Default: Duplicate: <original design name>
editorenum<string>

The editor used in the UI.

Possible values:
codedesign
html_contentstring

The HTML content of the Design.

Max length: 1048576
plain_contentstring

Plain text content of the Design.

Max length: 1048576Default: <generated from html_content if left empty>
Get DesignLink to code sample: Get Design
1
const client = require('@sendgrid/client');

2
client.setApiKey(process.env.SENDGRID_API_KEY);

3


4
const id = "f15982c1-a82c-4e87-a6b2-a4a63b4b7644";

5


6
const request = {

7
  url: `/v3/designs/${id}`,

8
  method: 'GET',

9
  

10
}

11


12
client.request(request)

13
  .then(([response, body]) => {

14
    console.log(response.statusCode);

15
    console.log(response.body);

16
  })

17
  .catch(error => {

18
    console.error(error);

19
  });