Be the first to get access to new connectors. Get early access →
ConnectorBay Early access

Phorest US (BYOK) — connector documentation

  • MCP endpoint: https://byok-phorest-us.connectorbay.com/mcp
  • REST API: POST https://byok-phorest-us.connectorbay.com/v1/tools/{tool_name}, described by the OpenAPI 3.1 spec at https://byok-phorest-us.connectorbay.com/openapi.json
  • Transport: Streamable HTTP, stateless, MCP specification 2025-06-18 or later
  • Authentication: your own Phorest US Phorest API username (starts with global/), sent in the X-Upstream-Key header and the Phorest API password in X-Upstream-Key-2 of every request (never stored, logged or cached)
  • Health: https://byok-phorest-us.connectorbay.com/health · Tool schemas: https://byok-phorest-us.connectorbay.com/tools.json
  • Publisher: Unify Dynamics LLC · connectorbay.com/byok-phorest-us · agent@connectorbay.com

What Phorest US (BYOK) is for

Phorest US (BYOK) lets an AI assistant read your own Phorest US data through the Phorest US API with a key you supply (Phorest API username (starts with global/)). Read-only: 10 tools (list_branches, list_services, list_service_categories, list_service_packages, list_special_offers, list_products, list_appointments, list_reviews, list_courses, list_tax_rates). The BYOK key travels with each request, is used for that one call only and is never stored, logged or cached; it is only ever sent to api-gateway-us.phorest.com. Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by Phorest US. Phorest US and its logos are trademarks of their owners and are used only to say which service the connector works with.

Ask your assistant things like:

  • "Which branches does my Phorest business have?"
  • "What services and prices does this branch offer?"
  • "What service categories does this branch use?"
  • "Which service packages does this branch sell?"
  • "Which special offers are running at this branch?"
  • "Which products are low on stock at this branch?"

What it does

  • list_branches: List the salon branches of a business with name, time zone, address, currency and branch id.
  • list_services: List the services of one branch with name, category, duration, price, online-booking flags and archived flag.
  • list_service_categories: List the service categories of one branch with name, description and colour.
  • list_service_packages: List the service packages (bundles of services sold together) of one branch.
  • list_special_offers: List the service special offers of one branch.
  • list_products: List the retail products of one branch with brand, category, price, barcode and quantity in stock; can show only low or out-of-stock items.
  • list_appointments: List appointments of one branch in a date range (at most one month) with service, staff, times, price, state and activation state; client names are not included.
  • list_reviews: List client reviews of one branch with rating, text, review and visit dates, the client's name and the staff member reviewed.
  • list_courses: List the courses (multi-visit treatment plans) of one branch with name, price and spacing rules.
  • list_tax_rates: List the tax rates configured for one branch, for services and products.

BYOK key

You bring your own Phorest US Phorest API username (starts with global/) (https://developer.phorest.com/docs/getting-started). Your assistant sends it in the X-Upstream-Key header with each request. ConnectorBay uses it for that one call only: it is never stored, logged or cached, never shown in an answer, and it is only sent to api-gateway-us.phorest.com over https, with no redirects followed. Create a key with the fewest permissions the tools need (read-only if the provider offers it), and revoke it at the provider whenever you like.

Data sources

Live from the Phorest US API (api-gateway-us.phorest.com) with a BYOK key; documentation: https://developer.phorest.com/docs/getting-started. Endpoints checked against that documentation on 2026-10-16.

What it is not

Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by Phorest US. Phorest US and its logos are trademarks of their owners and are used only to say which service the connector works with. It is read-only: it never creates, changes, sends or deletes anything in your Phorest US account.

Built for: Worldwide. Languages: English.