Skip to main content
GET
Get a template

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id_or_slug
string
required

Response

Successful Response

A gallery card plus the composition, so it can be inspected before it is used.

id
string
required

The template's project id.

scope
enum<string>
required

public (in the gallery, from a listing) or workspace (one of your templates).

Available options:
public,
workspace
name
string
required

The listing title for a public template, else the project name.

width
integer
required

Canvas width in pixels.

height
integer
required

Canvas height in pixels.

aspect
enum<string>
required

From width and height.

Available options:
landscape,
portrait,
square
duration
number
required

Composition length in seconds.

element_count
integer
required
version
integer
required

The head version the card describes.

created_at
string<date-time>
required
updated_at
string<date-time>
required
render_request
RenderRequest · object
required

The template's head composition.

description
string | null

Listing copy. Null for workspace templates.

category
string | null

Listing category. Null for workspace templates.

tags
string[]
thumbnail_url
string | null

Poster image; null until one is generated.

thumbnail_version
integer | null

The head version the thumbnail shows; stale while below version.

preview_url
string | null

A finished render to play on hover. Public templates only for now.

premium
boolean
default:false
listing_id
string | null

The gallery listing, for public templates.

slug
string | null

The listing's stable handle: GET /v1/templates/{slug}.

priority
integer | null

Listing order, highest first.

status
enum<string> | null

Listing status. draft reaches admin workspaces only.

Available options:
draft,
published
family
string | null

Links the size variants of one design.