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

Actions28

Overview

This node integrates with a PDF Generator API to manage and generate PDF documents from templates, convert HTML or URLs to PDFs, and perform various PDF-related operations such as watermarking, encryption, and optimization. Specifically, the Document - List operation retrieves a paginated list of generated PDF documents stored in the service.

Common scenarios for using this node include:

  • Retrieving a list of all generated PDF documents filtered by date range or template ID.
  • Paginating through large sets of documents to process or analyze them further.
  • Integrating document management workflows where you need to fetch metadata about generated PDFs.

Example use case:

  • A business generates invoices as PDFs using templates and wants to list all invoices created within a specific date range for reporting or archival purposes.

Properties

Name Meaning
End Date Filter documents created up to this end date (format: Y-m-d H:i:s).
Page Page number for pagination (minimum 1).
Per Page Number of records per page (between 1 and 100).
Start Date Filter documents created starting from this start date (format: Y-m-d H:i:s).
Template ID Filter documents generated from a specific template by its numeric ID.

These options allow fine control over which documents are returned and how results are paginated.

Output

The output is a JSON array where each item represents a document matching the query filters. The structure typically includes metadata about each document such as IDs, creation dates, template references, and possibly URLs or other identifiers depending on the API response.

Since this operation only lists documents, it does not return binary PDF data but rather metadata describing the documents.

Example output snippet (conceptual):

[
  {
    "id": "12345",
    "template_id": 678,
    "created_at": "2024-01-15 10:00:00",
    "name": "Invoice #1001",
    "public_url": "https://pdfservice.com/documents/12345"
  },
  ...
]

Dependencies

  • Requires an API key credential for the PDF Generator API service.
  • The node uses the base URL from the configured credentials or defaults to https://us1.pdfgeneratorapi.com/api/v4.
  • Network access to the PDF Generator API endpoint is necessary.

Troubleshooting

  • Invalid date format errors: Ensure that Start Date and End Date inputs follow the exact format Y-m-d H:i:s (e.g., 2024-06-30 23:59:59).
  • Pagination issues: If no documents appear, verify that the Page and Per Page values are set correctly and that documents exist for the specified filters.
  • Authentication errors: Confirm that the API key credential is valid and has permissions to list documents.
  • Empty results: This may indicate no documents match the filter criteria; try broadening the date range or removing the template filter.

Links and References

Discussion