How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Phorest Appointments API

Appointment lifecycle - list, retrieve, update, cancel, confirm, check in.

Phorest Appointments API is one of 14 APIs that Phorest publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Appointments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 6 operations across 5 paths, and defines 2 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 3 base URLs: https://api-gateway-eu.phorest.com/third-party-api-server/api/business, https://api-gateway-us.phorest.com/third-party-api-server/api/business, https://platform.phorest.com/third-party-api-server/api/business.

6 operations 5 paths 2 schemas 2 GET3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api-gateway-eu.phorest.com/third-party-api-server/api/business
Authentication
HTTP Basic
Resource Areas
1

Authentication & Security 1

Phorest Appointments API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

  • basicAuth — Username is global/{email}, using the email address Phorest associated with the granted API access. Password is the API password issued by Phorest support.

Paths & Operations 6

Across 5 paths, the API surfaces 6 operations — 2 GET, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Appointments 6

Appointment lifecycle - list, retrieve, update, cancel, confirm, check in.

GET
/{businessId}/branch/{branchId}/appointment
List appointments
getAppointments 17 params → 200400404429500
GET
/{businessId}/branch/{branchId}/appointment/{appointmentId}
Retrieve an appointment
getAppointment 3 params → 200404
PUT
/{businessId}/branch/{branchId}/appointment/{appointmentId}
Update an appointment
updateAppointment 3 params body → 200400404429
POST
/{businessId}/branch/{branchId}/appointment/{appointmentId}/cancel
Cancel an appointment
cancelAppointment 3 params → 200404
POST
/{businessId}/branch/{branchId}/appointment/{appointmentId}/confirm
Confirm an appointment
confirmAppointment 3 params → 200404
POST
/{businessId}/branch/{branchId}/appointment/{appointmentId}/checkin
Check in an appointment
checkInAppointment 3 params → 200404

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed is AppointmentInput (8 properties). Each schema is shown below with its type and property counts.

AppointmentInput
object
8 properties
Appointment

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

phorest-appointments-api-openapi.yml Raw ↑

Other APIs Phorest publishes across the network.

Phorest Bookings API
Phorest Branches API
Phorest Clients API
Phorest Courses API
Phorest Leads API
Phorest Loyalty API
Phorest Products API
Phorest Purchases API
Phorest Reporting API
Phorest Reviews API
Phorest Services API
Phorest Staff API
Where this information came from

This is an independent, third-party profile of Phorest Appointments API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.