Autotask icon

Autotask

Consume Autotask REST API
Join our community

Actions389

Overview

This node operation retrieves multiple Contract Retainer records from the Autotask REST API using advanced filtering criteria. It is useful for users who need to query contract retainers with complex filters, control the number of records returned, and customize the output fields. For example, a user can fetch all contract retainers matching specific conditions such as date ranges, status, or custom fields, and optionally include human-readable labels for picklist and reference fields.

Properties

Name Meaning
Get All Determines whether to return all matching contract retainer records or limit the results to a specified maximum number.
Max Records Specifies the maximum number of contract retainer 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 for filtering contract retainers. Users should construct this JSON using the Autotask API documentation and helper tools.
Add Picklist Labels If enabled, adds additional fields with '_label' suffix containing human-readable values for picklist fields in the output. Empty values do not get labels.
Add Reference Labels If enabled, adds additional fields with '_label' suffix containing human-readable values for reference fields in the output. Empty values do not get labels.
Select Columns Names or IDs. Allows selection of specific 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 If enabled, user-defined fields (UDFs) are 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 retainer record.
  • fieldName - Various contract retainer fields as specified by the selected columns or all fields if none selected.
  • fieldName_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 unless 'Flatten User-Defined Fields' is enabled, in which case these fields appear at the top level.

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 filter syntax.
  • Requesting more than 500 records when 'Get All' is false will be limited to 500 due to API constraints.
  • If no records are returned, verify that the filter criteria match existing contract retainers.
  • Enabling 'Add Picklist Labels' or 'Add Reference Labels' adds extra fields; if unexpected fields appear, check if the API response includes those labels.
  • Flattening user-defined fields may cause naming conflicts if UDF names overlap with standard fields.

Links

Discussion