Autotask icon

Autotask

Consume Autotask REST API
Join our community

Actions389

Overview

This node operation retrieves multiple contact group contacts from the Autotask system using an advanced filtering mechanism. It allows users to specify complex query criteria in JSON format to filter the contact group contacts returned. This is useful for scenarios where you need to extract a customized list of contacts belonging to contact groups based on specific conditions, such as filtering by group attributes, contact details, or other metadata. For example, a user might want to get all contacts in certain groups that meet particular criteria for targeted communications or reporting.

Properties

Name Meaning
Get All Determines whether to return all matching contact group contacts or limit the results to a specified maximum number.
Max Records Specifies the maximum number of contact group contacts to return when 'Get All' is false. The value must be between 1 and 500.
Advanced Filter A required JSON string containing a 'filter' array that defines the Autotask API query criteria to filter contact group contacts. This allows for complex and precise filtering based on Autotask's query syntax.
Add Picklist Labels If enabled, adds additional fields with '_label' suffix for picklist fields to provide human-readable values alongside the raw data.
Add Reference Labels If enabled, adds additional fields with '_label' suffix for reference fields to provide human-readable values.
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 contact.
  • contactGroupId - Identifier of the contact group to which the contact belongs.
  • contactId - Identifier of the contact.
  • userDefinedFields - Array of user-defined fields associated with the contact group contact, unless flattened.
  • picklistField_label - Human-readable label for picklist fields, if 'Add Picklist Labels' is enabled.
  • referenceField_label - Human-readable label for reference fields, if 'Add Reference Labels' is enabled.
  • otherFields - Other standard and custom fields returned based on the selected columns and filter criteria.

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 well-formed and follows Autotask API query syntax.
  • Requesting too many records without 'Get All' enabled may result in incomplete data. Use 'Get All' to retrieve all matching records or increase 'Max Records' within allowed limits.
  • Selecting fields that do not exist or are misspelled in 'Select Columns' may cause errors or missing data in the response.
  • If labels for picklist or reference fields are not appearing, verify that 'Add Picklist Labels' and 'Add Reference Labels' are enabled and that the fields have non-empty values.
  • API authentication errors may occur if the Autotask API key credential is missing, invalid, or expired. Verify credentials in node settings.

Links

Discussion