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": "1aa8263c-8167-4950-9e19-85681a2a35ef",
      "version": 3,
      "created_at": "2025-12-04T22:09:16+00:00",
      "updated_at": "2025-12-04T22:09:16+00:00",
      "public_pdf_url": "https://api.plannrcrm.com/document-template/bb6f8f24-1ef7-499c-a23e-ecf816155e1e/content/pdf?plannr_account_uuid=d3ac9c8e-aade-4cf1-a182-f739693a78cd",
      "public_docx_url": "https://api.plannrcrm.com/document-template/0aaa7bde-9fd1-4aa9-a8bc-b52e491cb955/content/docx?plannr_account_uuid=44d9cab4-afba-4df4-86b9-96817d824f01",
      "public_sfdt_url": "https://api.plannrcrm.com/document-template/e98fd481-f27a-4aa5-8c38-fb302d9ddcef/content/sfdt?plannr_account_uuid=237babee-adae-4175-b3ed-5645759470b6",
      "public_preview_url": "https://api.plannrcrm.com/document-template/fd447a50-b7bc-4a76-b460-1fc628100652/content/preview?plannr_account_uuid=69b4ac1a-1181-4d24-8392-38d628324882",
      "required_dependants": {
        "client-1": "client"
      }
    }
  ]
}