Autotask icon

Autotask

Consume Autotask REST API
Join our community

Actions389

Overview

This node operation retrieves detailed information about a specific survey from the Autotask system using the survey's unique ID. It is useful for workflows that need to fetch survey data for analysis, reporting, or integration with other systems. For example, you can use it to get survey details to trigger follow-up actions based on survey responses or to synchronize survey metadata with a CRM.

Properties

Name Meaning
Survey ID The unique identifier of the survey to retrieve. This is a required input to specify which survey's data to fetch.
Add Picklist Labels Determines whether to automatically add human-readable '_label' fields for picklist fields in the survey data. Labels are not added for empty values.
Add Reference Labels Determines whether to automatically add human-readable '_label' fields for reference fields in the survey data. Labels are not added for empty values.
Select Columns Names or IDs. Allows selection of specific survey fields to include in the response. If no fields are selected, all fields are returned. The survey ID field is always included.
Flatten User-Defined Fields If enabled, user-defined fields (UDFs) are brought to the top level of the survey object instead of being nested inside a userDefinedFields array.

Output

JSON

  • id - The unique identifier of the retrieved survey.
  • name - The name of the survey.
  • description - Description or details about the survey.
  • fields - An object or array containing the survey's fields and their values.
  • userDefinedFields - Array of user-defined fields associated with the survey, unless flattened to top-level properties.
    _label - Human-readable labels for picklist or reference fields, added if corresponding options are enabled.

Dependencies

  • Requires an API key credential for authenticating with the Autotask REST API.

Troubleshooting

  • Ensure the Survey ID provided is correct and exists in the Autotask system; otherwise, the node may return an error or empty result.
  • If the node returns incomplete data, verify that the 'Select Columns' property includes the desired fields or leave it empty to fetch all fields.
  • If labels for picklist or reference fields are missing, check that 'Add Picklist Labels' and 'Add Reference Labels' options are enabled.
  • Authentication errors indicate issues with the provided API credentials; verify and update the API key as needed.

Discussion