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": "4abb5cd1-ee2c-4058-865a-0cbf6bbf6a25",
      "version": 3,
      "created_at": "2025-06-25T15:10:44+01:00",
      "updated_at": "2025-06-25T15:10:44+01:00",
      "public_pdf_url": "https://api.plannrcrm.com/document-template/9607d786-c6bf-463e-b070-ea533baeeeb1/content/pdf?plannr_account_uuid=1a9f03d6-f332-4766-bb09-3ca187295010",
      "public_docx_url": "https://api.plannrcrm.com/document-template/029f1db5-9b8b-4229-b8c5-3d5e3a436759/content/docx?plannr_account_uuid=ad30895b-18d9-4b69-85d7-a9c0357e6355",
      "public_sfdt_url": "https://api.plannrcrm.com/document-template/7a2c3090-6e2d-4566-b6d5-7b7e6242e178/content/sfdt?plannr_account_uuid=ad699d5f-7d56-4117-b2ef-1158e25593c1",
      "public_preview_url": "https://api.plannrcrm.com/document-template/d104257b-7598-4862-bbc4-c829ff9a269f/content/preview?plannr_account_uuid=cdbbc580-10bb-4aff-a7c9-d5183aaf3ea2",
      "required_dependants": {
        "client-1": "client"
      }
    }
  ]
}