Autotask icon

Autotask

Consume Autotask REST API
Join our community

Actions389

Overview

This node operation retrieves details of a specific Contract Retainer from the Autotask system using its unique Retainer ID. It is useful for scenarios where you need to fetch contract retainer information for processing, reporting, or integration purposes, such as obtaining billing or contract status details for a given retainer.

Properties

Name Meaning
Retainer ID The unique identifier of the contract retainer to retrieve. This is a required field to specify which retainer to get.
Add Picklist Labels Determines whether to add human-readable label fields (with suffix '_label') for picklist fields in the response. Labels are only added for non-empty values.
Add Reference Labels Determines whether to add human-readable label fields (with suffix '_label') for reference fields in the response. Labels are only added for non-empty values.
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 promoted to top-level properties in the output object instead of being nested inside a userDefinedFields array.

Output

JSON

  • id - The unique identifier of the contract retainer.
  • name - The name of the contract retainer.
  • status - The status of the contract retainer.
  • userDefinedFields - Array of user-defined fields associated with the retainer, unless flattened.
    _label - Human-readable labels for picklist or reference fields, added if enabled.

Dependencies

  • Requires an API key credential for Autotask REST API access.

Troubleshooting

  • Ensure the Retainer ID provided is valid and exists in the Autotask system; otherwise, the node will return an error indicating the retainer was not found.
  • If no fields appear in the output, verify that the 'Select Columns' property is set correctly or left empty to return all fields.
  • If labels for picklist or reference fields are missing, check that 'Add Picklist Labels' and 'Add Reference Labels' options are enabled and that the fields have non-empty values.
  • Authentication errors may occur if the Autotask API credentials are invalid or expired; reconfigure the credentials in n8n.

Discussion