Skip to main content

Get the merge-variable schema for a template

GET 

/v1/docgen/templates/:id/form-fields

Returns the merge tokens parsed from the template's source DOCX so authoring UIs can populate field pickers and dataset bindings without an extra ingest step. Templates without a parseable source (HTML, MDX, etc.) return an empty mergeFields[].

Request

Responses

Merge field schema

Response Headers
    X-Request-Id

    Correlation id for this request, returned on every response (success and error). Quote it when contacting support to pinpoint the exact request, and use it to correlate your own logs. It is the same 128-bit id as the trace-id segment of the traceparent header.

    traceparent

    W3C Trace Context identifier for this request, returned on every response. Send your own traceparent on a request to have it adopted, so a multi-call workflow shares one trace. Format: 00-<32-hex trace-id>-<16-hex span-id>-<2-hex flags>.