Phorest

Phorest

Phorest is salon and spa software (appointments, clients, staff, retail, vouchers). This connector uses the Phorest Third Party API. Every call is scoped to one business (PHOREST_BUSINESS_ID), and most to a branch (branch_id).

Setup

1. API access is granted by Phorest: request it through Phorest support (https://support.phorest.com, "API access" ticket) from an e-mail address registered on your business, with your Phorest account number.
2. Phorest sends a username and password. The username has a global/ prefix, for example global/[email protected]; keep the prefix. Put them into PHOREST_USERNAME and PHOREST_PASSWORD (HTTP Basic auth).
3. PHOREST_BUSINESS_ID is the business id that comes with the credentials (ask [email protected] if it is missing).
4. PHOREST_API_URL: https://api-gateway-eu.phorest.com for Europe, https://api-gateway-us.phorest.com for the United States, Canada and Australia. A US account on the EU host answers 401.

Start here

• phorest_list_branches returns the branchId of each salon; pass it as branch_id.
• Diary: phorest_list_appointments with from_date/to_date (yyyy-MM-dd, at most one month apart).
• Client lookup: phorest_list_clients by email, phone or name (~Jo% for a prefix), then phorest_get_client and the history tools.
• Free slots: phorest_check_availability with service_selections (service ids from phorest_list_services).

Pagination

page starts at 0, size up to 200 (1000 for staff timetables). Answers carry page.totalElements and page.totalPages.

Data and limits

The API is live: it reads and changes the real salon data. Phorest does not offer card payments or Phorest Pay through the API, and no webhooks; poll with updated_from / updatedAfter filters. Date ranges on appointments, breaks and timetables are limited to one month.

Writes

Creating clients and bookings and cancelling appointments are included but installed switched off.