Autotask icon

Autotask

Consume Autotask REST API
Join our community

Actions389

Overview

This node operation retrieves multiple Contact records from the Autotask system using an advanced filtering mechanism. It allows users to specify complex query criteria in JSON format to filter contacts precisely. Users can choose to return all matching contacts or limit the number of records returned. Additionally, it supports options to include human-readable labels for picklist and reference fields, select specific columns to return, and flatten user-defined fields for easier access. This operation is beneficial for scenarios where detailed and customized contact data retrieval is needed, such as generating reports, syncing contacts with other systems, or performing bulk data analysis.

Properties

Name Meaning
Get All Determines whether to return all matching contact records or limit the results to a specified maximum number.
Max Records Specifies the maximum number of contact records 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 contacts. This allows complex and precise filtering based on contact fields.
Add Picklist Labels Indicates whether to automatically add additional fields with '_label' suffix for picklist fields, providing human-readable values instead of raw codes.
Add Reference Labels Indicates whether to automatically add additional fields with '_label' suffix for reference fields, providing human-readable values.
Select Columns Names or IDs. Allows selection of specific contact 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 Determines whether user-defined fields (UDFs) are brought up to the top level of each contact object instead of being nested inside a userDefinedFields array.

Output

JSON

  • id - Unique identifier of the contact record.
  • fieldName - Various contact fields as specified or all fields if none selected.
  • fieldName_label - Human-readable label for picklist or reference fields if enabled.
  • userDefinedFields - Array of user-defined fields associated with the contact, unless flattened.
  • userDefinedFieldName - User-defined fields brought to top-level properties if flattenUdfs is enabled.

Dependencies

  • Requires an Autotask API key credential for authentication.
  • Relies on the Autotask REST API to perform advanced filtered queries on Contact resources.

Troubleshooting

  • Invalid JSON in the 'Advanced Filter' property will cause query errors. Ensure the JSON string is well-formed and follows Autotask API filter syntax.
  • Requesting too many records without pagination or limits may lead to timeouts or API rate limiting.
  • Selecting non-existent fields in 'Select Columns' may result in empty or error responses.
  • If picklist or reference labels are enabled but no labels appear, verify that the fields contain valid values.
  • Ensure the API credentials have sufficient permissions to read Contact data.

Links

Discussion