/v1/schedule/class/list

Summary

Retrieve the class schedule for a specified region, business, and client/user over a given date range.

This endpoint returns calendar data and a detailed list of class sessions (including title, time, location, capacity, staff, and virtual flags) that match the supplied filters.

Parameters

All parameters are passed as query string parameters on the URL.

id_region (integer, required)

Region identifier used to scope the search (e.g., geographic or deployment region).

Example: 2

k_business (string/integer, required)

Unique business (location/account) key within the WellnessLiving system.

Determines which business’ schedule to query.

Example: 49197

uid (string, required)

User/client identifier for whom the schedule is being retrieved.

Used to personalize availability, booking links, or permissions for this user.

Example: 2720946

dt_date (string, required)

Start date (inclusive) of the schedule window.

Format: YYYY-MM-DD (local date in the business’ time zone).

Example: 2025-05-24

dt_end (string, required)

End date (inclusive) of the schedule window.

Format: YYYY-MM-DD.

Example: 2025-05-30

is_tab_all (boolean, optional)

When true, returns classes across all applicable tabs/filters.

When false or omitted, the schedule may be limited to the current tab/filter context.

Example: true

TOKEN variable (auth, if applicable)

This request references a TOKEN variable for authentication/authorization (for example, in headers or inherited auth from the collection/environment).

Ensure the TOKEN value is set appropriately in the active environment or collection variables before sending the request.

Response

On success, the endpoint typically returns a JSON body with the following high‑level structure:

a_calendar (object)

A date-indexed map of calendar days within the requested range.

Keys: dates in YYYY-MM-DD format.

Values: arrays of calendar entries for that date (often empty arrays when there are no sessions).

Example:

"a_calendar": {
  "2025-05-24": [],
  "2025-05-25": []
}

a_session (array)

Flat list of session objects representing each scheduled class instance within the date range.

Typical session fields include (non‑exhaustive):

dt_date – Session date and time in full datetime form (e.g., "2025-05-24 03:00:00").

dt_time – Time component for the session start (e.g., "08:30:00").

dtl_date – Localized datetime value for the session.

i_day – Numeric day-of-week indicator.

i_duration – Duration of the class in minutes.

is_cancel – Cancellation flag ("0" for active, "1" for canceled).

is_event – Indicates whether the session is an event vs. a regular class.

k_class – Unique class key.

k_class_period – Unique key for this specific class period/instance.

k_location – Location key where the class is held.

s_title – Class title/name (e.g., "Free Class").

text_timezone – Time zone label for the times returned (e.g., "BRT").

url_book – Booking URL for this specific session.

a_image – Image metadata for the class (height, width, URLs) or empty object/array when no image is set.

html_description – HTML-formatted class description.

i_book – Current number of bookings for the session.

i_capacity – Maximum capacity for the session (e.g., 10).

i_wait – Current waitlist size.

is_wait_list_enabled – Boolean flag indicating if waitlisting is enabled.

a_staff – Array of internal staff IDs assigned to the class.

a_staff_uid – Array of staff user IDs associated with the session.

a_virtual_location – Details of associated virtual/location settings (empty array if not virtual).

hide_application – Flag that controls visibility in certain client UIs.

is_virtual – Boolean flag indicating whether the session is virtual/online.

a_class_tab – Tab/category information for where this class appears in the schedule.

Other top-level fields

is_timezone_different – Indicates if the user’s time zone differs from the business’ time zone.

is_virtual_service – Indicates whether the related service/class type is virtual by default.

status – Request status string (e.g., "ok" on success).

s_version – Internal version or build identifier for the response payload.

Summary#

Parameters#

Response#

Request

Responses

Summary

Parameters

Response