Skip to content
/
Get location

Get location

Request

Getting information about the location.

Security
BearerPartner
Path
location_idnumberrequired

The ID of the location to get information about.

Example:37532
Query
mynumber

For authorized user only. If you need additional data for the location that the user has rights to manage

Example:my=1
forBookingnumber

Date and time of the next free session in the location (ISO8601).

Example:forBooking=1
show_groupsnumber

Include in the location object a list of chains that this location belongs to

Example:show_groups=1
showBookformsnumber

Show location online booking forms (widgets)

Example:showBookforms=1
bookform_idnumber

Show url of online booking form with specified ID

Example:bookform_id=19203
Headers
Acceptstringrequired

Must be application/vnd.api.v2+json

Content-Typestringrequired

Must be application/json

Authorizationstringrequired

Bearer partner_token, User user_token

curl -i -X GET \
  'https://developer.alteg.io/_mock/en/b2b-v1/openapi/company/37532?my=1&forBooking=1&show_groups=1&showBookforms=1&bookform_id=19203' \
  -H 'Accept: string' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}_HERE>' \
  -H 'Content-Type: string'

Responses

OK

Bodyapplication/json
successboolean

Success status (true)

Example:true
dataobject

Object with data

Example:
{
  "id": 37532,
  "title": "James Smith LLC",
  "country_id": 7,
  "country": "United States",
  "city_id": 181,
  "city": "New York",
  "timezone_name": "America/New_York",
  "address": "New York, 787 Jackson Drive",
  "zip": "11435",
  "coordinate_lat": 40.73061,
  "coordinate_lon": -73.935242,
  "short_descr": "Beauty studio",
  "social": {
    "facebook": "",
    "instagram": "instagram.com/james_smith_company/",
    "telegram": "",
    "whatsapp": "",
    "viber": ""
  },
  "site": "james-smith-company.com",
  "business_type_id": 1,
  "description": "The <strong>James Smith</strong> location",
  "phone_confirmation": true,
  "active_staff_count": 2,
  "next_slot": "2026-03-23T10:10:00-05:00",
  "group_priority": 900,
  "push_notification_phone_confirm": 1,
  "main_group_id": 9206,
  "main_group": {
    "id": 9206,
    "title": "James Smith LLC main location chain"
  },
  "groups": {
    "9206": { … },
    "9207": { … }
  },
  "bookforms": [
    { … }
  ],
  "online_sales_form_url": "https://o1.alteg.io",
  "payment_policy": {
    "type": "deposit"
  },
  "access": {}
}
metaArray of objects

Metadata (empty array)

Example:
[]
Response
{
  "success": true,
  "data": {
    "id": 37532,
    "title": "James Smith LLC",
    "country_id": 7,
    "country": "United States",
    "city_id": 181,
    "city": "New York",
    "timezone_name": "America/New_York",
    "address": "New York, 787 Jackson Drive",
    "zip": "11435",
    "coordinate_lat": 40.73061,
    "coordinate_lon": -73.935242,
    "short_descr": "Beauty studio",
    "social": { … },
    "site": "james-smith-company.com",
    "business_type_id": 1,
    "description": "The <strong>James Smith</strong> location",
    "phone_confirmation": true,
    "active_staff_count": 2,
    "next_slot": "2026-03-23T10:10:00-05:00",
    "group_priority": 900,
    "push_notification_phone_confirm": 1,
    "main_group_id": 9206,
    "main_group": { … },
    "groups": { … },
    "bookforms": [ … ],
    "online_sales_form_url": "https://o1.alteg.io",
    "payment_policy": { … },
    "access": {}
  },
  "meta": []
}