Get document templates

GET /api/v1/document-template

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]

      Additional properties are allowed.
GET /api/v1/document-template 
curl \
 -X GET https://api.plannrcrm.com/api/v1/document-template \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -H "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200) 
{
  "data": [
    {
      "name": "Welcome Template",
      "uuid": "7615217a-f8aa-4ee1-8640-7f84648cc2ae",
      "version": 3,
      "created_at": "2025-01-24T22:40:38+00:00",
      "updated_at": "2025-01-24T22:40:38+00:00",
      "public_pdf_url": "https://plannr.valet/document-template/32428c82-9713-4365-9992-6dbe282d1d47/content/pdf?plannr_account_uuid=7cd20a13-7390-4ecc-b0ab-68a599a8ff76",
      "public_docx_url": "https://plannr.valet/document-template/ef2c7db4-22bf-4ef1-966d-2fb3e930efa7/content/docx?plannr_account_uuid=e81862e8-9788-4cf4-b4cc-cac39563fec9",
      "public_sfdt_url": "https://plannr.valet/document-template/8b263a71-d9ec-40f1-9469-3aeb15daa79d/content/sfdt?plannr_account_uuid=25913ae8-5ee5-47b1-a2bc-35003d4cf482",
      "public_preview_url": "https://plannr.valet/document-template/b63214c9-793d-4ad6-b352-9016f6d71c27/content/preview?plannr_account_uuid=33b101fc-8b37-45a7-b536-256939c4fc5c",
      "required_dependants": {
        "client-1": "client"
      }
    }
  ]
}