Viridem icon

Viridem

Interact's with Viridem

Actions77

Templates → Get By Id Template

AI-generated

Overview

This node operation retrieves a specific template by its ID from the Viridem API. It is useful for scenarios where you need to fetch detailed information about a particular template within a company, including optional fields and metadata. For example, it can be used in automation workflows to dynamically load template details for processing or display.

Use Case Examples

  1. Fetch a template by its ID to display its details in a dashboard.
  2. Retrieve template metadata for auditing or reporting purposes.

Properties

Name Meaning
Company Id The unique identifier of the company to which the template belongs. Required to specify the context for the template retrieval.
Template Id The unique identifier of the template to retrieve. This is the primary key to fetch the specific template.
Include Fields Boolean flag to indicate whether to include the template's fields in the response. Useful to get detailed field-level data.
Include Metadata Boolean flag to indicate whether to include metadata about the template in the response. Useful for additional context or auditing.

Output

JSON

  • template
    • id - The unique identifier of the retrieved template.
    • name - The name of the retrieved template.
    • fields - The fields included in the template, if requested.
    • metadata - Metadata information about the template, if requested.

Dependencies

  • Viridem OAuth2 API credential for authentication with the Viridem service.

Troubleshooting

  • Ensure that the Company Id and Template Id are correctly specified and exist in the Viridem system to avoid 'not found' errors.
  • If the API returns authentication errors, verify that the OAuth2 credentials are correctly configured and valid.
  • Network issues or SSL certificate problems can be mitigated by using the 'Ignore SSL Issues' option or configuring a proper proxy if needed.

Discussion