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

Overview

This node integrates with a PDF Generator API to manage workspaces, templates, documents, conversions, and PDF services. Specifically for the Workspace - List operation, it retrieves a paginated list of all workspaces available in the connected PDF Generator account.

Common scenarios where this node is beneficial include:

  • Organizing PDF templates and users into separate workspaces.
  • Retrieving workspace information for administrative or reporting purposes.
  • Automating workflows that require fetching workspace lists before performing further actions like template management or document generation.

Example use case:

  • An organization uses multiple workspaces to separate projects or departments. This node can list all workspaces so that subsequent nodes can operate on specific workspaces based on their identifiers.

Properties

Name Meaning
Page Page number for pagination (minimum 1).
Per Page Number of records per page (minimum 1, maximum 100).

These properties are part of the "List Options" collection and allow controlling pagination when listing workspaces.

Output

The output JSON contains an array of workspace objects as returned by the PDF Generator API's /workspaces endpoint. Each item typically includes details such as workspace identifier, name, and other metadata defined by the API.

The exact structure depends on the API response but generally includes fields identifying each workspace.

No binary data is output for this operation.

Dependencies

  • Requires an active connection to the PDF Generator API via an API key credential configured in n8n.
  • The node makes authenticated HTTP requests to the API base URL (defaulting to https://us1.pdfgeneratorapi.com/api/v4).
  • Pagination parameters (page, per_page) control the amount of data retrieved per request.

Troubleshooting

  • Empty or missing results: Ensure the API credentials are valid and have permission to access workspace data.
  • Invalid pagination values: The Page must be ≥ 1, and Per Page must be between 1 and 100; otherwise, the API may reject the request.
  • API errors: If the API returns errors, check network connectivity and verify the API key is correct and not expired.
  • Unhandled operation error: If the node throws an error stating the operation is not supported, confirm that the resource is set to "Workspace" and operation to "List".

Links and References


This summary focuses exclusively on the Workspace resource with the List operation as requested.

Discussion