Archived docs Get your API Key
Get started
Tutorials
Guides
Reference
Help for AI agents
🤖 AI Assistant

List templates

GET https://api.json2video.com/v2/templates

Retrieves a single template by ID, or lists all templates owned by the authenticated account. Templates are reusable Movie JSON blueprints with variable placeholders.

Request

Headers

Header Required Value
x-api-key yes API key issued from the dashboard. Requires role render, editor, manager, or admin.

Query parameters

Parameter Type Description
id string Template ID. When present, returns a single template.
scopes string Comma-separated list of scopes to fetch. Defaults to movie. Other scopes: prompt. Only used with id.
format string When fetching a single template: make returns variables shaped for Make.com modules; jsonschema returns a JSON Schema describing the variables.
tag string List mode: filter by tag.
shared string List mode: when set to tools, returns the shared Make.com template library instead of the user's templates.

Body

None.

Response

200 OK — single template

{
    "success": true,
    "template": {
        "id": "abc123def456ghi789jk",
        "name": "Product showcase",
        "tags": ["showcase"],
        "movie": "{\"resolution\":\"full-hd\",\"scenes\":[]}",
        "ai_prompt": null,
        "created_at": "2026-04-01T12:00:00.000Z",
        "updated_at": "2026-04-15T09:30:00.000Z"
    },
    "timestamp": "2026-05-12T10:49:52.924Z"
}

When format=jsonschema the template.variables field contains a JSON Schema document derived from the template's variables object. When format=make the field contains Make.com module field descriptors.

200 OK — list

{
    "success": true,
    "count": 12,
    "templates": [
        {
            "id": "abc123def456ghi789jk",
            "name": "Product showcase",
            "tags": ["showcase"],
            "created_at": "2026-04-01T12:00:00.000Z",
            "updated_at": "2026-04-15T09:30:00.000Z"
        }
    ],
    "timestamp": "2026-05-12T10:49:52.924Z"
}

The list omits each template's movie payload; fetch a single template by id to get the full body. The list is sorted by updated_at descending.

Errors

Status Message Cause
403 Insufficient permissions API key role is below render.
404 Template {id} not found Unknown template ID.
404 Error retrieving templates Server error. Retry with exponential backoff.

Examples

List all templates

curl --location \
  --request GET 'https://api.json2video.com/v2/templates' \
  --header 'x-api-key: YOUR_API_KEY'

Fetch a single template

curl --location \
  --request GET 'https://api.json2video.com/v2/templates?id=abc123def456ghi789jk' \
  --header 'x-api-key: YOUR_API_KEY'

Fetch a template's variables as JSON Schema

curl --location \
  --request GET 'https://api.json2video.com/v2/templates?id=abc123def456ghi789jk&format=jsonschema' \
  --header 'x-api-key: YOUR_API_KEY'