Sign in
snippet

Retrieve Snippet

Used to retrieve an existing Snippet

get/snippets/{id}

Path parameters

idstring required

The Snippet ID.

Query parameters

preferLatestIfReusableboolean

Optional flag to retrieve the latest version if retrieving a reusable snippet

Response

The Snippet that was retrieved

invariant_idstring

Object ID for the parent type. Set by system.

descriptionstring

Summary of the Snippet

namestring

The display name of the Snippet

bodystring

the base64 encoded body of the Snippet

snippet_type'css' | 'javascript' | 'xpath' | 'sql' | 'postman'
reusableboolean

Indicates whether the snippet is reusable

workspace_idstring

The ID of the workspace that this Snippet belongs to

idstring

Object id. Set by system.

is_latestboolean

Indicates whether this was the latest variant when retrieved

versioninteger

The generation number of this variant

previous_versioninteger

The generation number of the variant that was edited to create this variant (if applicable)

merged_versioninteger

The generation number of the variant that was merged with the previous version to create this variant (if applicable)

created_on_branchstring

Name of the branch the snippet's variant was created on

change_descriptionstring

Description of the change between this variant and the previous variant

last_updated_timeinteger

time the Snippet object was last updated

last_updated_by_idstring

The ID of the user who last updated this Snippet

variant_last_updated_timeinteger

time the Snippet's variant was last updated

variant_last_updated_by_idstring

The ID of the user who last updated this Snippet's variant

created_timeinteger

time the Snippet was created

created_by_idstring

The ID of the user who created this Snippet

revision_historystring

Graph describing the snippet's version history

database_connection_idstring

If the snippet is a SQL snippet, the database connection id.

Changes