Document Templates

Get a document template

GET/document-templates/{id}
document-templates:readget_document_templateRead-only

Returns one template with its page sizes or variables and its placement count. Add include=mapped_field_refs to embed the form fields that have a placement. An unknown or malformed id returns 404. Needs only the scope; the token's user is not checked. Use GET /document-templates to list templates. It changes nothing.

Path parameters

  • idstring (uuid)Required#

    The record's id.

Query parameters

  • fieldsstring#

    Comma-separated top-level fields to return. id is always returned.

  • includestring#

    Set to mapped_field_refs to embed the distinct form field references that have a placement.

Responses

200

The template.

DocumentTemplate
{
  "data": {
    "id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
    "name": "string",
    "type": "subscription_document",
    "kind": "docx",
    "original_filename": "string",
    "validated": true,
    "variable_count": 1,
    "variables": [
      "string"
    ],
    "page_metadata": [
      {
        "page": 1,
        "width_pt": 1,
        "height_pt": 1
      }
    ],
    "positions_count": 1,
    "mapped_field_refs": [
      "string"
    ],
    "validated_at": "2026-06-12T10:00:00+00:00",
    "created_at": "2026-06-12T10:00:00+00:00",
    "updated_at": "2026-06-12T10:00:00+00:00"
  }
}
401

Authentication failed. error.code is one of invalid_token, expired, revoked.

Error
403

Authorization failed. error.code is one of org_disabled, ip_blocked, missing_scope, scope_disabled, user_disabled.

Error
404

Resource not found (error.code = not_found).

Error
422

The request can't be processed (HTTP 422): validation_failed with one ErrorDetail per problem, or a code documented on the operation.

Error
429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl https://your-org-domain/kong/core/api/v2/document-templates/{id}\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"