---
title: "Get custom document template render data schema"
method: GET
path: "/onboarding/v2/templates/schema"
tags: ["Onboarding"]
---

# Get custom document template render data schema

`GET /onboarding/v2/templates/schema`

## Request

- The document declares no server URL.
- Auth: API key in header `Ocp-Apim-Subscription-Key`

Returns the JSON Schema describing the DocumentTemplateRenderDataV1 Handlebars context object. Used to power template editor autocomplete and field validation. Response is cacheable.

## Response `200`

Ok - custom document template schema metadata returned in the standard API envelope.

- ApiResponseWrapperGetDocumentTemplateSchemaResponse
  - `data` GetDocumentTemplateSchemaResponse
    - `definitions` string: JSON Schema definitions object keyed by type name.
    - `root_type` string
    - `schema_version` string
  - `errors` ErrorResponse[]: List of errors. Returns `null` if it is successful.
    - `code` string: Code describing the error.
    - `doc_link` string: The link for the error documentation. Follow it to gather more details about the error
    - `field` string: A validation error can specify the field that generated that error.
    - `message` string: Detailed message containing information on how to resolve the error.
    - `type` string: Type of error: validation, tax_authority, warning, general, unknown.
  - `message` string
  - `status` string

## Other responses

- `401`: Authentication failed - missing or incorrect subscription key.
- `429`: Too many requests were sent for a short period of time. Try again a bit later.
- `5XX`: Internal server error. Its not you, its us! We are experiencing a rare and unexpected system disruption. Retry again later. The message field of the response will contain more information for the cause. Feel free to contact us.

---

[API](https://skmtc.dev/fonoa/apis/fonoa-e-invoicing.md) - [All operations](https://skmtc.dev/fonoa/apis/fonoa-e-invoicing/llms.txt) - [OpenAPI document](https://skmtc.dev/fonoa/apis/fonoa-e-invoicing/revisions/d38890cb6fcd?raw)