Get document templates

GET /api/v1/document-template
Personal access token & O auth2

Headers

  • X-PLANNR-ACCOUNT-UUID string

Query parameters

  • filter[uuid] string

    Filter by a comma separated list of UUIDs.

  • sort string

    Field to sort by. Valid fields are [name, created_at, updated_at]. Negative sign to denote DESC. Defaults to 'name'.

Responses

  • 200 application/json
    Hide response attribute Show response attribute object
    • data array[object]
      Hide data attributes Show data attributes object
      • uuid string
      • created_at string
      • updated_at string
      • version integer
      • name string
      • required_dependants object
        Hide required_dependants attribute Show required_dependants attribute object
        • client-1 string
      • public_docx_url string
      • public_sfdt_url string
      • public_pdf_url string
      • public_preview_url string
GET /api/v1/document-template 
curl \
 --request GET 'https://api.plannrcrm.com/api/v1/document-template' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200) 
{
  "data": [
    {
      "name": "Welcome Template",
      "uuid": "5da2f436-20da-4044-a389-48406362f195",
      "version": 3,
      "created_at": "2025-10-08T10:40:15+01:00",
      "updated_at": "2025-10-08T10:40:15+01:00",
      "public_pdf_url": "https://api.plannrcrm.com/document-template/644d10f1-96a2-4d18-8b76-e2bc272fe74c/content/pdf?plannr_account_uuid=90156079-00f5-49ed-8180-051de5f1808a",
      "public_docx_url": "https://api.plannrcrm.com/document-template/e365d135-492c-48e2-a10f-973d1821adc9/content/docx?plannr_account_uuid=477743a3-f01c-4019-8b4c-63ae3a94b77e",
      "public_sfdt_url": "https://api.plannrcrm.com/document-template/bd2c9145-4865-49b1-883c-9a26ced012bc/content/sfdt?plannr_account_uuid=c2002b38-8ddd-47f7-a23e-b0da19285e43",
      "public_preview_url": "https://api.plannrcrm.com/document-template/5f8bd918-4193-4564-92ad-220da2d3acbc/content/preview?plannr_account_uuid=8beb1822-8050-43b1-a82f-45ddf90e7368",
      "required_dependants": {
        "client-1": "client"
      }
    }
  ]
}