Autotask icon

Autotask

Consume Autotask REST API
Join our community

Actions389

Overview

This node operation retrieves detailed information about a specific Contact Group from the Autotask system using its unique Contact Group ID. It is useful for scenarios where you need to fetch and utilize contact group data within your workflows, such as syncing contact groups with other systems, reporting, or automation tasks that depend on group membership or attributes.

Properties

Name Meaning
Contact Group ID The unique identifier of the contact group to retrieve. This is required to specify which contact group the operation will fetch.
Add Picklist Labels Determines whether to automatically add human-readable "_label" fields for picklist fields in the response. This helps in understanding picklist values without needing to decode their IDs.
Add Reference Labels Determines whether to automatically add human-readable "_label" fields for reference fields in the response, making reference data easier to interpret.
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 regardless of selection.
Flatten User-Defined Fields When enabled, user-defined fields (UDFs) are brought to the top level of the returned object instead of being nested inside a userDefinedFields array, simplifying access to these fields.

Output

JSON

  • id - The unique identifier of the contact group.
  • name - The name of the contact group.
  • description - Description or notes about the contact group.
  • picklistField_label - Human-readable labels for picklist fields, if Add Picklist Labels is enabled.
  • referenceField_label - Human-readable labels for reference fields, if Add Reference Labels is enabled.
  • userDefinedFields - Array of user-defined fields associated with the contact group, unless flattened.
  • userDefinedFieldName - User-defined fields brought to top-level properties if Flatten User-Defined Fields is enabled.

Dependencies

  • Requires an API key credential for Autotask REST API authentication.

Troubleshooting

  • If the Contact Group ID is invalid or not found, the node will throw an error indicating the resource could not be retrieved. Verify the ID is correct.
  • If API authentication fails, ensure the Autotask API credentials are correctly configured and have sufficient permissions.
  • Selecting fields that do not exist may result in incomplete data or errors; verify field names or IDs when using Select Columns.
  • Enabling Add Picklist Labels or Add Reference Labels without proper API support may result in missing label fields.

Discussion