Autotask icon

Autotask

Consume Autotask REST API

Actions389

Contract → Get Many (Advanced)

AI-generated

Overview

This node operation retrieves multiple Contract records from the Autotask system using an advanced filtering mechanism. It allows users to specify complex query criteria in JSON format to filter contracts, control the number of records returned, and customize the output fields. This is useful for scenarios where precise contract data extraction is needed, such as generating reports, syncing contract data with other systems, or performing bulk data analysis.

Properties

Name Meaning
Get All Determines whether to return all matching contract records or limit the results to a specified maximum number.
Max Records Specifies the maximum number of contract 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 contracts. Users should construct this JSON using the Autotask API documentation and helper tools.
Add Picklist Labels Indicates whether to automatically add human-readable '_label' fields for picklist fields in the contract data. Labels are not added for empty values.
Add Reference Labels Indicates whether to automatically add human-readable '_label' fields for reference fields in the contract data. Labels are not added for empty values.
Select Columns Names or IDs. Allows selection of specific contract fields to include in the response. If no fields are selected, all fields are returned. The 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 each contract object instead of being nested inside a 'userDefinedFields' array.

Output

JSON

  • contracts
    • ``
      * id - The unique identifier of the contract.
      * userDefinedFields - Array of user-defined fields if 'Flatten User-Defined Fields' is false.
    • _label - Optional human-readable labels for picklist or reference fields, appended as '_label' fields.

Dependencies

  • Requires an Autotask API key credential for authentication to access the Autotask REST API.

Troubleshooting

  • Invalid JSON in 'Advanced Filter' property can cause query failures. Ensure the JSON string is well-formed and follows Autotask API query syntax.
  • Requesting too many records without pagination or 'Get All' enabled may lead to timeouts or API rate limiting.
  • Selecting fields that do not exist or are misspelled in 'Select Columns' may result in incomplete data or errors.
  • If labels are not appearing as expected, verify that 'Add Picklist Labels' and 'Add Reference Labels' are enabled and that the fields have valid values.
  • Flattening user-defined fields may cause naming conflicts if UDF names overlap with standard fields.

Links

Discussion