Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Appointment → List Of Appointment

AI-generated

Overview

This node integrates with the Halo PSA API to list appointments based on various filtering and sorting criteria. It is useful for retrieving detailed appointment data from a PSA system, enabling automation workflows that require scheduling information, resource allocation, or appointment tracking.

Common scenarios include:

  • Fetching upcoming appointments for specific agents or clients.
  • Filtering appointments by date ranges, types, or statuses.
  • Paginating large sets of appointment data.
  • Excluding or including recurring, completed, or deleted appointments.
  • Sorting appointments by multiple fields in ascending or descending order.

Practical example:

  • Automatically retrieve all open appointments assigned to a particular client within a date range, then trigger follow-up actions such as notifications or report generation.

Properties

Name Meaning
Advanced Search A string for advanced search queries to filter appointments.
Agents Comma separated list of agent IDs to return only those agents' appointments.
Appointmentsonly Boolean to return only appointments (exclude other related data).
Assets Filter by assets associated with appointments.
Client Id Integer ID to return appointments assigned to a specific client.
End Date Return appointments with an end date greater than this value (string date).
Excludenonticketapptodo Boolean to exclude non-ticket appointment todos.
Excluderecurring Boolean to exclude recurring appointments.
Excluderecurringmaster Boolean to exclude recurring master appointments.
Getopenjourney Boolean flag (meaning depends on API context, likely to get open journey appointments).
Hidecompleted Boolean to exclude completed appointments.
Includedeleted Boolean to include deleted appointments.
Isrecurringchild Boolean to return only appointments that have a recurring child appointment.
Isrecurringmaster Boolean to return only appointments that have a recurring master appointment.
Locations Filter by locations associated with appointments.
My Approvals Boolean flag to filter appointments requiring user's approval.
Order Field name to order results by first priority.
Order 2 Field name to order results by second priority.
Order 3 Field name to order results by third priority.
Order 4 Field name to order results by fourth priority.
Order 5 Field name to order results by fifth priority.
Orderdesc Boolean to specify ascending/descending order for first order field.
Orderdesc 2 Boolean for ascending/descending order for second order field.
Orderdesc 3 Boolean for ascending/descending order for third order field.
Orderdesc 4 Boolean for ascending/descending order for fourth order field.
Orderdesc 5 Boolean for ascending/descending order for fifth order field.
Page No Integer page number to return when using pagination.
Page Size Integer size of each page when paginating results.
Pageinate Boolean to enable pagination in the response.
Recurringchangeonly Boolean flag (likely to filter only recurring changes).
Recurringmasterid String ID to return the master appointment with this ID.
Search String to search appointments matching this text.
Shiftsonly Boolean to return only shifts in the response.
Showall Boolean admin override to return all appointments regardless of filters.
Showappointments String to include appointments in the response (specific meaning depends on API).
Showchanges Boolean to include change requests in the response.
Showholidayonce Boolean flag (API-specific meaning, possibly to show holidays once).
Showholidays Boolean to include appointments of type 'holiday'.
Showprojects Boolean to include projects in the response.
Showshifts Boolean to include shifts in the response.
Start Date Return appointments with a start date greater than this value (string date).
Statuses Comma separated list of statuses to filter appointments.
Tasksonly Boolean to return only tasks in the response.
Ticket Id Integer ID to return appointments assigned to a particular ticket.
Toplevel Id Integer to filter by specified top level.
Types Comma separated list of appointment types to filter by.
Utcoffset Double value to add an offset to the UTC date.

Output

The node outputs an array of JSON objects representing the appointments retrieved from the Halo PSA API. Each item corresponds to one appointment or related entity depending on the filters applied.

  • The json field contains the raw response data from the API call, which includes appointment details such as IDs, dates, agents, clients, status, types, and other metadata.
  • There is no indication that binary data is returned by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Halo PSA API.
  • The node uses the base URL, tenant identifier, client ID, and client secret from the credentials to make authenticated requests.
  • No additional external dependencies are required beyond the configured API credentials.

Troubleshooting

  • No credentials returned!: This error occurs if the node cannot find valid API credentials. Ensure that the API key credential is properly configured in n8n.
  • Resource or Operation not found: If the specified resource or operation does not exist, verify that the correct resource ("Appointment") and operation ("List Of Appointment") are selected.
  • Invalid parameter values: Passing incorrect types or malformed strings (e.g., invalid JSON in query parameters) may cause request failures. Validate input formats carefully.
  • API errors: Errors returned from the Halo PSA API will be included in the output if "Continue On Fail" is enabled; otherwise, they will stop execution. Check API permissions and rate limits.
  • Pagination issues: When using pagination properties, ensure page numbers and sizes are set correctly to avoid empty or incomplete results.

Links and References

Discussion