List fillable document templates and their fields

GET /api/v1/documents/contracts/templates

List fillable document templates and their fields

cURL

curl --request GET \
  --url https://api.hevn.finance/api/v1/documents/contracts/templates

import requests

url = "https://api.hevn.finance/api/v1/documents/contracts/templates"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://api.hevn.finance/api/v1/documents/contracts/templates', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

200

{
  "templates": [
    {
      "title": "<string>",
      "description": "<string>",
      "requiresDocument": false,
      "supportsContractGeneration": false,
      "supportsInvoicing": false,
      "fields": [
        {
          "key": "<string>",
          "label": "<string>",
          "type": "string",
          "description": "<string>",
          "required": false,
          "multiline": false,
          "source": "user",
          "options": [
            "<string>"
          ],
          "fields": [
            "<unknown>"
          ],
          "item": null
        }
      ]
    }
  ]
}

Response

200 - application/json

Successful Response

List of fillable document templates.

templates · TemplateDescriptor · object[] · required

Show child attributes