PDF Generator API

Overview

This node integrates with a PDF Generator API to perform various PDF-related operations, including generating PDFs from templates or HTML content, converting URLs to PDFs, managing PDF documents and templates, processing existing PDFs (e.g., watermarking, encryption), and managing workspaces for organizing templates and users.

Specifically, the Workspace - Get operation retrieves details of a workspace by its unique identifier. This is useful when you want to fetch information about a particular workspace, such as its configuration or metadata, identified by an email-like string or other unique identifier.

Common scenarios:

• Retrieving workspace details to verify its existence or properties before performing further actions.
• Integrating workspace data into workflows that manage PDF templates or user access.
• Auditing or reporting on workspace configurations.

Example:
You have multiple workspaces for different teams or clients, each identified by a unique identifier like team.alpha@example.com. Using this node's Workspace Get operation, you can fetch the details of a specific workspace to display or use in your automation.

Properties

Output

The output JSON contains the workspace details returned by the API for the specified workspace identifier. The exact structure depends on the API response but typically includes fields describing the workspace's properties such as its identifier, name, creation date, users, permissions, or other metadata.

The node does not output binary data for this operation.

Example output JSON (simplified):

{
  "id": "user.example@domain.com",
  "name": "Example Workspace",
  "created_at": "2023-01-01T12:00:00Z",
  "users": [
    {
      "email": "user1@example.com",
      "role": "admin"
    }
  ],
  "settings": {
    "someSetting": true
  }
}

Dependencies

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

Troubleshooting

• Error: "The operation 'get' is not supported for resource 'workspace'"
  This indicates a misconfiguration or unsupported operation/resource combination. Verify that the Resource is set to "Workspace" and Operation to "Get".

• Error: Invalid or missing Workspace Identifier
  Ensure the Workspace Identifier property is provided and correctly formatted (e.g., an email-like string). It must be URL-encoded if it contains special characters.

• Authentication errors
  Confirm that the API key credential is valid and has sufficient permissions to access workspace data.

• Network or API errors
  Check network connectivity and API service status. Review error messages for rate limits or quota issues.

Links and References

• PDF Generator API Documentation (general reference for API endpoints and features)
• n8n Documentation on Credentials (for setting up API key credentials)

This summary focuses on the Workspace resource and the Get operation as requested.