Autotask icon

Autotask

Interact with Kaseya's Autotask PSA REST API to manage companies, tickets, contracts, and more.

Actions524

Company → Get Many (Advanced)

AI-generated

Overview

This node operation retrieves multiple company records from the Autotask PSA system using advanced filtering criteria. It is useful for scenarios where users need to fetch a customized list of companies based on specific query filters, such as retrieving companies that meet certain conditions or attributes defined in a JSON filter. For example, a user might want to get all companies in a particular region or with a specific status.

Use Case Examples

  1. Fetch all companies with a revenue greater than a certain amount using an advanced JSON filter.
  2. Retrieve a limited number of company records that match specific criteria for reporting or integration purposes.

Properties

Name Meaning
Get All Whether to return all results or only up to a given limit (returnAll boolean). If false, the number of records returned is limited by Max Records.
Max Records Maximum number of company records to return when 'Get All' is false. Value range is 1 to 500.
Advanced Filter A JSON string containing a 'filter' array with Autotask API query criteria to filter the companies returned. This allows precise control over which company records are retrieved.
Add Picklist Labels Whether to automatically add '_label' fields for picklist fields with human-readable values in the output. No labels are added for empty values.
Add Reference Labels Whether to automatically add '_label' fields for reference fields with human-readable values in the output. No labels are added for empty values.
Select Columns Names or IDs Choose which company fields to include in the response. If no fields are selected, all fields are returned. The ID field is always included regardless of selection.
Flatten User-Defined Fields Whether to bring user-defined fields (UDFs) up to the top level of each company object instead of nested inside a userDefinedFields array.

Output

JSON

  • id - Unique identifier of the company record.
  • name - Name of the company.
  • address - Company address details.
  • phone - Company phone number.
  • email - Company email address.
  • picklist_field_label - Human-readable label for picklist fields if Add Picklist Labels is enabled.
  • reference_field_label - Human-readable label for reference fields if Add Reference Labels is enabled.
    userDefinedFields - User-defined fields either nested or flattened based on Flatten User-Defined Fields option.

Dependencies

  • An API key credential for Autotask PSA REST API authentication

Troubleshooting

  • Common issues include invalid or malformed JSON in the Advanced Filter property, which will cause query errors. Ensure the JSON string is correctly formatted and follows Autotask API query syntax.
  • If the Max Records value is set too high without enabling Get All, the node may return fewer records than expected due to API limits.
  • Errors related to authentication usually indicate missing or incorrect API credentials; verify the Autotask API key and integration code are correctly configured.
  • If no results are returned, verify the filter criteria actually match existing company records in Autotask.

Links

Discussion