Get document templates Run in API Explorer

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": "814a4eaa-75b9-4c0e-964b-4a366e7b7d9e",
      "version": 3,
      "created_at": "2025-11-17T21:14:39+00:00",
      "updated_at": "2025-11-17T21:14:39+00:00",
      "public_pdf_url": "https://api.plannrcrm.com/document-template/d48e46e9-3b90-4164-bdf7-118f9a305561/content/pdf?plannr_account_uuid=09d8ab9a-3f49-4f6f-878f-231834277de9",
      "public_docx_url": "https://api.plannrcrm.com/document-template/f0b6c3d7-0d3e-4c6c-9254-ee450821b6fe/content/docx?plannr_account_uuid=12485cdf-ea49-412d-8c2d-b73f571b5eda",
      "public_sfdt_url": "https://api.plannrcrm.com/document-template/b17b600a-fefe-43f8-8ab6-627444275cdc/content/sfdt?plannr_account_uuid=f214922c-6197-4c74-8edb-0f35f082b329",
      "public_preview_url": "https://api.plannrcrm.com/document-template/0913580b-ae37-43c7-ac35-f707fb07e149/content/preview?plannr_account_uuid=9ae368b6-9ec3-4d64-ad48-a14810c4335c",
      "required_dependants": {
        "client-1": "client"
      }
    }
  ]
}