Skip to main content

Get Template by ID

The Get Template by ID endpoint returns a single template's full details: its metadata, creator, and the variables available to it. The variables array merges the template's own variables with any inherited from its folder and from your organization's global (knowledge base) variables, so it reflects everything the template can fill in at generation time.

When to use it​

Use this endpoint to load a template's details and variable list before generating a document, to check whether a template is TurboDocx-provided (and therefore read-only), or to confirm a metadata change made with Edit Template Metadata.

Example request​

curl "https://api.turbodocx.com/template/2b8f1c9e-4d3a-4a7c-9f21-6b0d5e9a1c34?showTags=true" \
  -H "Authorization: Bearer $TURBODOCX_API_KEY" \
  -H "x-rapiddocx-org-id: $TURBODOCX_ORG_ID" \
  -H "Accept: application/json"

Pass showTags=true to include the template's tags array in the response; it is omitted by default.

Example response​

{
  "data": {
    "results": {
      "id": "2b8f1c9e-4d3a-4a7c-9f21-6b0d5e9a1c34",
      "name": "SOW Template",
      "description": "Standard statement of work",
      "isActive": true,
      "createdOn": "2026-05-01T14:22:10.000Z",
      "updatedOn": "2026-05-01T14:22:10.000Z",
      "createdBy": "f5e6d7c8-9a0b-4c1d-2e3f-4a5b6c7d8e9f",
      "firstName": "Jane",
      "lastName": "Doe",
      "email": "jane@example.com",
      "orgId": "a1b2c3d4-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
      "templateFolderId": null,
      "defaultFont": "Calibri",
      "fonts": [{ "name": "Calibri" }],
      "metadata": {},
      "templateFileType": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
      "isTurboDocxProvided": false,
      "deliverableCount": 12,
      "variables": [
        {
          "placeholder": "{CustomerName}",
          "name": "CustomerName",
          "mimeType": "text",
          "order": 0,
          "count": 1
        }
      ]
    }
  }
}

isTurboDocxProvided is true for templates from the built-in TurboDocx library; those cannot be edited in place and must be downloaded and re-uploaded to customize. Each entry in variables mirrors the variable fields returned by generation, with isTemplateFolder set on variables inherited from the template's folder.

Common errors​

StatusWhenResponse body
401Missing or invalid API key/token, or the organization cannot be resolvedEmpty (status only)
404No active template with that ID exists in your organizationEmpty (status only)
400The TemplateID path parameter is not a valid UUID{ "message", "type": "ValidationError", "data": { "errors": [...] } }
Last updated on