Skip to main content
GET
/
canvas-templates
/
{id}
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Welcome Email Template",
  "template": "<h1>Hello {{name}}!</h1>",
  "schema": {
    "type": "object",
    "properties": {
      "name": {
        "type": "string"
      }
    }
  },
  "createdAt": "2024-03-20T15:30:00.000Z",
  "updatedAt": "2024-03-20T15:30:00.000Z"
}

Path Parameters

​
id
any
required

The ID of the Canvas Template to find

Response

200 - application/json

The Canvas Template was successfully obtained.

​
id
string
required

The unique identifier of the canvas template

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
template
string
required

The Handlebars template string

Example:

"<h1>Hello {{name}}!</h1>"

​
schema
object
required

JSON schema defining the template variables

Example:
{
  "type": "object",
  "properties": { "name": { "type": "string" } }
}
​
createdAt
string<date-time>
required

When the template was created

Example:

"2024-03-20T15:30:00.000Z"

​
updatedAt
string<date-time>
required

When the template was last updated

Example:

"2024-03-20T15:30:00.000Z"

​
name
string

The name of the template

Example:

"Welcome Email Template"