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": "a62a5681-bb67-4cdb-a1bb-192f1c1b75c8",
      "version": 3,
      "created_at": "2024-11-20T13:24:02+00:00",
      "updated_at": "2024-11-20T13:24:02+00:00",
      "public_pdf_url": "https://plannr.valet/document-template/3b333f56-611f-469f-8ee3-8ed586291227/content/pdf?plannr_account_uuid=4157b1f8-1904-4758-aaf6-1c1b1a9a4f1f",
      "public_docx_url": "https://plannr.valet/document-template/9b80a135-839f-43a0-a679-e4deb68ac724/content/docx?plannr_account_uuid=2fdb19d1-0c53-474d-b6cf-433b4f875e17",
      "public_sfdt_url": "https://plannr.valet/document-template/5bce9e64-a775-49da-ae3a-01b4773ca006/content/sfdt?plannr_account_uuid=45923fa8-9249-402c-baa1-0962385482b4",
      "public_preview_url": "https://plannr.valet/document-template/baefb4f0-bed3-405a-a792-8aca09290291/content/preview?plannr_account_uuid=423f2128-8a07-4898-ab05-6d6dc2c61d92",
      "required_dependants": {
        "client-1": "client"
      }
    }
  ]
}