Autotask icon

Autotask

Consume Autotask REST API
Join our community

Actions389

Overview

This node operation retrieves detailed information about a specific Opportunity from the Autotask system using its unique Opportunity ID. It is useful for scenarios where you need to fetch and utilize up-to-date data about a particular sales opportunity, such as in sales automation, reporting, or integration workflows. For example, you can use this node to get the current status, associated customer, and other relevant fields of an Opportunity to trigger follow-up actions or update other systems.

Properties

Name Meaning
Opportunity ID The unique identifier of the Opportunity to retrieve. This is required to specify which Opportunity record to fetch.
Add Picklist Labels Determines whether to add additional fields with human-readable labels for picklist fields in the Opportunity data. This helps in understanding coded values by providing their descriptive labels.
Add Reference Labels Determines whether to add additional fields with human-readable labels for reference fields (fields that reference other entities) in the Opportunity data. This makes referenced entities easier to identify.
Select Columns Names or IDs. Allows selection of specific fields (columns) to include in the response. If no fields are selected, all fields are returned. The Opportunity ID field is always included regardless of selection.
Flatten User-Defined Fields Determines whether user-defined fields (UDFs) are brought up to the top level of the returned object instead of being nested inside a userDefinedFields array. This simplifies access to custom fields.

Output

JSON

  • id - The unique identifier of the Opportunity.
  • name - The name/title of the Opportunity.
  • status - The current status of the Opportunity.
  • amount - The monetary value associated with the Opportunity.
  • userDefinedFields - Array of custom user-defined fields related to the Opportunity, unless flattened.
  • *_label - Additional fields added when 'Add Picklist Labels' or 'Add Reference Labels' are enabled, providing human-readable labels for coded or referenced values.

Dependencies

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

Troubleshooting

  • Ensure the Opportunity ID provided is valid and exists in the Autotask system; otherwise, the node will return an error indicating the record was not found.
  • If 'Select Columns' is used, verify that the field names or IDs are correct and available for the Opportunity resource to avoid incomplete or empty responses.
  • When enabling 'Add Picklist Labels' or 'Add Reference Labels', note that empty values will not have labels added, which is expected behavior.
  • If user-defined fields are not appearing as expected, check the 'Flatten User-Defined Fields' setting to control their nesting in the output.

Discussion