Autotask icon

Autotask

Consume Autotask REST API

Actions389

Overview

The 'Get Many (Advanced)' operation for the 'Survey Results' resource in the Autotask node allows users to retrieve multiple survey result records from the Autotask REST API using advanced filtering criteria. This operation is beneficial when you need to query survey results with complex conditions, such as filtering by specific fields or values, beyond simple retrieval. For example, you can fetch all survey results that meet certain criteria defined in a JSON filter, control the number of records returned, and customize the output by including human-readable labels for picklist and reference fields.

Properties

Name Meaning
Return All Determines whether to return all matching survey result records or limit the number of records returned.
Max Records Specifies the maximum number of survey result records to return when 'Return All' is set to false. The value range is 1 to 500.
Advanced Filter A JSON string containing a 'filter' array with Autotask API query criteria to filter the survey results. This allows complex queries based on field values.
Add Picklist Labels Whether to automatically add '_label' fields for picklist fields in the output, providing human-readable values instead of raw codes.
Add Reference Labels Whether to automatically add '_label' fields for reference fields in the output, providing 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 When enabled, user-defined fields (UDFs) are brought to the top level of each object instead of being nested inside a userDefinedFields array.

Output

JSON

  • id - Unique identifier of the survey result record.
  • fieldName - Various fields of the survey result as returned by the Autotask API, depending on selected columns.
  • fieldName_label - Human-readable labels for picklist or reference fields if 'Add Picklist Labels' or 'Add Reference Labels' is enabled.
  • userDefinedFields - Array of user-defined fields unless 'Flatten User-Defined Fields' is enabled, in which case these fields appear at the top level.

Dependencies

  • Requires an Autotask API credential (API key or token) configured in n8n to authenticate requests to the Autotask REST API.

Troubleshooting

  • Invalid JSON in 'Advanced Filter' property can cause errors. Ensure the JSON string is well-formed and follows Autotask API query criteria format.
  • Requesting too many records without pagination or limits may lead to timeouts or API rate limiting.
  • Selecting fields that do not exist or are misspelled in 'Select Columns' may result in incomplete or empty data.
  • If labels are not appearing as expected, verify that 'Add Picklist Labels' and 'Add Reference Labels' are enabled and that the fields support labels.
  • API authentication errors may occur if the Autotask API credentials are missing, expired, or incorrect.

Links

Discussion