/snippets (aka Templates)

Lists templates or snippets that you have access to (including those shared with you)

Parameter

Type

Description

_id

String

Unique ID.

userId

String

User _id of the snippet owner. Note that this isn't always your userId, since the template might be shared with you.

createdAt

Date

Timestamp of when the snippet was created.

savedAt

Date

Timestamp of when the snippet last modified.

savedBy

String

ID of the user that last saved the snippet.

deletedAt

Date

Timestamp of when the snippet was deleted.

archivedAt

Date

Timestamp of when the snippet was archived.

title

String

The string to use for the subject of the message this template is inserted into.

source

String

HTML source of the template.

name

String

The name of this template. Not used anywhere when the template is inserted.

shared

Object

See docs.

customShortcut

String

The shortcut this snippet can be identified by for quick insertion.

Searching

The search string will match either name or the subject of the snippet. In addition, the following search operators are supported (see below). Multiple-word values for search operators must be escaped in quotes (e.g. name:"my sales template"). This does not currently support searching the body of the snippet.

What you can search by

Search operator & example

The snippet's name

name:"my template name"

This search only applies to the snippet's name. Matches case-sensitively. Only one name: search operator supported.

The snippet's subject

name:"my template subject"

This search only applies to the snippet's subject.
Matches case-sensitively. Only one subject: search operator supported.

The snippet's tag

folder:"my awesome sales pitches"

Search snippets in the specified folder. Matches folder name case-sensitively. Only one folder: search operator supported.

The snippet's creator

owner:myself
owner:"my team"
owner:[email protected]

Search snippets belonging to yourself, your team, or a particular email. Matches case-insensitively. Only one owner: search operator supported.

The snippet's custom shortcut

customShortcut:"hi"

This search only applies the the snippet's custom shortcut, matches case insensitively.

Language
Authentication
Header
Click Try It! to start a request and see the response here!