Automette docs

Get a template's field schema

GET
/api/v1/templates/{id}/fields

Authorization

ApiKeyAuth
AuthorizationBearer <token>

API key from Settings → API Keys.

In: header

Path Parameters

id*string

Query Parameters

primary?boolean

true returns only content fields, dropping styling properties. Canvas layers left with nothing are omitted.

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/templates/string/fields"
{  "id": "cm4tpl8e20001js04xq2v9k3m",  "engine": "typst",  "field_count": {    "total": 1,    "primary": 1  },  "fields": [    {      "key": "customer",      "type": "text",      "example": "Acme Ltd",      "primary": true    }  ],  "sample_data": {    "customer": "Acme Ltd"  }}