Template Metadata

Inspect the variables a template references before exporting it.

Overview

The metadata endpoint compiles one of your templates and reports the variables it references along with any errors found while parsing the source. Use it to discover which variables to supply when calling the Template Export endpoint.

All requests must be authenticated with an API key. See Authentication for how to create one.

Endpoint

GET /api/tasks/{templateId}/metadata

Replace {templateId} with the ID of the template you want to inspect.

Example

curl "https://www.hardcopies.net/api/tasks/TEMPLATE_ID/metadata" \
  -H "Authorization: YOUR_API_KEY"

Response

On success the endpoint returns 200 OK with a JSON body containing a variables array and an errors array.

{
  "variables": [
    { "name": "owner", "type": "string" },
    { "name": "includeNotes", "type": "boolean" }
  ],
  "errors": [
    {
      "message": "Unexpected token",
      "position": { "line": 4, "column": 1 },
      "severity": "error"
    }
  ]
}

Variables

Each entry in the variables array describes a variable the template references. The type is inferred from how the variable is used in the source.

Errors array

The errors array lists problems found while parsing the template source. It is empty when the template parses cleanly. Each entry includes a message, a position with the line and column, and a severity of error or warning.

Errors

Failures are returned as JSON with an error message.