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": "531b6b21-74fc-4961-83d3-a5e21ce7ab9d",
      "version": 3,
      "created_at": "2025-01-17T11:18:30+00:00",
      "updated_at": "2025-01-17T11:18:30+00:00",
      "public_pdf_url": "https://plannr.valet/document-template/b6bb3bce-9c5c-4996-9b86-0ca4ad0acf8f/content/pdf?plannr_account_uuid=8042c40b-20be-4d51-a93f-e3adc8103ff1",
      "public_docx_url": "https://plannr.valet/document-template/8044ee13-da02-4271-8e19-5b6172d7d1a0/content/docx?plannr_account_uuid=2d7d0a65-f79e-480b-a937-9eb9c8b8554b",
      "public_sfdt_url": "https://plannr.valet/document-template/aebf023a-09f0-4f63-8fb5-4a41ee360746/content/sfdt?plannr_account_uuid=6feb0e42-8a20-4cee-9c48-a7d1f8b8c172",
      "public_preview_url": "https://plannr.valet/document-template/7a459ab5-822c-439a-b205-cebd4c9fa7f6/content/preview?plannr_account_uuid=54088b64-d2f7-47d4-96f8-13c9715e5b3c",
      "required_dependants": {
        "client-1": "client"
      }
    }
  ]
}