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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Phorest

Phorest Staff API

Staff records, rota/work-time tables, and staff breaks.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 8 operations across 5 paths, and defines 4 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.

8 operations 5 paths 4 schemas 1 DELETE5 GET1 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
Contact
Phorest API Support
License
Proprietary - partner access only
Resource Areas
1

Authentication & Security 1

Phorest Staff 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 8

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

Staff 8

Staff records, rota/work-time tables, and staff breaks.

GET
/{businessId}/branch/{branchId}/staff
List staff
getStaffList 7 params → 200400404429500
GET
/{businessId}/branch/{branchId}/staff/{staffId}
Retrieve a staff member
getStaff 3 params → 200404
GET
/{businessId}/branch/{branchId}/staff-work-time-table
List staff work time tables (rota)
getStaffWorkTimeTables 4 params → 200
GET
/{businessId}/branch/{branchId}/staff/{staffId}/break
List a staff member's breaks
getBreaks 3 params → 200
POST
/{businessId}/branch/{branchId}/staff/{staffId}/break
Create a staff break
createBreak 3 params body → 201
GET
/{businessId}/branch/{branchId}/staff/{staffId}/break/{breakId}
Retrieve a staff break
getStaffBreak 4 params → 200404
PUT
/{businessId}/branch/{branchId}/staff/{staffId}/break/{breakId}
Update a staff break
updateBreak 4 params body → 200404
DELETE
/{businessId}/branch/{branchId}/staff/{staffId}/break/{breakId}
Delete a staff break
deleteBreak 4 params → 200404

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are Staff (6 properties), StaffWorkTimeEntry (4 properties), StaffBreakInput (3 properties). Each schema is shown below with its type and property counts.

StaffBreakInput
object
3 properties
StaffWorkTimeEntry
object
4 properties
StaffBreak
Staff
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

phorest-staff-api-openapi.yml Raw ↑

Other APIs Phorest publishes across the network.

Phorest Appointments API
AE Profile APIs.io
Phorest Bookings API
AE Profile APIs.io
Phorest Branches API
AE Profile APIs.io
Phorest Clients API
AE Profile APIs.io
Phorest Courses API
AE Profile APIs.io
Phorest Leads API
AE Profile APIs.io
Phorest Loyalty API
AE Profile APIs.io
Phorest Products API
AE Profile APIs.io
Phorest Purchases API
AE Profile APIs.io
Phorest Reporting API
AE Profile APIs.io
Phorest Reviews API
AE Profile APIs.io
Phorest Services API
AE Profile APIs.io
#Staff
← Back to P APIs
API Details
ID
phorest:phorest-staff-api
Base URL
https://api-gateway-eu.phorest.com/third-party-api-server/api/business
Docs
https://developer.phorest.com/reference/getclients
Provider
Phorest
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=phorest-staff-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/phorest-staff-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Phorest Staff 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.