Autotask icon

Autotask

Consume Autotask REST API

Actions389

Overview

This node interacts with the Autotask REST API to retrieve multiple company records based on user-defined criteria. It is useful for workflows that require bulk access to company data, such as generating reports, syncing company information with other systems, or performing batch updates. For example, a user can fetch all companies with specific fields mapped, limit the number of records returned, and include human-readable labels for picklist and reference fields.

Properties

Name Meaning
Fields Defines which company fields to retrieve and map in the output. Supports auto-mapping and selective field inclusion.
Get All Determines whether to return all matching company records or limit the results to a specified maximum number.
Max Records Specifies the maximum number of company records to return when 'Get All' is false. Valid range is 1 to 500.
Add Picklist Labels If enabled, adds additional fields with '_label' suffix containing human-readable labels for picklist fields.
Add Reference Labels If enabled, adds additional fields with '_label' suffix containing human-readable labels for reference fields.
Select Columns Names or IDs. Allows selection of specific company fields to include in the response. If none selected, all fields are returned. The ID field is always included.
Flatten User-Defined Fields When enabled, user-defined fields (UDFs) are promoted to top-level properties instead of being nested inside a userDefinedFields array.

Output

JSON

  • id - Unique identifier of the company record.
    fields - Mapped company fields as specified by the 'Fields' property._label - Human-readable labels for picklist or reference fields if enabled.
  • userDefinedFields - Array of user-defined fields unless 'Flatten User-Defined Fields' is enabled.

Dependencies

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

Troubleshooting

  • If no records are returned, verify that the API credentials are correct and have sufficient permissions.
  • Ensure that the 'Fields' property is properly configured to include the desired fields; otherwise, the output may be incomplete.
  • When 'Get All' is false, the 'Max Records' value must be between 1 and 500; values outside this range may cause errors.
  • If picklist or reference labels are not appearing, check that the corresponding 'Add Picklist Labels' and 'Add Reference Labels' options are enabled.
  • Flattening user-defined fields may cause naming conflicts if UDF names overlap with standard fields; disable flattening if this occurs.

Discussion