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

Actions21

Workspace → List

AI-generated

Overview

This node operation lists workspaces from the PDF Generator API. It supports pagination through 'Page' and 'Per Page' options, allowing users to retrieve a specific page of workspace records with a defined number of records per page. This is useful for managing and organizing multiple workspaces, especially in environments where templates and users are grouped by workspace.

Use Case Examples

  1. List all workspaces with default pagination (page 1, 15 records per page).
  2. Retrieve the second page of workspaces with 50 records per page.

Properties

Name Meaning
Page Page number for pagination, specifying which page of workspace records to retrieve.
Per Page Number of workspace records to retrieve per page, with a maximum of 100.

Output

JSON

  • success - Indicates if the API request was successful.
  • page - Current page number of the workspace list.
  • per_page - Number of records per page returned.
  • total - Total number of workspace records available.
  • workspaces - Array of workspace objects, each representing a workspace with its details.

Dependencies

  • Requires an API key credential for the PDF Generator API to authenticate requests.

Troubleshooting

  • Ensure the API key credential is correctly configured and has permissions to access workspace data.
  • Verify that the 'Page' and 'Per Page' values are within valid ranges (Page >= 1, Per Page between 1 and 100).
  • Common error messages may include authentication errors if the API key is invalid or missing, or validation errors if pagination parameters are out of range.

Discussion