Skip to content
/
List Cancelled Appointmen...

List Cancelled Appointments by Appointment Type

Request

Security
x-api-key and a-api-key
Path
appointment_type_idintegerrequired
Query
pageinteger, >= 1
Example:page=1
page_sizeinteger, [ 1 .. 200 ]
Example:page_size=50
sort_byArray of strings

Comma separated search fields. See Sorting

Example:sort_by=["appointment_id","app_time","cancellation_time"]
include_deletionsboolean
Default:true
q[]Array of strings

Filter result by one or more fields.

See Query Filtering

Available filters:

ValueFormat
createdtimestamp
updatedtimestamp
cancellation_timetimestamp
app_timedatetime
profession_idinteger
business_idinteger
client_idinteger
practitioner_idinteger
GET
/appointment_type/{appointment_type_id}/cancelled_appointment
curl -i -X GET \
  'https://api.pracsuite.com/v1/appointment_type/{appointment_type_id}/cancelled_appointment?page=1&page_size=50&sort_by=%5B%22field_name%22%2C%22field_name%22%5D&include_deletions=true&q%5B%5D=string' \
  -H 'a-api-key: YOUR_API_KEY_HERE' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Successful

Bodyapplication/json
cancelled_appointmentsArray of objects(Cancelled Appointment)
total_entriesinteger
Response
{
  "cancelled_appointments": [
    { … }
  ],
  "total_entries": 0,
  "links": {
    "self": "https://api.pracsuite.com/v1/appointment_type/1/cancelled_appointment?page=2",
    "previous": "https://api.pracsuite.com/v1/appointment_type/1/cancelled_appointment?page=1",
    "next": "https://api.pracsuite.com/v1/appointment_type/1/cancelled_appointment?page=3"
  }
}