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": "87985d95-7054-4e1e-9dcc-434738f69bc2",
      "version": 3,
      "created_at": "2025-07-17T16:23:22+01:00",
      "updated_at": "2025-07-17T16:23:22+01:00",
      "public_pdf_url": "https://api.plannrcrm.com/document-template/0903e5c0-9b90-45e5-aa4c-2bb1118399c5/content/pdf?plannr_account_uuid=16c69351-c79e-4e9a-9041-e7dc8a47ce85",
      "public_docx_url": "https://api.plannrcrm.com/document-template/3eff38db-c858-416e-ad7a-902b417ae8b9/content/docx?plannr_account_uuid=54e6b38c-7bdc-4e32-b745-70e8f75d1902",
      "public_sfdt_url": "https://api.plannrcrm.com/document-template/1506c6ed-4026-4510-9846-1c3902b79bde/content/sfdt?plannr_account_uuid=b3312a8a-edd0-4a1e-b289-3baccd7ec4ce",
      "public_preview_url": "https://api.plannrcrm.com/document-template/b307ed6a-9125-47cc-8eda-e871d478eadc/content/preview?plannr_account_uuid=467d66a5-5aa5-44d2-b5f1-d8ef101f6715",
      "required_dependants": {
        "client-1": "client"
      }
    }
  ]
}