# PracSuite API This is the official PracSuite API. It follows standard REST conventions, so you can work with it using any HTTP client and any programming language that can send HTTP requests. All responses are returned in JSON format. Version: v1 License: MIT ## Servers Prod server ``` https://api.pracsuite.com/v1 ``` ## Security ### x-api-key Vendor API Key Type: apiKey In: header Name: x-api-key ### A-api-key PracSuite generated api key Type: apiKey In: header Name: A-api-key ## Download OpenAPI description [PracSuite API](https://docs.api.pracsuite.com/_bundle/openapi/index.yaml) ## Appointment test ### List Appointments - [GET /appointment](https://docs.api.pracsuite.com/openapi/appointment/listappointments-get.md) ### Create Appointment - [POST /appointment](https://docs.api.pracsuite.com/openapi/appointment/createappointment-post.md): This endpoint is used to create an Appointment in the appointment book ### Reserve Appointment - [POST /reserve_appointment](https://docs.api.pracsuite.com/openapi/appointment/reserveappointment-post.md): This endpoint is used to reserve a spot in the appointment book before applying an appointment_type_id, etc. After this you then call Finalise Appointment to apply the rest of the fields. The exception is when you pass rule_out: true. Then you don't need to call finalise ### Get Appointment - [GET /appointment/{appointment_id}](https://docs.api.pracsuite.com/openapi/appointment/getappointment-get.md) ### Finalise Appointment - [POST /appointment/{appointment_id}](https://docs.api.pracsuite.com/openapi/appointment/finaliseappointment-post.md) ### List Appointments by Appointment Type - [GET /appointment_type/{appointment_type_id}/appointment](https://docs.api.pracsuite.com/openapi/appointment/listappointmentsbyappointmenttype-get.md) ### List Appointments by Business - [GET /business/{business_id}/appointment](https://docs.api.pracsuite.com/openapi/appointment/listappointmentsbybusiness-get.md) ### List Appointments by Profession - [GET /profession/{profession_id}/appointment](https://docs.api.pracsuite.com/openapi/appointment/listappointmentsbyprofession-get.md) ### List Appointments by Patient - [GET /patient/{patient_id}/appointment](https://docs.api.pracsuite.com/openapi/appointment/listappointmentsbypatient-get.md) ## Appointment Type test ### List Appointment Types - [GET /appointment_type](https://docs.api.pracsuite.com/openapi/appointment-type/listappointmenttypes-get.md) ### Get Appointment Type - [GET /appointment_type/{appointment_type_id}](https://docs.api.pracsuite.com/openapi/appointment-type/getappointmenttype-get.md) ### Get Appointment Types by Profession - [GET /profession/{profession_id}/appointment_type](https://docs.api.pracsuite.com/openapi/appointment-type/getprofessionappointmenttypes-get.md) ## Available Appointment Avaiasldfsdflsd ### List available appointment times - [GET /available_appointments](https://docs.api.pracsuite.com/openapi/available-appointment/listavailableappointments-get.md) ### Get Next available appointment time - [GET /next_available_appointment](https://docs.api.pracsuite.com/openapi/available-appointment/getnextavailableappointment-get.md) ## Available Group Appointment Avaiasldfsdflsd ### List available group appointments - [GET /available_group_appointments](https://docs.api.pracsuite.com/openapi/available-group-appointment/listavailablegroupappointments-get.md) ### Get Next available group appointment time - [GET /next_available_group_appointment](https://docs.api.pracsuite.com/openapi/available-group-appointment/getnextavailablegroupappointment-get.md) ## Business sdfsfd ### List all Businesses - [GET /business](https://docs.api.pracsuite.com/openapi/business/listbusinesses-get.md) ### Get Business - [GET /business/{business_id}](https://docs.api.pracsuite.com/openapi/business/getbusiness-get.md) ## Fee Category sdfsfd ### List all Fee Categories - [GET /fee_category](https://docs.api.pracsuite.com/openapi/fee-category/listfeecategories-get.md) ## Item sdfsfd ### List Items - [GET /item](https://docs.api.pracsuite.com/openapi/item/listitems-get.md) ### Get Item - [GET /item/{item_id}](https://docs.api.pracsuite.com/openapi/item/getitem-get.md) ## Item Group sdfsfd ### List Item Groups - [GET /item_group](https://docs.api.pracsuite.com/openapi/item-group/listitemgroups-get.md) ### Get Item Group - [GET /item_group/{item_group_id}](https://docs.api.pracsuite.com/openapi/item-group/getitemgroup-get.md) ## Patient Patients are the people that book in for appointments. When you're working with patient information, make sure you abide by the relevant regulations for security and privacy. A couple of fields in the patient record deserve special consideration: `accepted_privacy_policy` stores the patient's consent to the business's own privacy policy. Values can be null (no response), true (accepted) or false (rejected). Please consider how this may affect you storing information on this patient. `time_zone` will contain a valid IANA time zone identifier if the patient's time zone has been set, or null if it hasn't. It can be set via the API, in which case it accepts IANA time zone identifiers. ### List all Patients - [GET /patient](https://docs.api.pracsuite.com/openapi/patient/listpatients-get.md) ### Create Patient - [POST /patient](https://docs.api.pracsuite.com/openapi/patient/createpatient-post.md) ### Get Patient - [GET /patient/{patient_id}](https://docs.api.pracsuite.com/openapi/patient/getpatient-get.md) ## Practitioner test ### List all Practitioners - [GET /practitioner](https://docs.api.pracsuite.com/openapi/practitioner/listpractitioners-get.md) ### Get Practitioner - [GET /practitioner/{practitioner_id}](https://docs.api.pracsuite.com/openapi/practitioner/getpractitioner-get.md) ### List Practitioners from Business - [GET /business/{business_id}/practitioner](https://docs.api.pracsuite.com/openapi/practitioner/listpractitionersfrombusiness-get.md) ### List Practitioners from Profession - [GET /profession/{profession_id}/practitioner](https://docs.api.pracsuite.com/openapi/practitioner/listpractitionersfromprofession-get.md) ## Profession test ### List all Professions - [GET /profession](https://docs.api.pracsuite.com/openapi/profession/listprofessions-get.md) ### Get Profession - [GET /profession/{profession_id}](https://docs.api.pracsuite.com/openapi/profession/getprofession-get.md) ## Pronoun test ### List all Pronouns - [GET /pronoun](https://docs.api.pracsuite.com/openapi/pronoun/listpronouns-get.md) ## Resource test ### List Resources - [GET /resource](https://docs.api.pracsuite.com/openapi/resource/listresources-get.md) ### Get Resource - [GET /resource/{resource_id}](https://docs.api.pracsuite.com/openapi/resource/getresource-get.md) ### List Resources by Appointment - [GET /appointment/{appointment_id}/resource](https://docs.api.pracsuite.com/openapi/resource/listresourcesbyappointment-get.md) ### List Resources by Appointment Type - [GET /appointment_type/{appointment_type_id}/resource](https://docs.api.pracsuite.com/openapi/resource/listresourcesbyappointmenttype-get.md) ## Sex test ### List all sexes - [GET /sex](https://docs.api.pracsuite.com/openapi/sex/listsex-get.md)