latestOpenAPI 3.0.0Apache 2.02026-08-201250995.7 KB

bd9694db5fce

Appointments

Get all Appointments

Permissions needed: VIEW_APPOINTMENTS Get all appointments in a given interval for a given clinic and vet

get/api/v1/appointments

Query parameters

filter[patient_id]integer[]

Ids of the patients that are related to the entity

filter[visit_type_id]string

Filter by visit type ID

filter[date_before]string

Date before(Y-m-d)

filter[date_after]string

Date after(Y-m-d)

filter[statuses]integer[]

Statuses of appointments to fetch. Options 0 - Pending 1 - Pending Client Approval 2 - Pending Clinic Approval 3 - Rescheduled Clinic Approval 4 - Rescheduled Client Approval 5 - Confirmed 6 - Canceled By Client 7 - Canceled By Clinic' 8 - Automatically Created' 9 - No Show

filter[patient.owners.id]integer[]

Pet Parent ID

filter[date_between]string[]

Dates Between (start_date, end_date), format: YYYY-MM-DD

filter[last_fetched]string

Last Appointment Fetched

includestring

Additional info to include. You can use multiple, comma separated. Options: patient,patient.species,patient.breed,patient.crossBreed,patient.owners,patient.owners.appDownloadNotification,patient.owners.clients,room,event, services (service-packages), clinic,clinic.rooms,vet,vet.vetRolesAll,requests,notes,consentForms,consentForms.printableFile,visitType,visitType.tailsIntakeRule

sortstring

Sort by. You can use multiple, comma separated. Options: datetime_start_utc

Parameters

#/paths/~1api~1v1~1files/get/parameters/6 — unresolved $ref
#/paths/~1api~1v1~1pets/get/parameters/1 — unresolved $ref
#/paths/~1api~1v1~1tags/get/parameters/5 — unresolved $ref
#/paths/~1api~1v1~1pets/get/parameters/11 — unresolved $ref

Response

Successful operation

dataData[] — unresolved $ref