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
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": "e4210ab1-eed0-4efe-b733-c1941e9b461c",
      "version": 3,
      "created_at": "2024-10-16T11:10:15+01:00",
      "updated_at": "2024-10-16T11:10:15+01:00",
      "public_pdf_url": "https://plannr.valet/document-template/adc719d2-6de2-4cbe-8dca-4fcd07738748/content/pdf?plannr_account_uuid=aec74398-a892-4196-8ce0-02d96a219916",
      "public_docx_url": "https://plannr.valet/document-template/a59702fd-4150-436d-a65b-bb04290a12e6/content/docx?plannr_account_uuid=5aa17c87-68ca-47cf-94e8-66df370a5096",
      "public_sfdt_url": "https://plannr.valet/document-template/0b4f9033-a2ef-495b-acea-be7cf0388ff0/content/sfdt?plannr_account_uuid=0c1b45d0-e8f4-4ae0-99bb-d14de208f7f6",
      "public_preview_url": "https://plannr.valet/document-template/5b36910c-d9e3-4976-a5c5-e251789fba22/content/preview?plannr_account_uuid=d80a3fe7-4b13-460d-834e-da6d15a71833",
      "required_dependants": {
        "client-1": "client"
      }
    }
  ]
}