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": "e0b4870b-6fd8-42ae-8773-5ef614cea9a1",
      "version": 3,
      "created_at": "2025-10-24T10:34:19+01:00",
      "updated_at": "2025-10-24T10:34:19+01:00",
      "public_pdf_url": "https://api.plannrcrm.com/document-template/e1d637b3-7336-45ac-8895-6fe7a6197bb8/content/pdf?plannr_account_uuid=05da23a8-903e-46dc-964e-2b91ee961a24",
      "public_docx_url": "https://api.plannrcrm.com/document-template/62eaff13-5d35-40f3-baa4-f0ba90122631/content/docx?plannr_account_uuid=02047a70-d9d6-4116-9fdc-80e2045bdcc8",
      "public_sfdt_url": "https://api.plannrcrm.com/document-template/a7d67420-2ffc-4f6b-ae4c-db6496aa979a/content/sfdt?plannr_account_uuid=1e30883e-80e2-46c0-90ed-989e22b88e49",
      "public_preview_url": "https://api.plannrcrm.com/document-template/7cc1f54f-3053-4745-bd96-82435ab453a3/content/preview?plannr_account_uuid=ae0b29eb-53cb-4f00-8f1d-9dcc4b26ce4a",
      "required_dependants": {
        "client-1": "client"
      }
    }
  ]
}