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": "bb08fd2b-09bd-4a23-864b-f4d76ec98319",
      "version": 3,
      "created_at": "2025-08-07T13:41:43+01:00",
      "updated_at": "2025-08-07T13:41:43+01:00",
      "public_pdf_url": "https://api.plannrcrm.com/document-template/76c02354-f63f-4696-b199-4f9b3425e1ae/content/pdf?plannr_account_uuid=b1835bd1-ac70-41a4-a982-34005d228bda",
      "public_docx_url": "https://api.plannrcrm.com/document-template/ba85e55f-cc91-485a-8202-ec7b56bd9149/content/docx?plannr_account_uuid=668475d0-ac3e-4652-a799-4733b0460b75",
      "public_sfdt_url": "https://api.plannrcrm.com/document-template/ce7d19d8-d273-4b3e-b925-00ffded1f88f/content/sfdt?plannr_account_uuid=6961abbe-7d99-4766-9c96-e9dc834027ce",
      "public_preview_url": "https://api.plannrcrm.com/document-template/b7d4f371-4ad0-4722-a508-fcca798e8fad/content/preview?plannr_account_uuid=0da3919d-cfdb-46bc-8b92-990f0bfb2897",
      "required_dependants": {
        "client-1": "client"
      }
    }
  ]
}