Autotask icon

Autotask

Consume Autotask REST API

Actions389

Overview

The node interacts with the Autotask REST API to retrieve multiple company note records. It supports fetching either all records or a limited number, with options to customize the fields returned, including user-defined fields and labels for picklist and reference fields. This is useful for workflows that need to process or analyze company notes in bulk, such as reporting, data synchronization, or integration with other systems.

Properties

Name Meaning
Fields Defines which fields of the company note resource to retrieve and map in the output. Supports custom mapping and selection of specific fields.
Get All Determines whether to return all matching company note records or limit the number of records returned.
Max Records Specifies the maximum number of company note 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. If none are 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 in each record instead of being nested inside a userDefinedFields array.

Output

JSON

  • id - Unique identifier of the company note record.
  • fields
    • * - Selected fields of the company note as defined by the 'Fields' property, including standard and user-defined fields.
  • *_label - Optional human-readable labels for picklist and reference fields if enabled.

Dependencies

  • Requires an Autotask API key credential for authentication to access the Autotask REST API.

Troubleshooting

  • If no records are returned, verify that the company notes exist and that the API credentials have sufficient permissions.
  • If the node returns an error about unsupported resource, ensure the 'Resource' parameter is set to 'companyNote'.
  • When selecting fields, ensure the field IDs or names are valid; invalid fields may cause errors or missing data.
  • If the maximum records limit is exceeded, reduce the 'Max Records' value or enable 'Get All' to fetch all records.
  • Network or authentication errors may occur if the API key is invalid or the Autotask service is unreachable.

Discussion