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
Join our community

Actions13

Overview

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

Typical use cases include:

  • Retrieving all workspaces to display or process them further.
  • Automating workspace management workflows by fetching current workspace data.
  • Integrating workspace information into broader document generation or template management processes.

For example, you might use this node to fetch all workspaces before assigning templates or users programmatically.

Properties

Name Meaning
List Options Collection of pagination options:
  Page Page number to retrieve (minimum 1).
  Per Page Number of records per page (minimum 1, maximum 100).

These properties allow controlling the pagination of the workspace list results.

Output

The output is a JSON array where each item represents a workspace object as returned by the PDF Generator API. Each workspace object typically includes details such as its identifier and other metadata provided by the API.

The node does not output binary data for this operation.

Example output structure (simplified):

[
  {
    "id": "workspace-identifier-1",
    "name": "Workspace One",
    "created_at": "2023-01-01T12:00:00Z",
    ...
  },
  {
    "id": "workspace-identifier-2",
    "name": "Workspace Two",
    "created_at": "2023-02-01T12:00:00Z",
    ...
  }
]

Dependencies

  • Requires an API key credential for the PDF Generator API.
  • The node makes authenticated HTTP GET requests to the /workspaces endpoint of the API.
  • Pagination parameters (page, per_page) are passed as query string parameters.

Troubleshooting

  • Empty or missing results: Ensure that the API key has sufficient permissions to list workspaces.
  • Invalid pagination values: The page must be ≥ 1 and per_page between 1 and 100. Providing invalid values may cause errors or unexpected results.
  • API connection errors: Verify network connectivity and that the API base URL is correct.
  • Unhandled operation error: If the node throws an error stating the operation is unsupported, confirm that the resource is set to "Workspace" and operation to "List".

Links and References

Discussion