Get a list of locations

Request

Get a list of locations with data

Security

BearerPartner

Query

idnumber

Filter by location ID

Example:id=4564

group_idnumber

Filter by location chain ID Default: 83

Example:group_id=83

mynumber

For authorized user only. If you need locations that the user has rights to manage

Example:my=1

activenumber

If you need to get only locations with an active license and an available appointment

Example:active=1

forBookingnumber

Include 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

city_idnumber

Filter by city ID (cities getting method)

Example:city_id=2

showBookformsnumber

Include in the location object a list of location online booking forms

Example:showBookforms=1

min_idnumber

Filter by minimum location ID

Example:min_id=1000

show_deletednumber

Include deleted locations

Example:show_deleted=1

hide_record_type_singlenumber

Hide locations with individual appointment

Example:hide_record_type_single=1

hide_record_type_activitynumber

Hide locations with group appointment

Example:hide_record_type_activity=1

hide_record_type_mixednumber

Hide locations with mixed appointment

Example:hide_record_type_mixed=1

business_group_idnumber

Filter by business group ID

Example:business_group_id=1

business_type_idnumber

Filter by business type ID

Example:business_type_id=1

includeArray of strings

Include additional data in the location object

Items Enum:"staff""positions""accounts""storages""expenses"

Example:include=staff&include=positions

countnumber

Number of locations per page

pagenumber

Page number

Acceptstringrequired

Must be application/vnd.api.v2+json

Content-Typestringrequired

Must be application/json

Authorizationstringrequired

Bearer partner_token

curl -i -X GET \
  'https://developer.alteg.io/_mock/en/b2b-v1/openapi/companies?id=4564&group_id=83&my=1&active=1&forBooking=1&show_groups=1&city_id=2&showBookforms=1&min_id=1000&show_deleted=1&hide_record_type_single=1&hide_record_type_activity=1&hide_record_type_mixed=1&business_group_id=1&business_type_id=1&include=staff%2Cpositions&count=0&page=0' \
  -H 'Accept: string' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}_HERE>' \
  -H 'Content-Type: string'

Responses

Bodyapplication/json

successboolean

Success status (true)

Example:true

dataArray of objects

Array of objects

Example:

[
  {
    "id": 1050,
    "title": "La Visage",
    "public_title": "La Visage Beauty",
    "short_descr": "Beauty saloon",
    "logo": "https://app.alteg.io/images/no-master.png",
    "active": 1,
    "phone": "+13155550175",
    "phones": [ … ],
    "email": "info@lavisage.com",
    "country_id": 7,
    "schedule": "",
    "country": "United States",
    "city_id": 181,
    "city": "New York",
    "timezone": -5,
    "timezone_name": "America/New_York",
    "address": "New York, 787 Jackson Drive",
    "coordinate_lat": 40.73061,
    "coordinate_lon": -73.935242,
    "phone_confirmation": true,
    "active_staff_count": 2,
    "next_slot": "2026-03-23T10:10:00-05:00",
    "app_ios": "",
    "app_android": "",
    "currency_short_title": "$",
    "reminds_sms_disabled": false,
    "reminds_sms_default": 1,
    "group_priority": 900,
    "bookform_group_priority": 0,
    "description": "<p>Welcome to La Visage</p>",
    "photos": [],
    "booking_widget_promo": null
  }
]

metaArray of objects

Metadata (empty array)

Example:

[]

Response

{
  "success": true,
  "data": [
    { … }
  ],
  "meta": []
}