Get

[POST] .../v1/docprintform/get

Returns print form information. Use this method to list document print form templates before linking them through PrintFormType or before preparing a form with DocPrintForm/Prepare. The response returns DocPrintForm records and supports filters by id and version. include_data controls whether template data is returned for version 1 and remains a body option, not a filter. The current request user must have print form select permission; missing body, denied access, invalid filters, invalid version, invalid stored file references, missing CDN files and database failures are returned as HTTP 200 ErrorResult business errors.

Request Parameters

Name Type Required Description
filters Array of Filter Optional Optional filters by fields available for this API method.
include_data Boolean Optional Set to true to include template data in the response. Default value is false.

Filterable Fields

Field Type Description
id int Optional filter by print form IDs. When omitted, all forms matching version are returned.
version int Storage version filter and response mode: 1 returns inline templates, 2 returns common-file templates as URLs. Default value is 1.

Request Example

{
  "filters": [
    {
      "field": "id",
      "operator": "Equal",
      "value": "1001"
    },
    {
      "field": "version",
      "operator": "Equal",
      "value": "2"
    }
  ],
  "include_data": true
}

Response Parameters

Name Type Description
ok Boolean Indicates whether the request completed successfully.
result Array of DocPrintForm Result array.

Response Example

{
  "ok": true,
  "result": [
    {
      "id": 1001,
      "name": "Purchase invoice",
      "data": "https://cdn.example.test/printforms/purchase-invoice.rtf",
      "version": 2,
      "last_update": 1767225600
    }
  ]
}