Viridem icon

Viridem

Interact's with Viridem

Actions77

Groups → List Group

AI-generated

Overview

This node interacts with the Viridem API to list groups associated with a specified company. It is useful for scenarios where you need to retrieve and manage group data within a company, such as displaying group lists in a dashboard or processing group information for further automation.

Use Case Examples

  1. Retrieve all groups for a company by providing the company ID.
  2. Use batching options to handle large sets of group data efficiently by splitting requests into batches.

Properties

Name Meaning
Company Id The unique identifier of the company for which groups are to be listed. This is a required numeric input.
Request Options Additional settings to control the request behavior, including batching, SSL certificate validation, proxy configuration, and request timeout.

Output

JSON

  • groups - An array of group objects retrieved from the Viridem API for the specified company.

Dependencies

  • Viridem API OAuth2 credentials for authentication

Troubleshooting

  • Ensure the Company Id is correctly provided and is a valid number; missing or invalid IDs will cause request failures.
  • If SSL certificate validation fails and the 'Ignore SSL Issues' option is not enabled, the request will be blocked; enable this option only if you trust the source.
  • Proxy settings must be correctly configured if used; incorrect proxy details can cause connection errors.
  • Timeout settings should be adjusted based on network conditions; too short a timeout may abort valid requests prematurely.

Discussion