Templates

Get a template

Retrieves one template, including every field it exposes - the keys a render's values object can set.

get/v1/templates/{template_id}

Request

  • Base URL: https://api.editsquare.com
  • URL: https://api.editsquare.com/v1/templates/{template_id}
  • Auth: HTTP bearer

Path parameters

template_idstring required

Template ID

Example:tpl_8f2c1d4e6a7b9c0d1e2f3a4b5c6d7e8f

Query parameters

project_idstring required

Project ID

Example:proj_jd71dcg41pjy7rax1v2h4pvcmd7gtar9

Response

The template

idstring required
namestring required
descriptionstring nullable required
project_idstring required
target_composition_idstring required

The composition this template renders.

field_countnumber required

Example response

{
  "id": "tpl_8f2c1d4e6a7b9c0d1e2f3a4b5c6d7e8f",
  "name": "Welcome video",
  "description": "One clip per new customer.",
  "project_id": "proj_jd71dcg41pjy7rax1v2h4pvcmd7gtar9",
  "target_composition_id": "comp_4f1f0f7c",
  "field_count": 3,
  "fields": [
    {
      "key": "customer_name",
      "label": "Customer name",
      "description": "Shown on the opening card.",
      "kind": "control",
      "widget": "text"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.