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": "8206e609-0fee-4f60-b3bf-fc598f93fc4f",
      "version": 3,
      "created_at": "2025-09-17T15:46:52+01:00",
      "updated_at": "2025-09-17T15:46:52+01:00",
      "public_pdf_url": "https://api.plannrcrm.com/document-template/0ebcd7a1-bbf8-4859-8ab8-c74c459ba02e/content/pdf?plannr_account_uuid=a8d9c486-654b-4372-b1d0-9d13d1637958",
      "public_docx_url": "https://api.plannrcrm.com/document-template/12e0cd6e-b01e-4442-b8b6-3ee689d81757/content/docx?plannr_account_uuid=9ad82392-8e96-498d-8e85-bd90b1a0175c",
      "public_sfdt_url": "https://api.plannrcrm.com/document-template/1e34ac51-32d7-4811-81c8-d5af44224f78/content/sfdt?plannr_account_uuid=3fd9e4cb-bbe8-43b7-ac53-ab27a912fb5c",
      "public_preview_url": "https://api.plannrcrm.com/document-template/82e01f09-fb04-4179-93d1-8157ff532d15/content/preview?plannr_account_uuid=fbf8ce7b-730b-4547-b817-4b67eb6cd5b6",
      "required_dependants": {
        "client-1": "client"
      }
    }
  ]
}