Autotask icon

Autotask

Consume Autotask REST API
Join our community

Actions389

Overview

This node operation retrieves multiple company records from the Autotask REST API using an advanced filtering mechanism. It allows users to specify complex query criteria in JSON format to filter companies according to their needs. The node supports returning all matching records or limiting the number of results, and can enhance output by adding human-readable labels for picklist and reference fields. It also offers options to select specific columns and flatten user-defined fields for easier access. This operation is useful for scenarios where detailed and customized company data retrieval is required, such as generating reports, syncing data with other systems, or performing bulk data analysis.

Properties

Name Meaning
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. The value must be between 1 and 500.
Advanced Filter A required JSON string containing a 'filter' array with Autotask API query criteria to filter the company records.
Add Picklist Labels Indicates whether to automatically add '_label' fields for picklist fields to provide human-readable values in the output.
Add Reference Labels Indicates whether to automatically add '_label' fields for reference fields to provide human-readable values in the output.
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.
Flatten User-Defined Fields Determines whether user-defined fields (UDFs) are brought up to the top level of each company object instead of being nested inside the userDefinedFields array.

Output

JSON

  • id - Unique identifier of the company record.
  • name - Name of the company.
  • picklistField_label - Human-readable label for a picklist field, added if 'Add Picklist Labels' is true.
  • referenceField_label - Human-readable label for a reference field, added if 'Add Reference Labels' is true.
    userDefinedFields - User-defined fields nested inside the userDefinedFields array, or at top-level if 'Flatten User-Defined Fields' is true. - Other selected fields as specified by the 'Select Columns' property.

Dependencies

  • Requires an Autotask API credential (API key or token) to authenticate requests to the Autotask REST API.

Troubleshooting

  • Invalid JSON in 'Advanced Filter' property can cause parsing errors. Ensure the JSON string is well-formed and follows Autotask API query criteria format.
  • Requesting too many records without pagination or limits may lead to timeouts or API rate limiting. Use 'Get All' carefully or set reasonable 'Max Records'.
  • Selecting invalid or non-existent columns in 'Select Columns' may result in incomplete or error responses. Use 'Get Field Info' to verify field names.
  • If human-readable labels are not appearing, verify that 'Add Picklist Labels' and 'Add Reference Labels' are enabled and that the fields have valid values.
  • API authentication errors indicate invalid or missing credentials. Check the Autotask API credential configuration in n8n.

Links

Discussion