Get Booking Form Configuration
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 of thebooking form
Headers
e.g. application/vnd.api.v2+json
application/json
Bearer partner_token
Response
OK
Example response
{
"success": true,
"data": {
"steps": [
{
"step": "master",
"title": "Choose a team member",
"num": 2,
"hidden": false,
"default": -1
},
{
"step": "service",
"title": "Choose a service",
"num": 1,
"hidden": true,
"default": 196
},
{
"step": "datetime",
"title": "Select date and time",
"num": 3,
"hidden": false,
"date_hidden": false,
"time_hidden": false,
"date_default": "0000-00-00",
"time_default": 0
},
{
"step": "contact",
"title": "Business Example",
"num": 3,
"hidden": false,
"default": 0
},
{
"step": "comfirm",
"title": "Business Example",
"num": 4,
"hidden": false,
"default": 0
}
],
"style": {
"show_header": true,
"logo": "https://app.alteg.io/uploads/logo.png",
"header_background": "https://app.alteg.io/uploads/header.png",
"menu_background": "https://app.alteg.io/uploads/menu.png",
"main_color": "#FFCB00",
"secondary_color": "#999999",
"buttons_color": "#FFFFFF"
},
"group_id": 1,
"company_id": 1,
"phone_confirmation": false,
"lang": "en-US",
"langs": [
{
"id": 2,
"code": "en-US",
"title": "English"
},
{
"id": 4,
"code": "lv-LV",
"title": "Latviešu valoda"
},
{
"id": 5,
"code": "et-EE",
"title": "Eesti keel"
},
{
"id": 6,
"code": "lt-LT",
"title": "Lietuva"
},
{
"id": 7,
"code": "uk-UK",
"title": "Ukrainian"
},
{
"id": 8,
"code": "fr-FR",
"title": "Français"
},
{
"id": 9,
"code": "it-IT",
"title": "Italiano"
},
{
"id": 10,
"code": "es-ES",
"title": "Español"
},
{
"id": 13,
"code": "ka-KA",
"title": "ქართული"
},
{
"id": 14,
"code": "hy-AM",
"title": "Հայերեն"
},
{
"id": 15,
"code": "kk-KK",
"title": "Kazakh tili"
},
{
"id": 16,
"code": "hr-HR",
"title": "Hrvatski jezik"
},
{
"id": 17,
"code": "cs-CS",
"title": "český jazyk"
},
{
"id": 18,
"code": "ro-RO",
"title": "Limba Română"
},
{
"id": 19,
"code": "cn-CN",
"title": "中文"
},
{
"id": 20,
"code": "ar-AR",
"title": "العَرَبِيَّة"
},
{
"id": 21,
"code": "bg-BG",
"title": "Bulgarian"
},
{
"id": 22,
"code": "he-IL",
"title": "עברית"
},
{
"id": 23,
"code": "hu-HU",
"title": "Magyar nyelv"
},
{
"id": 24,
"code": "Lt-sr-SP",
"title": "Srpski jezik"
},
{
"id": 25,
"code": "sk-SK",
"title": "Slovenský jazyk"
},
{
"id": 26,
"code": "mn-MN",
"title": "Mongol hal"
},
{
"id": 27,
"code": "az-AZ",
"title": "Azərbaycan dili"
},
{
"id": 28,
"code": "pl-PL",
"title": "Polszczyzna"
},
{
"id": 30,
"code": "sl-SL",
"title": "Slòvēnskī"
}
],
"comment_required": false,
"metrika_counter_id": 50217133,
"google_analytics_id": "UA-125358345-1",
"facebook_pixel_id": "2218788388343154",
"app_metrika_id": "46ab3b93-1bc6-457d-82f0-c1b51f39b01e",
"sms_enabled": true
},
"meta": []
}