avanta icon

avanta

Consume avanta API

Actions57

Company - Role → Get Many

AI-generated

Overview

This node operation retrieves multiple company roles from the Avanta API. It is useful for scenarios where you need to fetch a list of roles associated with companies, such as for managing user permissions or organizational structure within a company. For example, you might use this operation to get all roles to display in a user interface or to process role-based access control logic.

Use Case Examples

  1. Fetch all company roles to display in an admin dashboard.
  2. Retrieve a limited number of company roles for processing in a workflow.

Properties

Name Meaning
Request Options Options to customize the API request behavior, including debug mode, SSL certificate validation, and request timeout.
Return All Whether to return all results or only up to a given limit.
Limit Maximum number of results to return.
Filter Type of filter to apply to the results, either none or JSON-based filter.
Filters (JSON) JSON string representing the filter criteria to apply when retrieving company roles.

Output

JSON

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

Dependencies

  • Avanta API with API key credential

Troubleshooting

  • If the API request fails due to SSL issues, enable 'Ignore SSL Issues' option to bypass certificate validation (not recommended for production).
  • If no results are returned, check the filter JSON syntax and criteria to ensure they match the API's expected format.
  • Timeout errors can occur if the server is slow to respond; increase the timeout value in request options if needed.

Links

Discussion