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 templates and users. The Workspace - Get operation retrieves detailed information about a specific workspace using its unique identifier (e.g., an email-like string). This is useful when you want to fetch metadata or configuration details of a particular workspace within your PDF generation environment.

Common scenarios include:

  • Retrieving workspace details before performing template or document operations scoped to that workspace.
  • Verifying workspace existence or properties as part of workflow logic.
  • Auditing or reporting on workspace configurations programmatically.

Example: You have multiple workspaces for different teams or clients, and you want to fetch the details of a workspace identified by "user.example@domain.com" to confirm its settings or user assignments.

Properties

Name Meaning
Workspace Identifier The unique identifier of the workspace to retrieve, typically formatted like an email address (e.g., user.example@domain.com). This is required to specify which workspace's details to fetch.

Output

The output JSON contains the detailed data returned by the PDF Generator API for the requested workspace. This typically includes all relevant workspace metadata such as its identifier, name, creation date, associated users, permissions, and other configuration details as provided by the API.

The node does not produce binary data for this operation; all output is in JSON format.

Example output structure (simplified):

{
  "id": "workspace-id",
  "identifier": "user.example@domain.com",
  "name": "Example Workspace",
  "created_at": "2023-01-01T12:00:00Z",
  "users": [
    {
      "id": "user1",
      "email": "user1@example.com"
    }
  ],
  "settings": {
    // workspace-specific settings
  }
}

Dependencies

  • Requires an API key credential for 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 needed beyond the API authentication setup.

Troubleshooting

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

  • Error: Missing or invalid Workspace Identifier
    The workspace identifier is mandatory. Make sure it is provided and correctly formatted (e.g., resembling an email).

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

  • Network or API Endpoint Issues
    Confirm network connectivity and that the API endpoint is reachable. Check if the base URL is correct in the credentials.

Links and References

Discussion