Skip to content
/
Get Cancelled Appointment

Get Cancelled Appointment

Request

Security
x-api-key and a-api-key
Path
appointment_idintegerrequired
GET
/cancelled_appointment/{appointment_id}
curl -i -X GET \
  'https://api.pracsuite.com/v1/cancelled_appointment/{appointment_id}' \
  -H 'a-api-key: YOUR_API_KEY_HERE' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Successful

Bodyapplication/json
row_numintegerread-only
total_rowsintegerread-only
tenant_idinteger
appointment_idinteger
client_idinteger
app_timestring^\d{4}-\d{2}-\d{2}[Tt]\d{2}:\d{2}:\d{2}$

ISO 8601 local datetime in the tenant's timezone.

Example:"2026-01-01T12:05:30"
descriptionstring
appointment_typestring
appointment_statusstring
categorystring
durationinteger
notesstring
practitioner_idinteger
business_idinteger
profession_idinteger
item_codestring
account_idinteger
cancellation_timestring, (date-time)^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,6...

RFC 3339 UTC date-time (Z) with microsecond precision.

Example:"2020-09-12T11:09:42.687393Z"
cancelled_bystring
cancellationboolean
reasonstring
appointment_cancellation_reason_idinteger
Response
{
  "row_num": 0,
  "total_rows": 0,
  "links": {
    "self": "https://api.pracsuite.com/v1/cancelled_appointment/1"
  },
  "tenant_id": 0,
  "appointment_id": 0,
  "client_id": 0,
  "app_time": "2026-01-01T12:05:30",
  "description": "string",
  "appointment_type": "string",
  "appointment_status": "string",
  "category": "string",
  "duration": 0,
  "notes": "string",
  "practitioner_id": 0,
  "business_id": 0,
  "profession_id": 0,
  "item_code": "string",
  "account_id": 0,
  "cancellation_time": "2020-09-12T11:09:42.687393Z",
  "cancelled_by": "string",
  "cancellation": true,
  "reason": "string",
  "appointment_cancellation_reason_id": 0
}