Autotask icon

Autotask

Interact with Kaseya's Autotask PSA REST API to manage companies, tickets, contracts, and more.

Actions524

Contract Retainer → Get Many

AI-generated

Overview

This node operation retrieves multiple Contract Retainer records from the Autotask PSA system. It supports fetching all records or limiting the number of records returned, with options to include human-readable labels for picklist and reference fields, select specific columns, and flatten user-defined fields for easier access. This operation is useful for scenarios where users need to list or analyze multiple contract retainers, such as generating reports or syncing contract data with other systems.

Use Case Examples

  1. Fetch all contract retainers to synchronize with an external database.
  2. Retrieve a limited number of contract retainers with specific fields for a dashboard display.
  3. Get contract retainers with user-friendly labels for reporting purposes.

Properties

Name Meaning
Get All Whether to return all results or only up to a given limit.
Max Records Maximum number of contract retainer records to return when not returning all.
Add Picklist Labels Whether to automatically add '_label' fields for picklist fields with human-readable values.
Add Reference Labels Whether to automatically add '_label' fields for reference fields with human-readable values.
Select Columns Names or IDs. Choose which fields to include in the response; if none selected, all fields are returned. The ID field is always included.
Flatten User-Defined Fields Whether to bring user-defined fields up to the top level of each object for easier access.
Fields Mapping of fields to define or customize the data structure for the contract retainer resource.

Output

JSON

  • id - Unique identifier of the contract retainer record.
  • contractRetainerField1 - Example field representing a property of the contract retainer (actual fields depend on API response).
  • contractRetainerFieldN - Additional fields representing contract retainer properties as returned by the API.

Dependencies

  • An API key credential for Autotask PSA REST API authentication.

Troubleshooting

  • Common issues include authentication failures due to invalid or missing API credentials. Ensure the API key credential is correctly configured.
  • Errors may occur if the resource or operation parameters are incorrect or unsupported; verify that 'Contract Retainer' resource and 'Get Many' operation are selected.
  • If the API rate limit is exceeded, the node may fail; consider handling rate limits or retrying after some time.

Links

Discussion