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": "7d92785d-b458-466b-bfbb-dc85ee32cf47",
      "version": 3,
      "created_at": "2025-04-02T13:27:56+01:00",
      "updated_at": "2025-04-02T13:27:56+01:00",
      "public_pdf_url": "https://plannr.valet/document-template/24ebbb56-6cfd-4d5a-94f8-98bef6ee3881/content/pdf?plannr_account_uuid=99f5dd24-2b3c-447d-8461-ad6c2715a3c9",
      "public_docx_url": "https://plannr.valet/document-template/13f08826-f0d3-49e9-9ba0-d6060c5622ba/content/docx?plannr_account_uuid=84c943b0-1e5a-4367-b1e6-ee9c09aaafc8",
      "public_sfdt_url": "https://plannr.valet/document-template/97d91b13-ce30-44cb-b98b-fd84d0ad3b43/content/sfdt?plannr_account_uuid=ca925d81-f794-45c4-b9a1-9fe881c380a2",
      "public_preview_url": "https://plannr.valet/document-template/406de13b-2544-4dd7-beed-f42a9f6d4eda/content/preview?plannr_account_uuid=3ca11bd1-8b89-4cf3-827a-5e6e013d4820",
      "required_dependants": {
        "client-1": "client"
      }
    }
  ]
}