TurboDocx Template API

openapi: 3.2.0
info:
  title: TurboDocx Template API
  version: '2026-11-02'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-11-02: 20 operation(s) read from 13 public documentation page(s) (each operation names its page in x-source). This is not the provider''s published contract; TurboDocx has published no machine-readable contract that the pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 19
    documentation: 1
    pages-with-code: 13
    pages-read: 13
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-11-02'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://docs.turbodocx.com/docs/API/read-tag
  - https://docs.turbodocx.com/docs/API/create-tag
  - https://docs.turbodocx.com/docs/API/update-tag
  - https://docs.turbodocx.com/docs/API/get-webhook
  - https://docs.turbodocx.com/docs/API/test-webhook
  - https://docs.turbodocx.com/docs/API/create-webhook
  - https://docs.turbodocx.com/docs/API/delete-webhook
  - https://docs.turbodocx.com/docs/API/notify-webhook
  - https://docs.turbodocx.com/docs/API/update-webhook
  - https://docs.turbodocx.com/docs/API/Deliverable-API
  - https://docs.turbodocx.com/docs/API/delete-template
  - https://docs.turbodocx.com/docs/API/get-webhook-stats
  - https://docs.turbodocx.com/docs/API/get-template-by-id
servers:
- url: https://api.turbodocx.com
security:
- bearer: []
tags:
- name: Template
paths:
  /template/{templateid}:
    get:
      operationId: get_template_templateid
      tags:
      - Template
      summary: Get Template by ID
      x-source: https://docs.turbodocx.com/docs/API/get-template-by-id
      parameters:
      - name: templateid
        in: path
        required: true
        schema:
          type: string
      - name: showTags
        in: query
        required: false
        schema:
          type: string
        description: Pass true to include the template's tags array in the response; omitted by default.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetTemplateTemplateidResponse'
      x-evidence:
        kind: documentation
    delete:
      operationId: delete_template_templateid
      tags:
      - Template
      summary: Delete Template
      x-source: https://docs.turbodocx.com/docs/API/delete-template
      parameters:
      - name: templateid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteTemplateTemplateidResponse'
      x-evidence:
        kind: documentation
components:
  schemas:
    GetTemplateTemplateidResponse:
      type: object
      properties:
        data.results.id:
          type: string
          description: Template ID.
        data.results.name:
          type: string
          description: Template name.
        data.results.description:
          type: string
          description: Template description.
        data.results.isActive:
          type: boolean
          description: Whether the template is active.
        data.results.createdOn:
          type: string
          description: Creation timestamp.
        data.results.updatedOn:
          type: string
          description: Last update timestamp.
        data.results.createdBy:
          type: string
          description: User ID of the creator.
        data.results.firstName:
          type: string
          description: Creator's first name.
        data.results.lastName:
          type: string
          description: Creator's last name.
        data.results.email:
          type: string
          description: Creator's email.
        data.results.orgId:
          type: string
          description: Organization ID.
        data.results.templateFolderId:
          type: string
          description: Folder ID the template belongs to (null if none).
        data.results.defaultFont:
          type: string
          description: Default font for the template.
        data.results.fonts:
          type: array
          description: Array of font objects.
        data.results.metadata:
          type: object
          description: Custom metadata.
        data.results.templateFileType:
          type: string
          description: MIME type of the template file.
        data.results.isTurboDocxProvided:
          type: boolean
          description: True if the template is read‑only TurboDocx‑provided.
        data.results.deliverableCount:
          type: integer
          description: Number of deliverables using this template.
        data.results.variables:
          type: array
          description: List of variable definitions.
        data.results.variables[].placeholder:
          type: string
          description: Placeholder token.
        data.results.variables[].name:
          type: string
          description: Variable name.
        data.results.variables[].mimeType:
          type: string
          description: MIME type of the variable.
        data.results.variables[].order:
          type: integer
          description: Order of the variable.
        data.results.variables[].count:
          type: integer
          description: Occurrence count.
    DeleteTemplateTemplateidResponse:
      type: object
      properties:
        data:
          type: object
          description: Empty object returned on success.
  securitySchemes:
    bearer:
      type: http
      scheme: bearer