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

Actions13

Overview

This node integrates with a PDF Generator API to manage workspaces, which are organizational units for grouping templates and users. Specifically, the Workspace - List operation retrieves a paginated list of all available workspaces in the connected account.

Common scenarios where this node is beneficial include:

  • Automating the retrieval of workspace lists for reporting or synchronization purposes.
  • Managing multiple workspaces programmatically within workflows.
  • Displaying available workspaces for selection in subsequent workflow steps.

For example, you might use this node to fetch all workspaces and then iterate over them to perform batch operations on each workspace or to filter workspaces based on certain criteria.

Properties

Name Meaning
List Options Collection of options to control pagination of the workspace list:
- Page Page number for pagination (minimum 1).
- Per Page Number of records per page (minimum 1, maximum 100).

These properties allow you to specify which page of results to retrieve and how many workspaces to return per page, enabling efficient handling of large numbers of workspaces.

Output

The output is a JSON array containing workspace objects as returned by the PDF Generator API's /workspaces endpoint. Each item in the output corresponds to a workspace with its associated details (such as identifier and other metadata).

The structure of each workspace object depends on the API response but typically includes fields like workspace identifier and possibly name or description.

No binary data is output for this operation.

Example output snippet (simplified):

[
  {
    "identifier": "[email protected]",
    "name": "Example Workspace",
    ...
  },
  {
    "identifier": "[email protected]",
    "name": "Another Workspace",
    ...
  }
]

Dependencies

  • Requires an API key credential for the PDF Generator API to authenticate requests.
  • The node uses the base URL from the credentials or defaults to https://us1.pdfgeneratorapi.com/api/v4.
  • No additional environment variables or external services are required beyond the configured API authentication.

Troubleshooting

  • Empty or missing results: Ensure that the API key credential is valid and has access to the workspaces.
  • Pagination issues: If you request a page number beyond the available pages, the API may return an empty list.
  • API errors: Network issues or invalid credentials will cause errors; verify connectivity and credential correctness.
  • Invalid input values: The Page must be at least 1, and Per Page must be between 1 and 100; otherwise, the API may reject the request.

If the node throws an error indicating the operation is not supported, confirm that the resource is set to "workspace" and the operation to "list".

Links and References

Discussion