Autotask icon

Autotask

Consume Autotask REST API
Join our community

Actions389

Overview

This node operation retrieves multiple Contract Service records from the Autotask system using an advanced filtering mechanism. It allows users to specify complex query criteria in JSON format to filter the contract services returned. Users can choose to return all matching records or limit the number of records returned. Additionally, it supports options to include human-readable labels for picklist and reference fields, select specific columns to return, and flatten user-defined fields for easier access. This operation is useful for scenarios where detailed and customized retrieval of contract service data is needed, such as reporting, data synchronization, or integration workflows.

Properties

Name Meaning
Get All Determines whether to return all matching contract service records or limit the results to a specified maximum number.
Max Records Specifies the maximum number of contract service 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 contract service records. This allows complex and precise filtering based on field values.
Add Picklist Labels Indicates whether to automatically add additional fields with '_label' suffix for picklist fields, providing human-readable values instead of raw codes.
Add Reference Labels Indicates whether to automatically add additional fields with '_label' suffix for reference fields, providing human-readable values.
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 regardless of selection.
Flatten User-Defined Fields Determines whether user-defined fields (UDFs) should be moved to the top level of each returned object instead of being nested inside a 'userDefinedFields' array.

Output

JSON

  • id - Unique identifier of the contract service record.
  • fieldName - Various fields of the contract service as returned by the Autotask API, depending on selected columns and filters.
  • fieldName_label - Human-readable labels for picklist or reference fields, if enabled.
  • userDefinedFields - Array of user-defined fields associated with the contract service, unless flattened to top-level properties.

Dependencies

  • Requires an Autotask API credential (API key or token) to authenticate requests.
  • Relies on the Autotask REST API to fetch contract service data.

Troubleshooting

  • Invalid JSON in 'Advanced Filter' property can cause query failures. Ensure the JSON string is well-formed and follows Autotask API filter syntax.
  • Requesting too many records without pagination or limits may lead to timeouts or API rate limiting.
  • Selecting non-existent fields in 'Select Columns' may result in errors or missing data.
  • If labels are not appearing, verify that 'Add Picklist Labels' and 'Add Reference Labels' options are enabled and that the fields support labels.
  • Flattening user-defined fields may cause naming conflicts if UDF names overlap with standard fields.

Links

Discussion