---
title: "Get Booking Form Configuration"
method: GET
path: "/bookform/{id}"
tags: ["Online Booking"]
---

# Get Booking Form Configuration

`GET /bookform/{id}`

Each Altegio client can create an unlimited number of Online Booking forms with different designs and booking scenarios.

Typically, the ID of a booking form is embedded in the subdomain. For example: https://b123.alteg.io, where 123 is the booking form ID. This ID can be used to retrieve all necessary parameters for implementing Online Booking and to determine whether the booking applies to a specific location or a location chain.

For chain widgets, you will also need to call the [GET] /locations method with the company_id filter to retrieve the list of locations available for booking.


The object containing the Online Booking form settings includes the following fields:

| Field | Type | Description |
| ------------- | ------------- | ------------- |
| steps | Array of objects | Booking form steps with custom settings |
| style | object | Booking form design settings |
| group_id | number | Location chain ID (0 - if the booking form is for a non-chain location) |
| company_id | number | Location ID (always returned, used to get additional settings) |
| phone_confirmation | boolean | Do I need to confirm the phone by SMS (if groupid = 0 (not a group form), otherwise look in the settings of each location separately)
| language | string | Booking form language (code from langs array) |
| langs | array of object | List of widget languages
| comment_required | boolean | Whether the field with a comment within booking is required
| google_analytics_id | string | Google Analytics ID
| facebook_pixel_id | string | Facebook Pixel ID
| sms_enabled | boolean | Is sending SMS available?
| comment_input_name | string (optional) | Title for the field with a comment to the booking (if not set, the default value is used)
| booking_notify_text | string (optional) | The text of the notification that is displayed (if set) at the step of entering contact data
| is_show_privacy_policy | boolean | Whether it is necessary to display the text of the agreement on the personal data processing policy to the user
| specialization_display_mode | number | Display the specialization or position of the team member. 0 - Specialization, 1 - Position

The steps array consists of objects that have the following fields:

| Field | Type | Description | For what steps is specified |
| ------------- | ------------- | ------------- | ------------- |
| step | string | Step city/company/service/team member/datetime/contact/confirm |
| title | string | Name of the step to display in the interface | For everyone |
| number | number | What number should this step be displayed on (starting from 1) | For everyone |
| default | string or number | The default value for this step, if set | For all but datetime |
| hidden | boolean | Hide this step when booking or not | For everyone |
| date_hidden | boolean | Hide this step when booking or not | For datetime |
| time_hidden | boolean | Hide this step when booking or not | For datetime |
| date_default | string | The default value for this step, if set | For datetime |
| time_default | number | The default value for this step, if set | For datetime |

The style object has the following fields:

| Field | Type | Description |
| ------------- | ------------- | ------------- |
| show header | boolean | Show header and menu or not |
| logo | string | Path to logo image |
| header_background | string | Path to subtitle background image |
| menu_background | string | Path to menu background image |
| primaryPalette | string | The main color of the form (all colors from the list: red, pink, purple, deep-purple, indigo, blue, light-blue, cyan, teal, green, light-green, lime, yellow, amber, orange, deep-orange, brown , grey, blue-grey, white, black) |
| accentPalette | string | Form secondary color (subtitle semi-transparent cover) |
| warnPalette | string | Booking form buttons color |
| backgroundPalette | string | Booking form background color |

## Path parameters

- `id` number, required

## Headers

- `Accept` string, required
- `Content-Type` string, required
- `Authorization` string, required

## Response `200`

OK

- BookformIdInfoDataTypes — appointment form settings
  - `success` boolean — Execution success status (true)
  - `data` object — Object with data
    - `steps` object[] — appointment form steps with custom settings
      - `step` string — Selection step (Service / team member / date)
      - `title` string — The name of the step to display in the interface
      - `num` number — What number should this step be displayed on (starting from 1)
      - `hidden` boolean — Hide this step when appointment or not
      - `default` union — Default value for this step
        - number
        - string
      - `date_default` string — Default date value (for datetime step)
      - `time_default` number — Default time value (for datetime step)
      - `date_hidden` boolean — Hide date selection (for datetime step)
      - `time_hidden` boolean — Hide time selection (for datetime step)
      - `is_title_default` boolean — Is title default or custom
      - `category_view_type` string — Category view type (e.g., "horizontal_tags")
    - `style` object — appointment form design settings
      - `show_header` boolean — Display header and menu or not
      - `logo` string — Path to logo image
      - `header_background` string — Path to subtitle background image
      - `menu_background` string — Path to menu background image
      - `main_color` string — The main color of the form (all colors from the list: red, pink, purple, deep-purple, indigo, blue, light-blue, cyan, teal, green, light-green, lime, yellow, amber, orange, deep-orange, brown , grey, blue-grey, white, black)
      - `secondary_color` string — Form secondary color (subtitle semi-transparent cover)
      - `buttons_color` string — Button color
      - `logo_full` string — Full path to logo image
      - `header_background_full` string — Full path to header background image
      - `menu_background_full` string — Full path to menu background image
      - `primaryPalette` string — Primary palette color
      - `accentPalette` string — Accent palette color
      - `warnPalette` string — Warning palette color
      - `backgroundPalette` string — Background palette color
      - `main_color_theme` string — Main color theme identifier
      - `header_background_new` object — Header background image configuration with multiple sizes
        - `sm` string — Small image URL
        - `norm` string — Normal image URL
        - `origin` string — Original image URL
    - `group_id` number — location chain ID (0 - if the appointment form for a non-chain location
    - `company_id` number — location ID (always returned, used to get additional settings)
    - `phone_confirmation` boolean — Do I need to confirm the phone by SMS (if groupid = 0 (not a chain form), otherwise look in the settings of each location separately)
    - `lang` string — appointment form language (code from langs array)
    - `langs` object[] — List of widget languages
      - `id` integer
      - `code` string
      - `title` string
    - `comment_required` boolean — Whether the field with a comment on the appointment is required
    - `google_analytics_id` string — Google Analytics ID
    - `facebook_pixel_id` string — Facebook Pixel ID
    - `metrika_counter_id` number, nullable — Metrika counter ID (web analytics)
    - `app_metrika_id` string, nullable — AppMetrika ID (mobile analytics)
    - `sms_enabled` boolean — Is sending SMS available?
    - `id` number — Booking form ID
    - `url` string — Booking form URL
    - `staff_name` object — Team member name configuration
    - `without_menu` boolean — Step mode flag
    - `sequence_type` string — Sequence type (e.g., "steps")
    - `client_scripts` string — Client-side scripts
    - `y_injection` string — Web analytics injection code
    - `first_service_category_close` boolean — First service category close flag
    - `map` object — Map configuration
    - `salon_select_type_code` string — Location select type code
    - `is_show_privacy_policy` boolean — Show privacy policy flag
    - `is_client_agreements_feature_enabled` boolean — Client agreements feature enabled flag
    - `specialization_display_mode` number — Specialization display mode (0 - specialization, 1 - position)
    - `ab_test_enabled` boolean — A/B test enabled flag
    - `ab_test_percentage` number — A/B test percentage
    - `is_online_sale_available` boolean — Online sale available flag
    - `legal_info` object, nullable — Legal information
    - `online_sales_links` object[] — Online sales links
    - `google_analytics_client_id_index` string, nullable — Google Analytics client ID index
    - `brand` object — Brand configuration
    - `injection` object — Injection scripts configuration
    - `display_activity_type` string — Display event type
    - `is_multiple_activity_record` boolean — Multiple event appointment flag
    - `activity_record_count` number — Event appointment count
    - `weekly_view_enabled` boolean — Weekly view enabled flag
    - `show_weekly_view_without_online_booking` boolean — Show weekly view without online booking
    - `weekly_view_default_salon_id` number, nullable — Default location ID for weekly view
    - `chain_main_salon_id` number — Chain main location ID
    - `record_type_id` number, nullable — Appointment type ID
    - `features` object — Feature flags
    - `certificate_count` number — Certificate count
    - `abonement_count` number — Membership count
  - `meta` object[] — Metadata (empty array)

## Other responses

- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found

---

[API](https://skmtc.net/alteg/apis/online-booking.md) · [All operations](https://skmtc.net/alteg/apis/online-booking/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/alteg/online-booking/versions/623dc683246f/schema)