Viridem icon

Viridem

Interact's with Viridem

Actions77

Templates → List Template

AI-generated

Overview

This node operation lists templates from the Viridem API for a specified company. It supports pagination, keyword filtering, and options to include additional fields and metadata in the response. It is useful for retrieving and managing template data within a company's context, such as displaying available templates or processing them further in workflows.

Use Case Examples

  1. Retrieve a paginated list of templates for a company with specific keywords to filter results.
  2. Fetch templates including their fields and metadata for detailed processing or display.

Properties

Name Meaning
Company Id The ID of the company to list templates for. This is a required numeric input.
Page The page number of the results to retrieve, used for pagination.
Per Page The number of templates to retrieve per page, controlling the page size.
Keywords Keywords to filter the templates by, allowing search within template data.
Include Fields Boolean flag to include template fields in the response.
Include Metadata Boolean flag to include metadata about the templates in the response.
Is Available For Add Boolean filter to list only templates that are available for adding.

Output

JSON

  • templates - Array of template objects returned from the API, containing template details and optionally fields and metadata based on input options.

Dependencies

  • Viridem API OAuth2 credentials for authentication

Troubleshooting

  • Ensure the Company Id is provided and valid, as it is required for the API call.
  • Check network connectivity and API base URL configuration in credentials to avoid request failures.
  • If pagination parameters (Page, Per Page) are out of range, the API may return empty results or errors.
  • Boolean input fields must be correctly set to true or false to control inclusion of fields and metadata properly.

Discussion