Autotask icon

Autotask

Consume Autotask REST API
Join our community

Actions389

Overview

This node operation retrieves multiple Contract Retainer records from the Autotask system. It is useful for scenarios where users need to fetch a list of contract retainers, for example, to analyze contract data, generate reports, or synchronize contract information with other systems. The operation supports fetching all records or limiting the number of records returned, and allows customization of the fields included in the output.

Properties

Name Meaning
Fields Defines which fields of the Contract Retainer resource to map and include in the output. Supports defining fields manually or using auto-mapping features.
Get All Determines whether to return all 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.
Add Picklist Labels If enabled, adds additional fields with human-readable labels for picklist fields in the output, improving readability.
Add Reference Labels If enabled, adds additional fields with human-readable labels for reference fields in the output.
Select Columns Names or IDs. Allows selection of specific fields to include in the response by choosing from a list or specifying field IDs via expressions. If no fields are selected, all fields are returned. The ID field is always included.
Flatten User-Defined Fields When enabled, user-defined fields (UDFs) are brought to the top level of each returned object instead of being nested inside a userDefinedFields array, simplifying access to these fields.

Output

JSON

  • id - Unique identifier of the Contract Retainer record.
    - Each selected field from the Contract Retainer resource as specified by the 'Fields' and 'Select Columns' properties._label - Human-readable label for picklist or reference fields if 'Add Picklist Labels' or 'Add Reference Labels' is enabled.userDefinedFields - User-defined fields nested or flattened depending on 'Flatten User-Defined Fields' setting.

Dependencies

  • Requires an authenticated connection to the Autotask REST API via an API key credential.

Troubleshooting

  • If no records are returned, verify that the Contract Retainer resource contains data and that the selected fields are valid.
  • If the node throws an error about unsupported resource or operation, ensure the resource is set to 'contractRetainer' and operation to 'getMany'.
  • Errors related to API authentication indicate issues with the provided API key or credentials; verify and update credentials as needed.
  • If the maximum records limit is exceeded, reduce the 'Max Records' value or enable 'Get All' to fetch all records in batches if supported.

Discussion