Autotask icon

Autotask

Consume Autotask REST API
Join our community

Actions389

Overview

This node operation retrieves multiple company location records from the Autotask REST API using an advanced filtering mechanism. It allows users to specify complex query criteria in JSON format to filter company locations, control the number of records returned, and customize the output fields. This is useful for scenarios where precise data extraction of company locations is needed, such as generating reports, syncing location data with other systems, or performing bulk data analysis.

Properties

Name Meaning
Get All Determines whether to return all matching company location records or limit the results to a specified maximum number.
Max Records Specifies the maximum number of company location 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 that defines the query criteria according to the Autotask API's advanced query syntax. This allows for complex filtering of company location records.
Add Picklist Labels If enabled, adds additional fields with '_label' suffix for picklist fields to provide human-readable values alongside the raw data.
Add Reference Labels If enabled, adds additional fields with '_label' suffix for reference fields to provide human-readable values alongside the raw data.
Select Columns Names or IDs. Allows selection of specific fields to include in the response. If no fields are selected, all fields are returned by default. The ID field is always included.
Flatten User-Defined Fields If enabled, user-defined fields (UDFs) are promoted to top-level properties in each returned object instead of being nested inside a userDefinedFields array.

Output

JSON

  • id - Unique identifier of the company location record.
  • name - Name of the company location.
  • address - Address details of the company location.
  • userDefinedFields - Array of user-defined fields associated with the company location, unless flattened.
    _label - Human-readable label for picklist fields if 'Add Picklist Labels' is enabled._label - Human-readable label for reference fields if 'Add Reference Labels' is enabled.

Dependencies

  • Requires an Autotask API key credential for authentication.
  • Relies on the Autotask REST API endpoint for company locations.

Troubleshooting

  • Invalid JSON in 'Advanced Filter' property can cause query failures. Ensure the JSON string is well-formed and follows Autotask API filter syntax.
  • Requesting too many records without 'Get All' enabled may result in incomplete data. Use 'Get All' to retrieve all matching records if needed.
  • Selecting invalid or non-existent fields in 'Select Columns' may cause errors or missing data in the response.
  • If picklist or reference labels are not appearing, verify that the corresponding boolean properties are enabled and that the fields contain values.
  • API rate limits or authentication errors may occur if the Autotask API key is invalid or overused. Check credentials and usage limits.

Links

Discussion