Skip to content

appointments.md

Latest commit

 

History

History
22 lines (13 loc) · 895 Bytes

appointments.md

File metadata and controls

22 lines (13 loc) · 895 Bytes

Appointment Operations

Manage HaloPSA appointments (/api/Appointment).

Get Many

Parameters:

  • Return All / Limit — Return All paginates through all pages; limited requests cap at 100 per API call
  • Agent ID — Comma-separated agent IDs via agents query param (0 = all)
  • Start Date (UTC) / End Date (UTC) — Optional ISO 8601 range passed to the API as start_date / end_date

Get by ID / Create / Update / Delete

Use Appointment ID for get, update, and delete. Create and Update accept JSON for Appointment fields.

Get Booking / Create Booking

GET /Appointment/Booking returns booking data. Create Booking posts an Appointment object via POST /Appointment/Booking (Additional Fields).

Generate

Generate appointments from IDs via POST /Appointment/Generate. Appointment IDs must be a JSON array of integers.