Get document templates

GET /api/v1/document-template
Personal access token & OAuth2

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 \
 --request GET https://api.plannrcrm.com/api/v1/document-template \
 --header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 --header "Content-Type: application/json" \
 --header "Accept: application/json" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200) 
{
  "data": [
    {
      "name": "Welcome Template",
      "uuid": "838db65d-e23d-447a-a430-4b8345ccf811",
      "version": 3,
      "created_at": "2025-02-20T10:13:03+00:00",
      "updated_at": "2025-02-20T10:13:03+00:00",
      "public_pdf_url": "https://plannr.valet/document-template/d53a4179-4d7d-4a3f-bc60-e6c33f708a2f/content/pdf?plannr_account_uuid=20015fcd-3fdf-4541-807e-4ca19c97250b",
      "public_docx_url": "https://plannr.valet/document-template/5bf421d9-4bae-43c9-a27d-536542eefea7/content/docx?plannr_account_uuid=da99a705-0f84-4f06-8d5c-287872da304c",
      "public_sfdt_url": "https://plannr.valet/document-template/c0d62510-658f-45a8-aea1-3ba7ff0c004e/content/sfdt?plannr_account_uuid=1b484523-bf02-4b0c-9bd4-29b005190880",
      "public_preview_url": "https://plannr.valet/document-template/fc26fab9-2457-4b54-be03-8df798fcac55/content/preview?plannr_account_uuid=ede21fb9-e707-43b9-b9af-3edd9853e2db",
      "required_dependants": {
        "client-1": "client"
      }
    }
  ]
}