Snippets

Get a snippet

Returns a personal or shared snippet the user can access.

get/v2/snippets/{snippetKey}

Request

snippetKeystring required

keystring required

Key of the snippet.

snippetNamestring nullable

Name of the snippet.

snippetTextstring nullable

Email body, interpreted according to snippetType.

snippetType'HTML' | 'TEXT' required

subjectstring nullable

Optional email subject.

snippetKeyShortcutstring nullable

Shortcut typed to insert the snippet.

userKeystring nullable

User who owns the snippet; updates set this to the editor.

pipelineKeystring nullable

Pipeline the snippet is shared with; omitted for personal snippets.

partOfPipelineboolean nullable

Whether the snippet is shared with a pipeline.

creationDateinteger nullable

When the snippet was created, in epoch milliseconds.

lastSavedTimestampinteger required

When the snippet was last saved, in epoch milliseconds; zero for older records without a timestamp.

{
  "creationDate": 1646870400000,
  "lastSavedTimestamp": 1646870400000
}