Autotask icon

Autotask

Consume Autotask REST API

Actions389

Overview

The 'Get Many (Advanced)' operation for the 'Opportunity' resource in the Autotask node allows users to retrieve multiple opportunity records from the Autotask system using advanced filtering criteria. This operation supports returning all matching records or limiting the number of records returned. It is particularly useful for scenarios where users need to query opportunities based on complex conditions, such as specific statuses, date ranges, or custom fields, enabling detailed data extraction for reporting, analysis, or integration workflows.

Properties

Name Meaning
Get All Determines whether to return all matching opportunity records or limit the results to a specified maximum number.
Max Records Specifies the maximum number of opportunity records to return when 'Get All' is set to false. The value must be between 1 and 500.
Advanced Filter A JSON string containing a 'filter' array with Autotask API query criteria to define complex filtering conditions for retrieving opportunities.
Add Picklist Labels Indicates whether to automatically add human-readable '_label' fields for picklist fields in the returned opportunity records.
Add Reference Labels Indicates whether to automatically add human-readable '_label' fields for reference fields in the returned opportunity records.
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 ID field is always included.
Flatten User-Defined Fields Determines whether user-defined fields (UDFs) are brought up to the top level of each opportunity object instead of being nested inside a 'userDefinedFields' array.

Output

JSON

  • id - Unique identifier of the opportunity record.
  • fields
    • * - Selected or all fields of the opportunity record as per the 'Select Columns' property.
    • *_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 if 'Flatten User-Defined Fields' is disabled.
  • * - Top-level user-defined fields if 'Flatten User-Defined Fields' is enabled.

Dependencies

  • Requires an Autotask API credential (API key or token) to authenticate requests.
  • Relies on the Autotask REST API for querying opportunity data.

Troubleshooting

  • Invalid JSON in 'Advanced Filter' property can cause query failures. Ensure the JSON string is correctly formatted and contains a valid 'filter' array as per Autotask API documentation.
  • Requesting more than 500 records when 'Get All' is false and 'Max Records' exceeds 500 will result in an error. Limit 'Max Records' to 500 or enable 'Get All' to retrieve all records.
  • If no records are returned, verify that the filter criteria in 'Advanced Filter' correctly match existing opportunity data.
  • Enabling 'Add Picklist Labels' or 'Add Reference Labels' will not add labels for empty or null values; this is expected behavior.
  • Flattening user-defined fields may cause naming conflicts if UDF names overlap with standard fields; disable flattening if this occurs.

Links

Discussion