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": "efcbfdac-54a4-4675-bd86-8490bbfd87ef",
      "version": 3,
      "created_at": "2025-08-27T17:31:26+01:00",
      "updated_at": "2025-08-27T17:31:26+01:00",
      "public_pdf_url": "https://api.plannrcrm.com/document-template/90f5ad78-1afc-452f-9994-d5b16b0bea33/content/pdf?plannr_account_uuid=cef3792e-43fd-4123-b308-27784244477c",
      "public_docx_url": "https://api.plannrcrm.com/document-template/31b17d2b-3cb0-41c9-a2ec-5c7098fd000e/content/docx?plannr_account_uuid=fd37d750-e5a5-4fc1-9a1e-4346ff7934c6",
      "public_sfdt_url": "https://api.plannrcrm.com/document-template/b52a6233-1ced-4713-9525-a63d804aab20/content/sfdt?plannr_account_uuid=b17cabcf-855d-474b-ae39-ae2f7cac9e63",
      "public_preview_url": "https://api.plannrcrm.com/document-template/ee95adcd-ab1e-47a4-ad8c-cc61b2e2c98b/content/preview?plannr_account_uuid=cb90d59f-8e5c-4c55-83c0-b975cfe647dd",
      "required_dependants": {
        "client-1": "client"
      }
    }
  ]
}