/v1/schedule/page/element

Retrieves schedule page/element details for a specific visit.

Summary
Fetch detailed schedule information for a single visit, including class/event details, staff, capacity, location, and timing.

Parameters

id_region (query, required): Numeric region identifier. Used by the platform to route the request to the correct regional backend.

k_business (query, required): Business key (numeric/string ID) identifying the WellnessLiving business account.

k_visit (query, required): Visit key/ID for which schedule page/element details are requested.

Example successful response (200 OK)
A successful response returns JSON with schedule and visit-specific details, for example:

a_class_info: Object with class/event state, including:

i_book_active: Current number of active bookings.

i_capacity: Maximum capacity for the class/event.

i_wait: Number of clients on the waitlist.

a_staff: Array of staff members assigned to this visit, including:

k_staff: Staff identifier.

s_family, s_name, s_name_full: Staff last name, first name, and full name.

dt_cancel: Date/time the visit was cancelled (if applicable), in YYYY-MM-DD HH:MM:SS format.

dt_date_global: Global (server) date/time of the visit.

dt_date_local / dtl_location: Local date/time of the visit at the location.

i_capacity: Overall capacity value for this instance (may reflect overrides).

i_duration: Duration of the visit in minutes.

i_wait_spot: Number of clients currently holding a waitlist spot.

id_note: Note type/identifier associated with the visit, if any.

id_visit: Visit type identifier (e.g., class, event).

is_checkin: Indicates whether the client is checked in.

is_enable_client_cancel: Whether client-side cancellation is allowed.

is_event: Indicates that this visit is an event.

is_in_progress: Whether the visit is currently in progress.

is_virtual: Indicates whether this visit is a virtual/online session.

k_class: Class identifier.

k_class_period: Class period identifier for this specific occurrence.

k_location: Location identifier.

s_title: Title of the class/event (e.g., "Avital event changed").

text_location: Human-readable location name (e.g., studio or room name).

text_room: Room name or label within the location, if set.

text_timezone: Time zone string for the visit (e.g., ART).

uid: Internal unique identifier for this schedule element.

url_image: URL to an image associated with the class/event.

url_virtual_join: URL used to join the virtual session (empty for in-person sessions).

status: Response status string (e.g., "ok").

s_version: Version identifier of the schedule element.

Additional fields may be returned by the API and should be treated as optional or subject to change.

Request