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

Document → List

AI-generated

Overview

This node operation lists generated PDF documents from the PDF Generator API. It supports filtering documents by template ID, start date, end date, and pagination options such as page number and number of records per page. This operation is useful for retrieving and managing stored PDF documents generated from templates, enabling users to query documents based on specific criteria and handle large sets of documents efficiently through pagination.

Use Case Examples

  1. Retrieve all documents generated from a specific template within a date range.
  2. List documents page by page to display in a user interface.
  3. Filter documents created after a certain start date for reporting purposes.

Properties

Name Meaning
End Date Filter documents to include only those created on or before this end date (Format: Y-m-d H:i:s).
Page Page number for pagination to retrieve a specific subset of documents.
Per Page Number of document records to return per page, with a maximum of 100.
Start Date Filter documents to include only those created on or after this start date (Format: Y-m-d H:i:s).
Template ID Filter documents by the ID of the template used to generate them.

Output

JSON

  • success - Indicates if the API request was successful.
  • data - Array of document objects returned by the API, each representing a generated PDF document.
  • pagination
    • page - Current page number of the results.
    • per_page - Number of documents returned per page.
    • total_pages - Total number of pages available.
    • total_items - Total number of documents available.

Dependencies

  • PDF Generator API with an API key credential

Troubleshooting

  • Ensure the API credentials are correctly configured and valid to avoid authentication errors.
  • Verify that date filters (start_date and end_date) are in the correct format (Y-m-d H:i:s) to prevent request failures.
  • Check pagination parameters (page and per_page) to be within valid ranges to avoid errors or empty responses.
  • If no documents are returned, confirm that documents exist matching the filter criteria.

Discussion