Autotask icon

Autotask

Consume Autotask REST API
Join our community

Actions389

Overview

This node interacts with the Autotask REST API to retrieve a specific Company Note by its ID. It is useful for workflows that need to fetch detailed information about a particular note associated with a company in Autotask, such as for auditing, reporting, or integration with other systems. For example, a user can automate the retrieval of a company note to include its content in a customer support ticket or to synchronize notes with a CRM system.

Properties

Name Meaning
Note ID The unique identifier of the company note to retrieve. This is a required input to specify which note to get.
Add Picklist Labels Determines whether to automatically add human-readable "_label" fields for picklist fields in the response. This helps interpret picklist values more easily.
Add Reference Labels Determines whether to automatically add human-readable "_label" fields for reference fields in the response, improving readability of referenced entities.
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 If enabled, user-defined fields (UDFs) are brought to the top level of the output object instead of being nested, simplifying access to these fields.

Output

JSON

  • id - The unique identifier of the company note.
  • content - The textual content of the company note.
  • createdDate - The date and time when the note was created.
  • createdBy - Information about the user who created the note, possibly including a label if 'Add Reference Labels' is enabled.
  • userDefinedFields - An array of user-defined fields associated with the note, or flattened to top-level properties if 'Flatten User-Defined Fields' is enabled.
    - Additional fields selected via 'Select Columns' input, including picklist and reference labels if enabled.

Dependencies

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

Troubleshooting

  • If the Note ID is invalid or does not exist, the node will throw an error indicating the note was not found. Verify the Note ID is correct.
  • If API authentication fails, ensure the Autotask API credentials are correctly configured and have sufficient permissions.
  • Selecting fields that do not exist or are not accessible may result in incomplete data or errors. Use the 'Select Columns' dropdown to choose valid fields.
  • Enabling 'Add Picklist Labels' or 'Add Reference Labels' may increase response size and processing time; disable if performance is a concern.

Discussion