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, templates, documents, conversions, and PDF services. Specifically for the Workspace - Get operation, it retrieves detailed information about a workspace identified by a unique workspace identifier (e.g., an email-like string). This is useful in scenarios where you need to fetch metadata or configuration details of a particular workspace that organizes templates and users within the PDF generation platform.

Practical examples:

  • Fetching workspace details before generating or managing templates/documents within that workspace.
  • Verifying workspace existence or properties as part of an automation workflow.
  • Integrating workspace data into other systems or reports.

Properties

Name Meaning
Workspace Identifier The unique identifier of the workspace to retrieve, typically formatted like an email (e.g., [email protected]). This identifies which workspace's details to fetch.

Output

The output JSON contains the response from the PDF Generator API for the requested workspace. It typically includes all relevant workspace details such as its identifier, name, creation date, associated users, permissions, and other metadata defined by the API.

The output structure is a JSON object representing the workspace data returned by the API endpoint /workspaces/{workspaceIdentifier}.

Example output (simplified):

{
  "id": "[email protected]",
  "name": "Example Workspace",
  "created_at": "2023-01-01T12:00:00Z",
  "users": [
    {
      "email": "[email protected]",
      "role": "admin"
    }
  ],
  "settings": { ... }
}

No binary data is involved in this operation.

Dependencies

  • Requires an active connection to the PDF Generator API service.
  • Requires an API key credential configured in n8n for authentication with the PDF Generator API.
  • The base URL defaults to https://us1.pdfgeneratorapi.com/api/v4 unless overridden in credentials.

Troubleshooting

  • Common issues:

    • Invalid or missing workspace identifier: The node requires a valid workspace identifier; ensure it is correctly provided and properly URL encoded if necessary.
    • Authentication errors: Ensure the API key credential is valid and has sufficient permissions to access workspace data.
    • Network or API downtime: Check connectivity and API status if requests fail unexpectedly.

  • Error messages:

    • "The operation "get" is not supported for resource "workspace": This indicates a misconfiguration or unsupported operation; verify the selected resource and operation.
    • HTTP 404 Not Found: The specified workspace identifier does not exist.
    • HTTP 401 Unauthorized: Authentication failed due to invalid or missing API credentials.

Links and References

Discussion