Get Booking Form Configuration

Request

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

Security

BearerPartner

Path

idnumberrequired

ID of thebooking form

Example:1

Acceptstringrequired

e.g. application/vnd.api.v2+json

Example:application/vnd.api.v2+json

Content-Typestringrequired

application/json

Authorizationstringrequired

Bearer partner_token

curl -i -X GET \
  https://developer.alteg.io/_mock/en/public/openapi/bookform/1 \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}_HERE>' \
  -H 'Content-Type: string'

Responses

Bodyapplication/json

successboolean

Execution success status (true)

Example:true

dataobject

Object with data

Example:

{
  "steps": [
    { … },
    { … },
    { … },
    { … },
    { … }
  ],
  "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": [
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … }
  ],
  "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
}

metaArray of objects

Metadata (empty array)

Example:

[]

Response

{
  "success": true,
  "data": {
    "steps": [ … ],
    "style": { … },
    "group_id": 1,
    "company_id": 1,
    "phone_confirmation": false,
    "lang": "en-US",
    "langs": [ … ],
    "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": []
}