Autotask icon

Autotask

Consume Autotask REST API
Join our community

Actions389

Overview

This node operation retrieves multiple Contact Groups from the Autotask system using an advanced filtering mechanism. It allows users to specify complex query criteria in JSON format to filter the contact groups returned. Users can choose to return all matching records or limit the number of records returned. Additional options include adding human-readable labels for picklist and reference fields, selecting specific columns to include in the response, and flattening user-defined fields for easier access. This operation is useful for scenarios where precise and customized retrieval of contact group data is needed, such as syncing contact groups with other systems, reporting, or targeted communications.

Properties

Name Meaning
Get All Determines whether to return all matching contact group records or limit the results to a specified maximum number.
Max Records Specifies the maximum number of contact group records to return when 'Get All' is set to false. The value must be between 1 and 500.
Advanced Filter A required JSON string containing a 'filter' array that defines the query criteria according to the Autotask API specification. This filter controls which contact groups are retrieved.
Add Picklist Labels If enabled, adds additional fields with '_label' suffix containing human-readable labels for picklist fields in the response.
Add Reference Labels If enabled, adds additional fields with '_label' suffix containing human-readable labels for reference fields in the response.
Select Columns Names or IDs. Allows selection of specific fields to include in the response. If no fields are selected, all fields are returned. The ID field is always included.
Flatten User-Defined Fields If enabled, user-defined fields (UDFs) are moved to the top level of each returned object instead of being nested inside a 'userDefinedFields' array.

Output

JSON

  • id - Unique identifier of the contact group.
  • name - Name of the contact group.
  • description - Description of the contact group.
  • picklistField_label - Human-readable label for a picklist field, if 'Add Picklist Labels' is enabled.
  • referenceField_label - Human-readable label for a reference field, if 'Add Reference Labels' is enabled.
  • userDefinedFields - Array of user-defined fields associated with the contact group, unless 'Flatten User-Defined Fields' is enabled.
  • userDefinedFieldName - User-defined field accessible at the top level if 'Flatten User-Defined Fields' is enabled.

Dependencies

  • Requires an Autotask API key credential for authentication to access the Autotask REST API.

Troubleshooting

  • Invalid JSON in 'Advanced Filter' property can cause query failures. Ensure the JSON string is correctly formatted and follows Autotask API filter specifications.
  • Requesting too many records without pagination or 'Get All' enabled may lead to timeouts or API limits being exceeded.
  • Selecting non-existent fields in 'Select Columns' may result in errors or missing data.
  • If labels are not appearing as expected, verify that 'Add Picklist Labels' and 'Add Reference Labels' options are enabled and that the fields support labels.
  • Flattening user-defined fields may cause naming conflicts if UDF names overlap with standard fields.

Links

Discussion