VUZDevelopers

List all templates for business

GET
/templates

Returns all document templates for the current business. Optionally filter by document type. Soft-deleted templates are excluded.

Authorization

X-Api-Key<token>

Business API key, e.g. vuz_ab12cdef... Created via Settings → Integrations → API Keys. Unlike partner keys, a public API key's STRING does not encode its environment — isolation instead comes from a completely separate sandbox database: a key minted on the Sandbox server (above) only ever reads/writes sandbox data and can never see or affect production, regardless of what the key looks like.

In: header

Query Parameters

includeSystem?boolean

Include system/base templates in the list

documentType?string

Filter templates by document type

Value in

  • "order"
  • "delivery_note"
  • "agent_delivery_note"
  • "return_note"
  • "tax_invoice"
  • "consolidated_invoice"
  • "tax_invoice_receipt"
  • "credit_note"
  • "reservation_invoice"
  • "agent_invoice"
  • "receipt"
  • "donation_receipt"
  • "cash_withdrawal"
  • "bank_deposit"
  • "purchase_order"
  • "purchase_delivery_note"
  • "purchase_return"
  • "purchase_tax_invoice"
  • "purchase_credit_note"
  • "opening_balance"
  • "inventory_in"
  • "inventory_out"
  • "warehouse_transfer"
  • "inventory_adjustment"
  • "production_in"
  • "production_out"
  • "quote"
  • "deal_bill"
  • "work_order"

Header Parameters

x-business-id*string

Business ID for multi-tenant access

Response Body

application/json

curl -X GET "https://example.com/templates" \  -H "x-business-id: string"
[  {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "businessId": "50092e54-cd12-4059-9828-e8c4ee9a3cf5",    "name": "string",    "description": "string",    "documentTypes": [      "order"    ],    "isDefault": true,    "isActive": true,    "templateData": {},    "version": 0,    "thumbnailUrl": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e"  }]