/v1/schedule/tab

GET /v1/schedule/tab

Retrieves the list of schedule tabs (e.g., Classes, Enrollments, Appointments, Assets) configured for a given business/region. Each tab entry describes one logical section of the online schedule and includes metadata used by the WellnessLiving web UI and integrations.

Authentication

This endpoint is expected to be called through the WellnessLiving proxy layer and authenticated using the TOKEN variable configured at the collection/folder level.

Auth type: typically Bearer token or custom header resolved from {{TOKEN}}.

Ensure the active environment has a valid TOKEN value for the target UAT business.

Note: This request itself does not define auth headers directly; it inherits auth from its parent folder/collection.

Query Parameters

Required query params (from current configuration):

id_region (number, required)
Region ID for the business. In this request it is set to 2.

k_business (string/ID, required)
Business key for which to load schedule tabs. In this request it is set to 49197.

The combination of id_region and k_business determines which business/region configuration is used when building the tab list.

Typical 200 OK Response

Example response shape (based on latest successful call):

{
  "a_tab": [
    {
      "id_class_tab_object": 1,
      "id_class_tab_system": 1,
      "k_class_tab": null,
      "k_resource_type": null,
      "k_service_category": null,
      "s_title": "Classes",
      "k_id": 7,
      "i_order": 0,
      "url_origin": "https://demo.wellnessliving.com/rs/sched..."
    },
    {
      "id_class_tab_object": 2,
      "id_class_tab_system": 2,
      "k_class_tab": null,
      "k_resource_type": null,
      "k_service_category": null,
      "s_title": "Enrollments",
      "k_id": 4,
      "i_order": 0,
      "url_origin": "https://demo.wellnessliving.com/rs/event..."
    }
    // ... additional tab objects, including Appointments, Assets, custom tabs, etc.
  ],
  "status": "ok",
  "s_version": "444085",
  "__a_message": [
    "enrollment|Wl.Classes.Tab.TabSid",
    "resource|Wl.Classes.Tab.TabSid",
    "service|Wl.Classes.Tab.TabSid",
    "training|Wl.Classes.Tab.TabSid"
  ]
}

Top-level fields

a_tab (array)
List of tab definitions available for the requested business/region.

status (string)
High-level status of the call. For success, this is typically "ok".

s_version (string)
Internal version identifier for the structure/configuration of the tabs.

__a_message (array)
Internal message keys / translation or configuration references. Each entry typically follows the pattern |Wl.Classes.Tab.TabSid (e.g., "enrollment|Wl.Classes.Tab.TabSid"). Consumers normally do not need to parse this.

`a_tab[]` object fields

Each item in a_tab describes one schedule tab:

id_class_tab_object (number)
Type of object represented by the tab (e.g., 1 = Classes, 2 = Enrollments, 3 = Appointments, 4 = Assets). Used internally to route to the correct schedule subsystem.

id_class_tab_system (number|null)
System-level tab type ID. Present for built-in/default tabs (Classes, Enrollments, Appointments, Assets). null for custom-configured tabs.

k_class_tab (string|null)
Tab key for custom tabs or specific tab configurations. null for system tabs that are not customized.

k_resource_type (string|null)
Optional resource type key if this tab is restricted to a particular resource type (e.g., for resource-based views). null if not applicable.

k_service_category (string|null)
Optional service category key if this tab is limited to a specific service category. null if not constrained.

s_title (string)
Display name of the tab as seen by end users (e.g., "Classes", "Enrollments", "Appointments", "Assets", or custom labels).

k_id (number)
Internal numeric identifier for the tab within this business/region configuration.

i_order (number)
Sort order for tabs. Lower values appear earlier in the schedule UI.

url_origin (string)
Base URL for the legacy web route associated with this tab (e.g., .../rs/sched..., .../rs/event..., .../rs/appoi...). Used mainly by WL frontends/links.

Notes for Consumers

This endpoint is read-only and returns configuration/metadata; it does not perform any booking or mutation.

Use a_tab to drive navigation/available sections in custom schedule UIs.

Do not hard-code assumptions about id_class_tab_object mappings without checking with platform constants; values may be extended in the future.

Treat __a_message and s_version as internal/platform fields. They can be logged for debugging but generally do not need to be surfaced to end users.

When testing, ensure you are using the correct k_business and id_region values for the target UAT configuration, as different businesses can have different tab sets and orders.

GET /v1/schedule/tab

Authentication

Query Parameters

Typical 200 OK Response

Top-level fields

`a_tab[]` object fields

Notes for Consumers

Request

Responses

/v1/schedule/tab

GET /v1/schedule/tab#

Authentication#

Query Parameters#

Typical 200 OK Response#

Top-level fields#

a_tab[] object fields#

Notes for Consumers#

Request

Responses

GET /v1/schedule/tab

Authentication

Query Parameters

Typical 200 OK Response

Top-level fields

`a_tab[]` object fields

Notes for Consumers