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

Headers

  • X-PLANNR-ACCOUNT-UUID string

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]
      Hide data attributes Show data attributes object
      • uuid string

        The UUID of the resource.

      • created_at string

        The timestamp of when the resource was created.

      • updated_at string

        The timestamp of when the resource was updated.

      • version integer

        The document builder version. Used for internal purposes only. Defaults to 3

      • name string

        The name of the document template.

      • required_dependants object

        The required dependant variables of the document template.

        Hide required_dependants attribute Show required_dependants attribute object
        • client-1 string
      • public_docx_url string

        The download URL of the DOCX content. This is intended for the user to download if they are signed into Plannr. You can access this data via the API using the route in /api/v1.

      • public_sfdt_url string

        The download URL of the SFDT (SyncFusion) content. This is intended for the user to download if they are signed into Plannr. You can access this data via the API using the route in /api/v1.

      • public_pdf_url string

        The download URL of the PDF content. This is intended for the user to download if they are signed into Plannr. You can access this data via the API using the route in /api/v1.

      • public_preview_url string

        The image preview URL of the template. This is intended for the user to preview the template before opening it. You can access this data via the API using the route in /api/v1.
GET /api/v1/document-template 
curl \
 --request GET 'https://api.plannrcrm.com/api/v1/document-template' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200) 
{
  "data": [
    {
      "name": "Welcome Template",
      "uuid": "02ce45ba-c2e5-42e9-abad-d147d40bfea4",
      "version": 3,
      "created_at": "2026-04-08T15:40:47+01:00",
      "updated_at": "2026-04-08T15:40:47+01:00",
      "public_pdf_url": "https://api.plannrcrm.com/document-template/fcb5dabe-2972-4ef1-b8e8-4c0082aa08c9/content/pdf?plannr_account_uuid=48566d8c-2eac-4e48-acd0-91f33627c0af",
      "public_docx_url": "https://api.plannrcrm.com/document-template/2478e469-e9b4-4c3c-b280-a0dd80e07dd8/content/docx?plannr_account_uuid=25c229f0-9706-4497-b95c-da28290c46e2",
      "public_sfdt_url": "https://api.plannrcrm.com/document-template/561d48ec-8929-49d0-910d-23a2ed57b9d5/content/sfdt?plannr_account_uuid=a12dd4fe-7103-4884-80e9-86ea8c39b2f4",
      "public_preview_url": "https://api.plannrcrm.com/document-template/06e313b6-1366-447c-99e2-7193c4eb6d3f/content/preview?plannr_account_uuid=b5474eda-cc59-44fd-896a-8a7c09516605",
      "required_dependants": {
        "client-1": "client"
      }
    }
  ]
}