Skip to content

Get Services Available for Booking

Request

The object of services available for booking has the following fields:

FieldTypeDescription
categoriesarray of objectsArray of service categories (you can't book a category)
servicesarray of objectsServices available for booking by category

An object from the categories array, has the following fields:

FieldTypeDescription
idnumberCategory ID
titlestringCategory name
gendernumberCategory belonging to gender (1 - male, 2 - female, 0 - not specified)
weightnumberCategory weight. Categories are sorted by weight, heavier ones first
api_idstringExternal Category ID

An object from the services array, has the following fields:

FieldTypeDescription
idnumberService ID
titlestringService name
category_idnumberIdentifier of the category to which the service belongs
weightnumberCategory weight. Services are sorted by weight, heavier ones first
price_minnumberThe minimum cost of the service
price_maxnumberMaximum cost of the service
discountnumberService discount
commentstringComment on the service
activenumberIs the service active
prepaidstringOnline payment status
gendernumberGender for which the service is provided
session_lengthnumberService duration in seconds (only if filter by team member is set)
imagestringImage services

If you need to get the services provided by a specific team member, then you need to use the filter by team member. The following filters are available:

  • staff_id: team member ID. If you need services that only the selected team member provides
  • datetime: date (in iso8601 format). Specifies the desired appointment date. Use this parameter to retrieve services that can be booked with the selected team member on that specific date.
  • service_ids: An array of service IDs. If a team member is already selected and the time and service(s) are part of an existing appointment, this parameter should be used to select an additional service.
Security
BearerPartner
Path
location_idnumberrequired

location ID

Example:4564
Query
staff_idnumber

team member ID. Filter by team member ID Default: 0

Example:staff_id=0
datetimestring

date (in iso8601 format). Filter by service booking date (for example '2005-09-09T18:30') Default: ''

Example:datetime=2026-09-09T18:30
service_ids[]Array of numbers

Service ID. Filter by the list of identifiers of already selected (within one appointment) services. It makes sense if a filter by team member and date is set.

Headers
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/book_services/4564?staff_id=0&datetime=2026-09-09T18%3A30&service_ids%5B%5D=0' \
  -H 'Accept: application/vnd.api.v2+json' \
  -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:
{ "events": [], "services": [ {}, {} ], "category": [ {}, {} ] }
metaArray of objects

Metadata (empty array)

Example:
[]
Response
{ "success": true, "data": { "events": [], "services": [], "category": [] }, "meta": [] }