WellnessLiving API (UAT) - v1.2026-02
  1. schedule
WellnessLiving API (UAT) - v1.2026-02
  • WellnessLiving API - [Feb-2026]
  • Auth
    • Authentication
  • appointment
    • /v1/appointment/book/asset/category
    • /v1/appointment/book/asset/list
    • /v1/appointment/book/asset/service
    • /v1/appointment/book/finish
    • /v1/appointment/book/finish
    • /v1/appointment/book/payment/paymentPost
    • /v1/appointment/book/product
    • /v1/appointment/book/schedule/calendar
    • /v1/appointment/book/schedule/day-time
    • /v1/appointment/book/service/category
    • /v1/appointment/book/service/list
    • /v1/appointment/book/staff/list
  • 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
      GET
    • /v1/schedule/class/view
      GET
    • /v1/schedule/class/view
      POST
    • /v1/schedule/page/element
      GET
    • /v1/schedule/page/list
      GET
    • /v1/schedule/tab
      GET
  • shop
    • /v1/shop/category
  • staff
    • /v1/staff/list
    • /v1/staff/view
  • user
    • /v1/user
  • visit
    • /v1/visit/status
  1. schedule

/v1/schedule/class/view

GET
/v1/schedule/class/view

GET /v1/schedule/class/view#

Retrieve detailed information about a specific scheduled class instance for a given business, region, and start date/time.
This endpoint is typically used to:
Display details of a single class on a class details page.
Check whether the class can be booked and why it might be restricted.
Show related staff, location, and pricing information.

Request#

Method: GET
URL: /v1/schedule/class/view

Query Parameters#

id_region (number, required)
Region/tenant identifier used to scope the request.
Example: 2.
k_business (number, required)
Business identifier in WellnessLiving.
Example: 49197.
dt_date (string, required)
Start date and time of the specific class instance.
Format: YYYY-MM-DD HH:mm:ss in global/business time.
Example: 2024-10-28 16:00:00.
k_class_period (number, required)
Unique key of the class period (scheduled class instance).
Example: 100000466946.
Note: All four parameters must refer to the same scheduled class occurrence; mismatched values may return no data or an error.

Successful Response (200)#

On success, the response body has status: "ok" and includes high-level data:
a_class
Core details about the scheduled class instance, including:
k_class: Class key.
s_title: Class name.
html_description: Main description (HTML).
html_special: Additional/special information (HTML).
a_image: Image metadata (s_url, dimensions, flags).
s_duration / i_duration: Duration (e.g., "60 min", 60).
dt_date_global / dt_date_local: Start time in global vs. local time.
text_timezone: Local timezone identifier.
i_capacity: Max capacity.
i_book, i_book_active: Booking counts.
can_book: Boolean indicating if the current user can book.
html_deny_reason: HTML message describing why booking is not allowed.
is_event, is_virtual, id_virtual_provider, url_virtual_join: Event/virtual class details.
m_price, hide_price: Pricing and visibility.
Various flags controlling booking/waitlist behavior (is_book, is_cancel, is_wait_list_enabled, is_wait, etc.).
a_location
Location information for the class:
k_location: Location key.
s_title: Location name.
s_address, s_map: Address and map-friendly address.
f_latitude, f_longitude: Coordinates.
s_phone: Location phone.
f_rate: Rating.
a_staff
Array of staff associated with this class instance, each with:
k_staff: Staff key.
s_name, s_family, s_name_full.
s_position.
is_substitute.
xml_biography: HTML/markup biography.
a_virtual_location
Virtual location details (if applicable).
a_asset
List of related assets (e.g., rooms, equipment), if any.
a_session_result
Session result details, if present.
a_visits_required
Information about required visits/passes, if applicable.
status
"ok" on success.
s_version
Internal version identifier for the response.
__a_message
Array of internal/business-policy messages related to booking rules and timing.

Booking Restrictions & Business Rules#

The response includes several fields that affect whether the class can be booked:
can_book (boolean)
High-level flag indicating if the current user is allowed to book this class.
html_deny_reason (HTML string)
A user-facing explanation of why booking is not allowed (e.g., promotion-only, age restrictions, cutoff times, membership requirements).
is_promotion_only (boolean)
When true, the class can only be booked using specific promotions/passes.
i_capacity, i_book, i_wait, i_wait_limit, i_wait_spot, is_wait_list, is_wait_list_enabled
Fields controlling capacity and waitlist behavior (spots available, waitlist availability, etc.).
__a_message
Contains structured messages describing business policies (such as minimum lead time, maximum future booking window, and duration-related rules).
Important: Client applications should always check can_book and, when false, surface html_deny_reason (rendering HTML safely) to explain booking issues to end users.

Date/Time & Timezone Behavior#

dt_date query param is interpreted in business/global time.
dt_date_global reflects that same global start date/time.
dt_date_local and text_timezone show the localized time for the business/location.
Client applications should:
Use dt_date_local and text_timezone for display.
Not assume the client’s local timezone is the same as the business/location timezone.
Recommendation: Always display both local class time and timezone to the user and avoid re-deriving local time; use the values returned by the API.

Error / Non-OK Responses#

Non-200 or status values other than "ok" indicate an error or misconfiguration.
Typical causes include:
Invalid or mismatched id_region, k_business, dt_date, or k_class_period.
Class instance not found or no longer available.
Authentication/authorization problems (e.g., missing or invalid token).

Request

Query Params

Responses

🟢200
application/json
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET '/v1/schedule/class/view?id_region={{id_region}}&k_business={{k_business}}&dt_date=2024-10-28 16:00:00&k_class_period=undefined' \
--header 'Content-Type: text/plain' \
--data-raw ''
Response Response Example
{}
Modified at 2026-02-26 17:13:05
Previous
/v1/schedule/class/list
Next
/v1/schedule/class/view
Built with