Autotask icon

Autotask

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

Actions524

Appointment → Get Many (Advanced)

AI-generated

Overview

This node operation retrieves multiple appointment records from the Autotask PSA system using advanced filtering criteria. It allows users to specify detailed JSON-based filters to query appointments, control the number of records returned, and customize the output fields. This operation is useful for scenarios where users need to extract specific appointment data based on complex conditions, such as date ranges, statuses, or other appointment attributes.

Use Case Examples

  1. Retrieve all appointments scheduled within a specific date range using a JSON filter.
  2. Fetch up to 100 appointments with a particular status or assigned resource.
  3. Use advanced filters to get appointments that meet multiple criteria, such as location and type.

Properties

Name Meaning
Get All Whether to return all results or only up to a given limit (maxRecords).
Max Records Maximum number of appointment records to return when 'Get All' is false. Range is 1 to 500.
Advanced Filter A JSON string containing a 'filter' array with Autotask API query criteria to filter the appointments returned.
Add Picklist Labels Whether to automatically add '_label' fields for picklist fields with human-readable values in the output.
Add Reference Labels Whether to automatically add '_label' fields for reference fields with human-readable values in the output.
Select Columns Names or IDs Choose which appointment 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 Whether to bring user-defined fields up to the top level of each appointment object instead of nested in the userDefinedFields array.

Output

JSON

  • id - Unique identifier of the appointment record.
  • fieldName
    • _label - Human-readable labels for picklist or reference fields if enabled.
  • userDefinedFields
    • fieldName - User-defined fields nested or flattened based on the flattenUdfs option.

Dependencies

  • Autotask PSA API with appropriate API key credentials

Troubleshooting

  • Ensure the advancedFilter JSON is correctly formatted and contains a valid 'filter' array as per Autotask API documentation.
  • If no records are returned, verify the filter criteria match existing appointment data.
  • Check API credentials and permissions to access appointment data.
  • If the node throws errors related to rate limits, consider API usage limits and retry strategies.

Links

Discussion