Get document templates

GET /api/v1/document-template
Personal access token & O auth2

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
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": "4c8cc1fa-9ac6-4e2e-8c98-bb7189b59417",
      "version": 3,
      "created_at": "2025-04-22T13:44:19+01:00",
      "updated_at": "2025-04-22T13:44:19+01:00",
      "public_pdf_url": "https://plannr.valet/document-template/53328b8d-342b-43c8-99d2-6f23933cd10c/content/pdf?plannr_account_uuid=712c4fa4-358c-4e80-9312-99e79a11414a",
      "public_docx_url": "https://plannr.valet/document-template/c431b139-56ac-465a-97e4-bc4c9a4f6a4d/content/docx?plannr_account_uuid=7399ab8b-64db-459a-9a7f-fbb53945bff6",
      "public_sfdt_url": "https://plannr.valet/document-template/c4fc18ae-24f3-4ef9-8010-3a9cca1653f3/content/sfdt?plannr_account_uuid=2ef644fe-b68b-40fc-a2d3-63659a121736",
      "public_preview_url": "https://plannr.valet/document-template/494fb04a-de0b-4eef-93f8-517ad72bb44b/content/preview?plannr_account_uuid=4e58703e-e029-4e0c-8538-838ba579a61a",
      "required_dependants": {
        "client-1": "client"
      }
    }
  ]
}