avanta icon

avanta

Consume avanta API

Actions57

Company - Group → Get Many

AI-generated

Overview

This node operation retrieves multiple company groups from the Avanta API. It is useful for scenarios where you need to fetch a list of company groups, such as for reporting, data synchronization, or displaying group information in an application. For example, a user might want to get all company groups or apply filters to narrow down the results.

Use Case Examples

  1. Fetch all company groups without limit to get a complete list.
  2. Fetch a limited number of company groups for quick display or processing.
  3. Use JSON filters to retrieve company groups matching specific criteria.

Properties

Name Meaning
Request Options Options to customize the API request such as enabling debug mode, ignoring SSL certificate issues, and setting a timeout for the request.
Return All Whether to return all results or only up to a given limit.
Limit Maximum number of results to return when not returning all.
Filter Type of filter to apply to the results, either none or JSON-based filtering.
Filters (JSON) JSON string representing the filters to apply when filter type is JSON.

Output

JSON

  • companyGroups - Array of company group objects retrieved from the API.
  • debugInfo - Optional debug information about the API request if debug mode is enabled.

Dependencies

  • Requires an API key credential for authenticating with the Avanta API.

Troubleshooting

  • If the node fails due to SSL certificate issues, enable 'Ignore SSL Issues' option to bypass validation (not recommended for production).
  • Timeout errors can occur if the server is slow to respond; increase the 'Timeout' value as needed.
  • Invalid JSON in the 'Filters (JSON)' property will cause the request to fail; ensure the JSON is correctly formatted.
  • If no results are returned, verify the filter criteria or try with no filters to confirm data availability.

Links

Discussion