Autotask icon

Autotask

Interact with Kaseya's Autotask PSA REST API to manage companies, tickets, contracts, and more.

Actions524

Contact Groups → Get Many (Advanced)

AI-generated

Overview

This node operation retrieves multiple contact groups from the Autotask PSA system using advanced filtering criteria. It is useful for scenarios where users need to fetch a customized list of contact groups based on specific query filters, such as in customer relationship management or contact organization tasks. For example, a user can retrieve all contact groups that meet certain conditions defined in a JSON filter, optionally limiting the number of records returned or fetching all available records.

Use Case Examples

  1. Retrieve all contact groups with a specific attribute using an advanced JSON filter.
  2. Fetch a limited number of contact groups for reporting or integration purposes.

Properties

Name Meaning
Get All Whether to return all results or only up to a given limit (returnAll boolean). Defaults to false.
Max Records Maximum number of contact group records to return when 'Get All' is false. Range is 1 to 500.
Advanced Filter A JSON string containing a 'filter' array with Autotask API query criteria to filter the contact groups retrieved.
Add Picklist Labels Whether to automatically add '_label' fields for picklist fields with human-readable values in the response.
Add Reference Labels Whether to automatically add '_label' fields for reference fields with human-readable values in the response.
Select Columns Names or IDs. Choose which fields to include in the response. If no fields are selected, all fields will be returned. The ID field is always included regardless of selection.
Flatten User-Defined Fields Whether to bring user-defined fields up to the top level of each object, making them accessible as top-level properties instead of nested in the userDefinedFields array.

Output

JSON

  • id - Unique identifier of the contact group.
  • name - Name of the contact group.
  • description - Description of the contact group.
  • userDefinedFields - Array of user-defined fields associated with the contact group, if not flattened.
  • _label - Additional human-readable labels for picklist or reference fields if enabled.

Dependencies

  • An API key credential for Autotask PSA REST API authentication.

Troubleshooting

  • Ensure the advanced filter JSON string is correctly formatted and contains a valid 'filter' array as per Autotask API documentation.
  • If the node returns no results, verify the filter criteria to ensure it matches existing contact groups.
  • Check API credentials and permissions to confirm access to contact groups data.
  • If the 'Max Records' limit is set too low, increase it or enable 'Get All' to retrieve more records.

Links

Discussion