Templates

List templates

Receive a list of available document templates. You can add new templates under Templates in GetAccept. Without a folder_id the templates in the root folder are returned, unless showall is true; folder_id takes precedence over showall. Up to 1000 templates are returned, and private templates owned by other users are excluded.

The communication_template_id field is only included when with_communication_template=true is set, and is omitted for templates with no linked communication template.

The name_template field is only included when the template has a contract name configured. It is the raw template and may contain the merge tags {{entity.company_name}}, {{document.company_name}}, {{document.id}}, {{document.unique_id}} and {{date}}. When you pass it as name to Create a document, {{document.company_name}} is replaced with the top-level company_name you send, {{document.id}} with the new document id and {{document.unique_id}} with its unique ID, or removed when the company has no unique ID counter; replace the remaining tags yourself before sending.

get/v1/templates

Request

  • Base URL: https://api.getaccept.com
  • URL: https://api.getaccept.com/v1/templates
  • Auth: HTTP bearer

Query parameters

folder_idstring

Get the templates of a specific folder. Takes precedence over showall; without either, the templates in the root folder are returned.

showallstring

Get all templates, in every folder: true or false.

with_communication_templatestring

Include the linked communication template id for each template in the response. Templates without a linked communication template omit the field. Values: true or false.

Response

The request succeeded.

Changes

No recorded changes to this operation across all 1 revision of this API.