WellnessLiving API (UAT) - v1.2026-02
  1. appointment
WellnessLiving API (UAT) - v1.2026-02
  • WellnessLiving API - [Feb-2026]
  • Auth
    • Authentication
  • appointment
    • /v1/appointment/book/asset/category
      GET
    • /v1/appointment/book/asset/list
      GET
    • /v1/appointment/book/asset/service
      GET
    • /v1/appointment/book/finish
      GET
    • /v1/appointment/book/finish
      POST
    • /v1/appointment/book/payment/paymentPost
      GET
    • /v1/appointment/book/product
      GET
    • /v1/appointment/book/schedule/calendar
      GET
    • /v1/appointment/book/schedule/day-time
      GET
    • /v1/appointment/book/service/category
      GET
    • /v1/appointment/book/service/list
      GET
    • /v1/appointment/book/staff/list
      GET
  • book-process
    • /v1/book/process/info
    • /v1/book/process/payment
    • /v1/book/process/purchase
    • /v1/book/process/purchase/element/list
  • business-data
    • /v1/business
    • /v1/business/franchise/location
    • /v1/business/skin
  • catalog
    • /v1/catalog/list
    • /v1/catalog/staff/catalog/list
  • classes
    • /v1/classes/list
    • /v1/classes/promotion
    • /v1/classes/view/element
  • collector-debt
    • /v1/collector/debt/list
    • /v1/collector/debt/pay
    • /v1/collector/debt/transaction
  • drive
    • /v1/drive/product/image/upload
  • ecommerce
    • /v1/ecommerce/order/sync
  • event
    • /v1/event/book/list
    • /v1/event/book/view/element
    • /v1/event/list
  • lead
    • /v1/lead/info
    • /v1/lead/info
  • location
    • /v1/location/list
    • /v1/location/view
  • login
    • /v1/login/attendance/list
    • /v1/login/search/settings
    • /v1/login/search/settings
    • /v1/login/search/staff-app/list
  • member
    • /v1/member/info
  • profile
    • /v1/profile/contract
    • /v1/profile/create
    • /v1/profile/fields
    • /v1/profile/purchase/list
    • /v1/profile/purchase/list/element
  • promotion
    • /v1/promotion
    • /v1/promotion/list
  • purchase
    • /v1/purchase/receipt
  • report
    • /v1/report/data
    • /v1/report/query
  • report-dev
    • /v1/report/customization-form
    • /v1/report/filter-info
  • schedule
    • /v1/schedule/class/list
    • /v1/schedule/class/view
    • /v1/schedule/class/view
    • /v1/schedule/page/element
    • /v1/schedule/page/list
    • /v1/schedule/tab
  • shop
    • /v1/shop/category
  • staff
    • /v1/staff/list
    • /v1/staff/view
  • user
    • /v1/user
  • visit
    • /v1/visit/status
  1. appointment

/v1/appointment/book/staff/list

GET
/v1/appointment/book/staff/list

Description#

Retrieves the list of staff members that can be booked for a specific appointment service at a given business location and region. This endpoint is typically used as part of the appointment booking flow to let clients choose which staff member will perform the selected service.

HTTP#

Method: GET
Path: /v1/appointment/book/staff/list

Query Parameters#

All parameters are required for a meaningful result and act as filters to scope staff to a particular business, location, and service.
id_region (number)
Region identifier within the platform.
Example values: 1, 2.
Used to scope results to a specific geographic or logical region.
k_business (number/string)
Business (account) identifier.
Example values: 49197, 50217.
Ensures only staff for the specified business are returned.
k_location (number/string)
Location (site/studio) identifier under the business.
Example values: 315968, 5000000248.
Limits results to staff associated with this physical/virtual location.
k_service (number/string)
Service identifier for the appointment being booked.
Example values: 235266, 5000000996.
Returns only staff that can be booked for this specific service.

Successful Response (200 OK)#

A successful response returns booking-eligible staff and related flags that describe how staff/gender selection should behave in the booking UI.

Top-level fields#

a_staff (array)
List of staff that can be assigned to the appointment under the given filters.
Each staff object has:
id_gender (number)
Numeric gender identifier for the staff member (e.g., 1, 2).
k_staff (string)
Internal staff identifier.
s_position (string)
Staff role/position (e.g., "Flower"), may be empty.
s_staff (string)
Display name of the staff member (e.g., "Barbie Girl").
uid (string)
User identifier associated with the staff member.
xml_biography (string)
Staff biography as HTML/XML markup. May be an empty string when not provided.
can_book_unavailable_staff (boolean)
Indicates whether the booking flow may allow selection of staff that are normally marked as unavailable for the requested time.
has_gender (boolean)
Indicates whether gender-based selection or filtering is relevant for this booking context.
has_staff (boolean)
Indicates whether there is at least one staff member explicitly selected/assigned at this stage of the booking.
is_gender_different (boolean)
Indicates whether there is a mismatch or difference in gender selection/preferences relative to available staff.
status (string)
API call status, expected to be "ok" for a successful request.
s_version (string)
Internal version string for the response payload, useful for debugging or client compatibility checks.

Usage Notes#

Use this endpoint after the client has chosen region, business, location, and service in the booking flow.
The a_staff array may be empty if no staff are available or configured for the given criteria.
The boolean flags (can_book_unavailable_staff, has_gender, has_staff, is_gender_different) should be used to drive booking UI logic and validation.

Request

Query Params

Responses

🟢200
application/json
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET '/v1/appointment/book/staff/list?id_region={{id_region}}&k_business={{k_business}}&k_location={{k_location}}&k_service=undefined' \
--header 'Content-Type: text/plain' \
--data-raw ''
Response Response Example
{}
Modified at 2026-02-26 17:13:05
Previous
/v1/appointment/book/service/list
Next
/v1/book/process/info
Built with