/v1/event/book/view/element

Overview

Retrieves booking availability and configuration details for a specific event in a given business and region. Use this endpoint to determine upcoming bookable sessions (class periods), pricing, schedule, and related policy settings before submitting a booking request.

Authentication

Type: Inherits collection-level authentication (typically Bearer or API token)

Header: e.g. Authorization: Bearer {{TOKEN}}

Ensure the {{TOKEN}} variable is set in your active environment before sending the request.

Query Parameters

id_region (number, required)

Region identifier that scopes the business configuration.

Example: 2.

k_business (string/ID, required)

Unique identifier of the business for which the event is configured.

Example: 49197.

k_event (string/ID, required)

Unique identifier of the event whose booking details and availability are being requested.

Example: 446676.

Response Overview (200 OK)

The response body is a JSON object with multiple sections. Key fields include:

status (string)

Overall status of the call. Example: "ok".

a_book_available (array)

Upcoming bookable class/event occurrences.

Each item may include:

dt_date: Start date/time (server time), e.g. "2025-12-15 14:00:00".

s_start: Human-readable local start time, e.g. "Mon, Dec 15 11:00am".

k_class_period: Identifier of the specific class period.

k_location: Location ID for this occurrence.

s_location: Location name, e.g. "Barbie 1".

m_price: Price for a single session (string/decimal), e.g. "9.99".

i_active, i_active_limit: Counters/limits for active bookings.

i_wait, i_wait_limit: Waitlist counters/limits.

is_select, is_wait, is_wait_list_unpaid: Flags that indicate selection/waitlist state.

a_schedule (array)

Event schedule configuration across days.

Each item may include:

a_day: Days of week this schedule applies to (e.g. { "1": true } for Monday).

dt_start, dt_end: Overall schedule date range.

a_staff: Staff array with staff identifiers and display names.

k_class_period: Linked class period ID.

k_location, s_location: Location identifiers and name.

i_duration: Duration in minutes.

f_price: Standard price for the schedule.

s_time, text_time, text_day: Time and day in human-readable form.

a_business_policy (object)

Business-level booking and cancellation policies relevant to this event, such as:

i_book_before, i_book_future, i_book_open: Booking window settings.

i_cancel, i_cancel_period, i_grace_period: Cancellation and grace-period rules.

is_enable_client_cancel, is_multiple_booking, is_book_guest: Feature flags affecting client behavior.

Various can_\\* and is_\\* flags that govern login providers, promotions, contracts, waitlist behavior, and more.

a_class_logo, a_staff_logo (objects)

Metadata about class and staff images, including URLs and dimensions.

a_timezone_info (object)

Timezone metadata (e.g., ART, offset, and Olson timezone ID) used to render user-facing dates and times.

Additional event metadata

s_title: Event title, e.g. "Non Block Event".

html_description, html_special, xml_description: Event description content in different formats.

i_session, i_session_remain: Total vs remaining sessions in the event series.

is_bookable, is_full, is_past, is_single_session_buy: Flags indicating if/ how the event can be booked.

m_price, m_price_total, m_price_total_early: Pricing information for the event/series.

dt_start, dt_end, text_start, text_end: Overall event date range and human-readable equivalents.

url_book: Public booking URL for this event, if available.

Use a_book_available to drive the client-side date/time picker and a_business_policy plus a_schedule to enforce booking rules and display supporting details in your UI.

Overview

Authentication

Query Parameters

Response Overview (200 OK)

Request

Responses

/v1/event/book/view/element

Overview#

Authentication#

Query Parameters#

Response Overview (200 OK)#

Request

Responses

Overview

Authentication

Query Parameters

Response Overview (200 OK)