Autotask icon

Autotask

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

Actions524

Appointment → Get

AI-generated

Overview

This node operation retrieves a specific appointment from the Autotask PSA system using the appointment's unique ID. It is useful for scenarios where detailed information about a particular appointment is needed, such as viewing appointment details for scheduling, follow-up, or reporting purposes.

Use Case Examples

  1. Retrieve an appointment by its ID to display its details in a dashboard.
  2. Fetch appointment information to update or verify scheduling data in an external system.

Properties

Name Meaning
Appointment ID The unique identifier of the appointment to retrieve.
Add Picklist Labels Whether to automatically add '_label' fields for picklist fields with human-readable values (no labels will be added for empty values).
Add Reference Labels Whether to automatically add '_label' fields for reference fields with human-readable values (no labels will be added for empty values).
Select Columns Names or IDs. Choose which fields to include in the response. If no fields are selected, all fields will be returned. The ID field is always included regardless of selection.
Flatten User-Defined Fields Whether to bring user-defined fields up to the top level of each object, making them accessible as top-level properties instead of being nested in the userDefinedFields array.

Output

JSON

  • id - The unique identifier of the appointment.
  • subject - The subject or title of the appointment.
  • startDateTime - The start date and time of the appointment.
  • endDateTime - The end date and time of the appointment.
  • location - The location where the appointment is scheduled.
  • description - Additional details or notes about the appointment.
  • userDefinedFields - Custom fields defined by the user, optionally flattened to top-level properties.
  • picklistLabels - Human-readable labels for picklist fields, if enabled.
  • referenceLabels - Human-readable labels for reference fields, if enabled.

Dependencies

  • An API key credential for Autotask PSA REST API authentication.

Troubleshooting

  • Ensure the Appointment ID provided is valid and exists in the Autotask system to avoid 'not found' errors.
  • Check API credentials and permissions if authentication errors occur.
  • If no fields are returned, verify the 'Select Columns' property to ensure requested fields exist and are accessible.
  • Enable 'Add Picklist Labels' and 'Add Reference Labels' only if human-readable labels are needed, as this may affect response size and performance.

Links

Discussion