v1

latestOpenAPI 3.1.1Altegio API Agreement2026-08-062438211.0 KB
Online Booking

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:

FieldTypeDescription
stepsArray of objectsBooking form steps with custom settings
styleobjectBooking form design settings
group_idnumberLocation chain ID (0 - if the booking form is for a non-chain location)
company_idnumberLocation ID (always returned, used to get additional settings)
phone_confirmationbooleanDo I need to confirm the phone by SMS (if groupid = 0 (not a group form), otherwise look in the settings of each location separately)
languagestringBooking form language (code from langs array)
langsarray of objectList of widget languages
comment_requiredbooleanWhether the field with a comment within booking is required
google_analytics_idstringGoogle Analytics ID
facebook_pixel_idstringFacebook Pixel ID
sms_enabledbooleanIs sending SMS available?
comment_input_namestring (optional)Title for the field with a comment to the booking (if not set, the default value is used)
booking_notify_textstring (optional)The text of the notification that is displayed (if set) at the step of entering contact data
is_show_privacy_policybooleanWhether it is necessary to display the text of the agreement on the personal data processing policy to the user
specialization_display_modenumberDisplay the specialization or position of the team member. 0 - Specialization, 1 - Position

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

FieldTypeDescriptionFor what steps is specified
stepstringStep city/company/service/team member/datetime/contact/confirm
titlestringName of the step to display in the interfaceFor everyone
numbernumberWhat number should this step be displayed on (starting from 1)For everyone
defaultstring or numberThe default value for this step, if setFor all but datetime
hiddenbooleanHide this step when booking or notFor everyone
date_hiddenbooleanHide this step when booking or notFor datetime
time_hiddenbooleanHide this step when booking or notFor datetime
date_defaultstringThe default value for this step, if setFor datetime
time_defaultnumberThe default value for this step, if setFor datetime

The style object has the following fields:

FieldTypeDescription
show headerbooleanShow header and menu or not
logostringPath to logo image
header_backgroundstringPath to subtitle background image
menu_backgroundstringPath to menu background image
primaryPalettestringThe 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)
accentPalettestringForm secondary color (subtitle semi-transparent cover)
warnPalettestringBooking form buttons color
backgroundPalettestringBooking form background color
get/bookform/{id}

Path parameters

idnumber required

ID of thebooking form

Headers

Acceptstring required

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

Content-Typestring required

application/json

Authorizationstring required

Bearer partner_token

Response

OK

successboolean

Execution success status (true)

metaobject[]

Metadata (empty array)

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": []
}