Skip to main content
GET
/
document-templates
/
{id}
Get a document template
curl --request GET \
  --url https://api.heffl.com/api/v2/document-templates/{id} \
  --header 'x-api-key: <api-key>'
{
  "id": "<string>",
  "name": "<string>",
  "type": "<string>",
  "isActive": true,
  "isSignatureRequired": true,
  "customFields": [
    {
      "key": "<string>",
      "label": "<string>",
      "dataType": "<string>",
      "required": true,
      "values": [
        "<string>"
      ]
    }
  ],
  "documentName": "<string>",
  "subject": "<string>"
}

Authorizations

x-api-key
string
header
required

API key for authentication. Get yours at app.heffl.com/settings/developers

Path Parameters

id
string
required

Template ID (tpl_ prefix)

Response

OK

id
string
required

Template ID (tpl_ prefix)

name
string
required

Template name

type
string
required

Document type (for example quotations, invoices)

isActive
boolean
required
isSignatureRequired
boolean
required

Whether e-signature is required on send

valueType
enum<string>
required

Content mode

Available options:
STATIC,
DYNAMIC
customFields
object[]
required
documentName
string | null

Default document title pattern

subject
string | null

Default email subject