Autotask icon

Autotask

Consume Autotask REST API
Join our community

Actions389

Overview

This node operation retrieves multiple Project records from the Autotask system using an advanced filtering mechanism. It allows users to specify complex query criteria in JSON format to filter projects according to their needs. This is useful for scenarios where users need to extract a customized list of projects based on specific conditions, such as projects within a date range, with certain statuses, or matching other detailed attributes. For example, a project manager could use this to get all active projects assigned to a particular team or client.

Properties

Name Meaning
Get All Determines whether to return all matching project records or limit the number of results.
Max Records Specifies the maximum number of project 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 projects. This allows complex and precise filtering based on Autotask's REST API query syntax.
Add Picklist Labels If enabled, adds additional fields with '_label' suffix containing human-readable labels for picklist fields in the project data.
Add Reference Labels If enabled, adds additional fields with '_label' suffix containing human-readable labels for reference fields in the project data.
Select Columns Names or IDs. Allows selection of specific project 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 If enabled, user-defined fields (UDFs) are moved to the top level of each project object instead of being nested inside a userDefinedFields array.

Output

JSON

  • id - Unique identifier of the project.
  • name - Name of the project.
  • status - Current status of the project.
  • userDefinedFields - Array of user-defined fields associated with the project, unless flattened.
    - Other selected project fields as specified by the 'Select Columns' property._label - Human-readable labels for picklist or reference fields if 'Add Picklist Labels' or 'Add Reference Labels' is enabled.

Dependencies

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

Troubleshooting

  • Invalid JSON in 'Advanced Filter' property can cause query failures. Ensure the JSON string is correctly formatted and follows Autotask API query syntax.
  • Requesting too many records without 'Get All' enabled may result in incomplete data. Use 'Get All' carefully to avoid performance issues.
  • Selecting fields that do not exist or are misspelled in 'Select Columns' may cause errors or missing data.
  • If picklist or reference labels are not appearing, verify that the corresponding fields have valid values and that label addition options are enabled.
  • API rate limits or authentication errors may occur if the Autotask API key is invalid or expired.

Links

Discussion