AvantGuard - WebhookSite icon

AvantGuard - WebhookSite

AvantGuard - WebhookSite

Actions100

Overview

The node is designed to retrieve folders from a knowledge base or document management system, supporting filtering and pagination. It is useful when you want to programmatically access folder metadata, for example, to list all folders matching certain criteria, or to integrate folder data into workflows such as content management, reporting, or synchronization with other systems.

Typical use cases include:

  • Fetching folders by name or company association.
  • Paginating through large sets of folders.
  • Filtering folders that belong specifically to a company.

Properties

Name Meaning
Additional Query Parameters Optional filters and pagination controls:
- Name: Filter folders by their name.
- Company Id: Filter folders by the associated company ID.
- In Company: When true, only returns folders specific to a company.
- Page: The page number of results to retrieve (for pagination).
- Page Size: Number of results per page (for pagination).

Output

The node outputs JSON data representing the retrieved folders. Each item in the output corresponds to a folder object containing its metadata as returned by the API. The exact structure depends on the external service's response but typically includes folder identifiers, names, company associations, and other relevant attributes.

No binary data output is indicated.

Dependencies

  • Requires an API key credential for authentication with the external service.
  • The node uses a base URL configured via credentials to make HTTP requests.
  • Depends on the @avantguardllc/n8n-openapi-node package for building request properties and handling OpenAPI specifications.

Troubleshooting

  • Empty Results: If no folders are returned, verify that the filter parameters (e.g., name, company ID) are correct and that the user has access rights.
  • Authentication Errors: Ensure the API key or authentication token is valid and correctly configured in the node credentials.
  • Pagination Issues: If not all folders are retrieved, check the page and page_size parameters to paginate through all available data.
  • Invalid Parameter Values: Passing incorrect types (e.g., string instead of number for company ID) may cause errors; ensure parameter types match expected formats.

Links and References

  • Refer to the external API documentation for detailed information about folder resource fields and query parameters.
  • Consult n8n documentation on how to configure API credentials and use collection-type input properties.

Discussion