PDF Generator API icon

PDF Generator API

Generate PDFs, manage templates, convert HTML/URLs to PDF, and perform PDF operations like watermarking, encryption, and optimization

Actions21

Template → Get

AI-generated

Overview

This node operation retrieves a specific PDF template by its ID from the PDF Generator API. It is useful when you need to fetch the details or configuration of an existing template for viewing, editing, or further processing within an automation workflow.

Use Case Examples

  1. Fetch a template by selecting it from a list or entering its ID directly to review its layout and data fields before generating documents.
  2. Use the retrieved template data to update or validate the template configuration in subsequent steps.

Properties

Name Meaning
Template Select the template to work with, either from a searchable list or by entering the template ID directly. This property is required for the 'Get' operation on the 'Template' resource.

Output

JSON

  • id - The unique identifier of the template.
  • name - The name of the template.
  • tags - Tags associated with the template for categorization.
  • isDraft - Indicates if the template is a draft.
  • layout - Layout configuration details of the template including format, orientation, and margins.
  • pages - Array of pages that make up the template, including components and layout details.
  • dataSettings - Settings related to data sorting, filtering, and transformation for the template.
  • editor - Editor settings such as height multiplier.
  • fontSubsetting - Boolean indicating if font subsetting is enabled.
  • barcodeAsImage - Boolean indicating if barcodes are rendered as images.

Dependencies

  • An API key credential for the PDF Generator API is required to authenticate requests.

Troubleshooting

  • Ensure the template ID is a valid numeric string as required by the input validation regex.
  • If the template is not found, verify that the template ID exists and that the API credentials have sufficient permissions.
  • Handle JSON parsing errors gracefully by ensuring the template configuration is valid JSON.

Links

Discussion