# Phorest Documentation > This API allows third parties to integrate with Phorest internal core services such as core, online-booking, planner and similar. ## Guides: Documentation - [Getting Started with Phorest API](https://developer.phorest.com/docs/getting-started.md): This page will help you get started with Phorest. You'll be up and running in a jiffy! - [Common API Use Cases](https://developer.phorest.com/docs/common-api-use-cases.md): Some common uses of the Phorest API and a brief description of how these may be achieved. - [Frequently Asked Questions](https://developer.phorest.com/docs/frequently-asked-questions.md) - [Common Errors seen on Appointments/ Bookings Endpoints](https://developer.phorest.com/docs/list-of-errors-seen-on-appointments-bookings-endpoints.md) - [Client Endpoint](https://developer.phorest.com/docs/using-the-client-endpoint.md) - [Client Courses Endpoint](https://developer.phorest.com/docs/client-courses-endpoint.md) - [CSV Export Job Endpoint](https://developer.phorest.com/docs/csv-export-job-endpoint.md) - [Requesting assistance with the Phorest API](https://developer.phorest.com/docs/requesting-assistance-with-the-phorest-api.md) ## API Reference: Third Party API - Review - [List reviews](https://developer.phorest.com/reference/getreviewlist.md): Get a list of reviews for the specified business id and branch id. List can be filtered by client id, client's first name or surname, staff member's first name or surname and date of review - [Retrieve a review](https://developer.phorest.com/reference/getreview.md): Get a review for the specified business id, branch id and review id - Client Credit Account Transaction - [Create a client credit account transaction](https://developer.phorest.com/reference/createtransaction.md): Create and return a client credit account transaction for the specified business id - Voucher Transaction - [List voucher transactions](https://developer.phorest.com/reference/getvouchertransactions.md): Get a paginated list of voucher transactions for the business: voucher sales, top-ups, uses as payment, manual balance changes, and changes to a voucher's client, issue date or expiry date. Filter by… - Client - [Retrieve a client](https://developer.phorest.com/reference/getclient.md): Get a client for the specified business id and client id - [Update a client](https://developer.phorest.com/reference/updateclient.md): Update and return a client for the specified business id and client id - [List clients](https://developer.phorest.com/reference/getclients.md): Get a list of clients for the specified business id. List can be filtered by email, phone, DateTime of update, first and last name, external id, active membership and possibility to include archived,… - [Create a client](https://developer.phorest.com/reference/createclient.md): Create and return a client for the specified business id - [Retrieve client's service histories](https://developer.phorest.com/reference/getclientservicehistories.md): Get a list of client service histories for specified business id and client id - [Retrieve walk-in client](https://developer.phorest.com/reference/getwalkinclient.md): Get a walk-in client for the specified business id - [Retrieve a batch of clients](https://developer.phorest.com/reference/getclientbatch.md): Get a batch of clients for the specified client ids - [Retrieve client's product histories](https://developer.phorest.com/reference/getclientproducthistories.md): Get a list of client product histories for specified business id and client id - ClientCategory - [List client categories](https://developer.phorest.com/reference/getclientcategories.md): Get a list of client categories for the specified business id. List can be filtered by name and possibility to include archived client categories as well as an option to list only archived client… - [Retrieve a client category](https://developer.phorest.com/reference/getclientcategory.md): Get a client category for the specified business id and category id - CheckIn - [Check in appointments](https://developer.phorest.com/reference/checkin.md): Check in appointments for the specified business id, branch id and client id in the specified time range (defaults to today) - Lead - [Create a new lead](https://developer.phorest.com/reference/createlead.md): Creates a new lead. Either contactableByEmail or contactableByMobile need to be provided. - [List leads](https://developer.phorest.com/reference/getleads.md): Get a list of leads for the specified business id and branch id. List can be filtered by lead name, lead status, contactableByEmail flag and contactableByMobile flag with possibility to include… - [Get leads stats](https://developer.phorest.com/reference/getleadsstats.md): List total leads, total conversions, number of leads and conversions made over the past 30 days, and rate of conversions over the past 30 days. - [Update an existing lead](https://developer.phorest.com/reference/updatelead.md): Updates an existing lead. Only the fields provided in the request body are changed. - Tax - [List tax rates](https://developer.phorest.com/reference/gettaxrates.md): Get a list of tax rates for the specified business id and branch id - [Retrieve a tax rate](https://developer.phorest.com/reference/gettaxrate.md): Get a tax rate for the specified business id, branch id and tax rate id - Stock - [Adjust stock quantity](https://developer.phorest.com/reference/performstockadjustment.md): Adjust stock quantity for the specified business id and branch id. Currently only stock increase and deduction are supported - Service Special Offer - [List service special offers](https://developer.phorest.com/reference/getservices_1.md): Get a list of service special offers for the specified business id and branch id. List can be filtered by service category id - Deposit - [Create a deposit payment link](https://developer.phorest.com/reference/createdepositpaymentlink.md): Create a payment link for an in-house deposit on the specified appointments. The deposit amount is automatically calculated based on the branch's deposit settings for the given appointments. Set… - Branch - [List branches](https://developer.phorest.com/reference/getbranches.md): Get a list of branches for the specified business id - Consultation - [Get the consultation form link for an appointment](https://developer.phorest.com/reference/getconsultationlink.md): Get the link to the consultation forms the client still has to fill in for the visit this appointment belongs to. This is the same link Phorest sends to the client by SMS or email before their visit,… - Till Session - [List till sessions](https://developer.phorest.com/reference/gettillsessions.md): Get a paginated list of till sessions for the specified till. Optionally filter by session start/end time range. Results are ordered by session start time, most recent first. - Break - [Retrieve a break](https://developer.phorest.com/reference/getstaffbreak.md): Get a break for the specified business id, branch id and break id - [Update a break](https://developer.phorest.com/reference/updatebreak.md): Update and return a break for the specified business id, branch id and break id - [Delete a break](https://developer.phorest.com/reference/deletebreak.md): Delete a break for the specified business id, branch id and break id - [List breaks](https://developer.phorest.com/reference/getbreaks.md): Get a list of breaks for the specified business id and branch id, with a maximum one month date range. List can be filtered by date of break, staff id, room id and machine id - [Create a break](https://developer.phorest.com/reference/createbreak.md): Create and return a break for the specified business id and branch id - Branch Service - [List branch services](https://developer.phorest.com/reference/getservices.md): Get a list of branch services for the specified business id and branch id. List can be filtered by service category id, service type, possibility to include archived branch services in the list and… - [Retrieve a branch service](https://developer.phorest.com/reference/getservice.md): Get a branch service for the specified business id, branch id and branch service id. There is an option to fetch online categories of branch services - [Link an add-on service to a branch service](https://developer.phorest.com/reference/linkaddon.md): Links an add-on service to the specified branch service. Returns the updated service. - [Unlink an add-on service from a branch service](https://developer.phorest.com/reference/unlinkaddon.md): Removes the link between an add-on service and the specified branch service. Returns the updated service. - Staff WorkTimeTable - [List staff timetables](https://developer.phorest.com/reference/getstaffworktimetables.md): Get a list of staff timetables for the specified business id and branch id, with a maximum one month date range. List can be filtered by date - Course - [List courses](https://developer.phorest.com/reference/getcourses.md): Get a list of courses for the specified business id and branch id. There is a possibility to include archived courses - Time Off Policy - [List time off policies](https://developer.phorest.com/reference/gettimeoffpolicies.md): Get a paginated list of the business's time off policies, ordered alphabetically by name. Time off policies are the types of time off (e.g. Holidays, Sick Leave, Parental Leave) that staff time off… - [Get a time off policy](https://developer.phorest.com/reference/gettimeoffpolicy.md): Get a single time off policy by id. Archived policies are returned too. - CSV Export Job - [Create a CSV export job](https://developer.phorest.com/reference/createcsvexportjob.md): Create and return a CSV export job for the specified business id and branch id - [Retrieve a CSV export job](https://developer.phorest.com/reference/getcsvexportjob.md): Get a CSV export job for the specified business id, branch id and job id - Service Category - [List service categories](https://developer.phorest.com/reference/getservicecategories.md): Get a list of service categories for the specified business id and branch id - Purchase - [Create a purchase](https://developer.phorest.com/reference/createpurchase.md): Create and return a purchase for the specified business id and branch id. Purchase can be for various items including appointments, products, courses and vouchers.
One thing to note… - SaleFee - [List sale fees](https://developer.phorest.com/reference/getsalefeelist.md): Get a list of sale fees for the specified business id and branch id. There is an option to include archived sale fees in the list - [Retrieve a sale fee](https://developer.phorest.com/reference/getsalefee.md): Get a sale fee for the specified business id, branch id and sale fee id - [Retrieve a batch of sale fees](https://developer.phorest.com/reference/getsalefeebatch.md): Get a batch of sale fees for the specified sale fee ids - Voucher - [Retrieve a voucher](https://developer.phorest.com/reference/getvoucher.md): Get a voucher for the specified business id and voucher id - [Update a voucher](https://developer.phorest.com/reference/updatevoucherbalance.md): Update and return a voucher for the specified business id and voucher id. Currently only voucher's remaining balance is updatable - [List vouchers](https://developer.phorest.com/reference/getvouchers.md): Get a list of vouchers for the specified business id. List can be filtered by client id, serial number, DateTime of update and possibility to include used vouchers - [Create a voucher](https://developer.phorest.com/reference/createvoucher.md): Create and return a voucher for the specified business id - Service Package - [List service packages](https://developer.phorest.com/reference/getservicepackages.md): Get a list of service packages for the specified business id and branch id. List can be filtered by service category id - Booking - [Create a booking](https://developer.phorest.com/reference/createbooking.md): Create and return a booking with appointments for specified services - [Cancel a booking](https://developer.phorest.com/reference/cancelbooking.md): Cancel an activated booking - [Create a note for the booking](https://developer.phorest.com/reference/appendnotetobooking.md): Create a note for the booking - [Activate a booking](https://developer.phorest.com/reference/activatebooking.md): Activate a reserved booking with optional deposit amount provided - PaymentType - [List payment types](https://developer.phorest.com/reference/getsupplementalpaymenttypes.md): Get a list of payment types for the specified business id - [Retrieve a payment type](https://developer.phorest.com/reference/getsupplementalpaymenttype.md): Get a payment type for the specified business id and payment type id. - Loyalty Points - [Update loyalty points balance](https://developer.phorest.com/reference/changeloyaltypoints.md): Update loyalty points for the specified business id - Branch WorkTimeTable - [Retrieve a branch timetable](https://developer.phorest.com/reference/getbranchworktimetable.md): Get a branch timetable for the specified business id and branch id, with a maximum one month date range. Start and end date must be provided - Machine - [Get a list of machines for the specified business id and branch id. List can be filtered by DateTime of update with a possibility to include archived machines](https://developer.phorest.com/reference/getmachines.md): List machines - [Get a machine for the specified business id, branch id and machine id](https://developer.phorest.com/reference/getmachine.md): Retrieve a machine - Product - [List products](https://developer.phorest.com/reference/getproducts.md): Get a list of products for the specified business id and branch id. List can be filtered by product type, DateTime of update, name and barcode and possibility to include archived products in the list… - Staff - [List staffs](https://developer.phorest.com/reference/getstafflist.md): Get a list of staffs for the specified business id and branch id. There is an option to include archived staffs in the list - [Retrieve a staff](https://developer.phorest.com/reference/getstaff.md): Get a staff member for the specified business id, branch id and staff id - [Retrieve a batch of staffs](https://developer.phorest.com/reference/getstaffbatch.md): Get a batch of staff members for the specified staff ids - Appointment - [Update an appointment](https://developer.phorest.com/reference/updateappointment.md): Update and return an appointment for the specified business id, branch id and appointment id - [Update an appointment note](https://developer.phorest.com/reference/notes.md): Update and return an appointment note - [Check in an appointment](https://developer.phorest.com/reference/checkin_1.md): Check in the selected appointment - [Confirm appointments](https://developer.phorest.com/reference/confirmappointments.md): Confirm appointments for the specified client id on a specified date - [Cancel appointments](https://developer.phorest.com/reference/cancelappointments.md): Cancel appointments by list of ids - [List appointments](https://developer.phorest.com/reference/getappointments.md): Get a list of appointments for the specified business id and branch id, with a maximum one month date range. List can be filtered by date of appointment, DateTime of update, staff id, room id,… - [Retrieve an appointment](https://developer.phorest.com/reference/getappointment.md): Retrieve an appointment for the specified business id, branch id and appointment id - Room - [List rooms](https://developer.phorest.com/reference/getrooms.md): Get a list of rooms for the specified business id and branch id. List can be filtered by DateTime of update with a possibility to include archived rooms - [Retrieve a room](https://developer.phorest.com/reference/getroom.md): Get a room for the specified business id, branch id and room id - Inventory Transaction - [List inventory transactions](https://developer.phorest.com/reference/getinventorytransactions.md): Get a list of inventory transactions for the specified business id and branch id. List can be filtered by transaction type, deleted status, compensating transaction status, and update time range. - Appointment Availability - [List appointment availabilities](https://developer.phorest.com/reference/checkappointmentavailability.md): Get a list of available appointment times for the specified business id and branch id, within the specified date range for the specified services - Client Course - [Retrieve a client course](https://developer.phorest.com/reference/getclientcourse.md): Get a client course for the specified business id and client course id - [Update a client course](https://developer.phorest.com/reference/updateclientcourse.md): Update and return a client course for the specified business id and client course id - [List client courses](https://developer.phorest.com/reference/getclientcourses.md): Get a list of client courses for the specified business id. List can be filtered by branch id, client id and a possibility to include archived client courses or courses with no remaining units. - Till - [Retrieve a till balance](https://developer.phorest.com/reference/gettillbalance.md): Get a till balance for the specified business id, client id and till id - [List tills for a branch](https://developer.phorest.com/reference/gettills.md): Returns all tills for the specified branch. ## Changelog - [Version 1.44.0](https://developer.phorest.com/changelog/swagger-changelog-1-44-0.md) - [Version 1.43.3](https://developer.phorest.com/changelog/swagger-changelog-1-43-3.md) - [Version 1.43.2](https://developer.phorest.com/changelog/swagger-changelog-1-43-2.md) - [Version 1.43.1](https://developer.phorest.com/changelog/swagger-changelog-1-43-1.md) - [Version 1.43.0](https://developer.phorest.com/changelog/swagger-changelog-1-43-0.md) - [Version 1.42.1](https://developer.phorest.com/changelog/swagger-changelog-1-42-1.md) - [Version 1.42.0](https://developer.phorest.com/changelog/swagger-changelog-1-42-0.md) - [Version 1.41.0](https://developer.phorest.com/changelog/swagger-changelog-1-41-0.md) - [Version 1.40.1](https://developer.phorest.com/changelog/swagger-changelog-1-40-1.md) - [Version 1.40.0](https://developer.phorest.com/changelog/swagger-changelog-1-40-0.md)