Viridem icon

Viridem

Interact's with Viridem

Actions77

Templates → List Forms Template

AI-generated

Overview

This node operation lists form templates from the Viridem API for a specified company. It allows filtering and customization of the returned data by including fields, metadata, and availability status. This is useful for scenarios where you need to retrieve and manage form templates programmatically, such as integrating form templates into workflows or displaying them in a custom interface.

Use Case Examples

  1. Retrieve all form templates for a company with ID 123, including detailed fields and metadata.
  2. Filter form templates to only those available for adding new entries.

Properties

Name Meaning
Company Id The unique identifier of the company for which to list form templates. This is a required numeric input.
Include Fields Boolean flag to include detailed fields of the form templates in the response.
Include Metadata Boolean flag to include metadata information of the form templates in the response.
Is Available For Add Boolean filter to include only templates that are available for adding new entries.

Output

JSON

  • id - The unique identifier of the form template.
  • name - The name of the form template.
  • fields - The fields included in the form template, if requested.
  • metadata - Additional metadata about the form template, if requested.
  • isAvailableForAdd - Indicates if the template is available for adding new entries.

Dependencies

  • Viridem API with OAuth2 authentication

Troubleshooting

  • Ensure the Company Id is valid and corresponds to an existing company in the Viridem system.
  • If the API returns authentication errors, verify that the OAuth2 credentials are correctly configured and have the necessary permissions.
  • Timeouts or SSL errors can be addressed by adjusting the request options such as timeout duration, proxy settings, or allowing unauthorized SSL certificates.

Discussion