Get User Appointments

Request

The JSON Object containing the user appointment parameters has the following fields:

Field	Type	Mandatory	Description
id	number	YES	Appointment ID
services	array of numbers	YES	List of ID service appointments
location	object	YES	location parameters
staff	object	YES	Parameters of the team member who was booked. Note: "staff" is a legacy field name for team member.
clients_count	int	YES	Number of clients
date	string	YES	Session date
datetime	string	YES	Session date in ISO
create_date	string	YES	Appointment creation date
length	number	YES	Session duration
deleted	boolean	YES	Has the appointment been created ? (true if deleted)
notify_by_sms	number	NO	Number of hours in advance to send an SMS reminder for the appointment. Set to 0 to disable SMS reminders
notify_by_email	number	NO	Number of hours in advance to send an email reminder for the appointment. Set to 0 to disable email reminders
comment	string	YES	Appointment Comment
master_requested	boolean	YES	Whether a specific team member was specified when appointment (false if "any team member" was specified)
online	boolean	YES	Indicates whether the appointment was created online by the client (true) or manually by an administrator (false)
visit_attendance	number	YES	2 - The user confirmed the appointment, 1 - The user came, the services were provided, 0 - the user was waiting, -1 - the user did not come to visit
api_id	string	NO	External Appointment ID
last_change_date	string	NO	Date of the last edit of the appointment
prepaid	boolean	NO	Is online payment available for appointment
prepaid_confirmed	boolean	NO	Online payment status
last_change_date	string	NO	Date of the last edit of the appointment
activity_id	int	NO	Event ID (for group events)

Each object in the services array has the following fields:

Field	Type	Description
id	number	Service ID
title	string	Service name
cost	float	Service cost
price_min	float	Minimum price of the service
price_max	float	Maximum service price
discount	float	Discount
amount	int	Number of ordered services
session_length	int	Service duration in seconds (only if filter by team member is set)

The location object has the following fields:

Field	Type	Description
id	number	location ID
title	string	location name
country_id	number	Identifier of the country in which the location is located
country	string	location name
city_id	number	Identifier of the city where the location is located)
city	string	location city name
time zone	string	timezone locations
address	string	Address where the location is located
phone	string	location's main phone number
phones	array of strings	All phone numbers of the location
coordinate_lat	float	Latitude where the location is located
coordinate lng	float	Longitude
allow_delete_record	boolean	Is it possible to delete an appointment
allow_change_record	boolean	Is it possible to reschedule the appointment
site	string	location website
currency_short_title	string	Currency symbol
allow_change_record_delay_step	int	Time after which you can reschedule the appointment
allow_delete_record_delay_step	int	Time after which you can delete an appointment

The team member object has the following fields:

Field	Type	Description
id	number	team member ID
name	string	team member name
specialization	string	team member specialization
position	object	team member position
show_rating	number	Whether to show team member's rating (1 - show, 0 - don't show)
rating	number	team member rating
votes_count	number	Number of votes rated team member
comments_count	number	Number of comments to a team member
avatar	string	Path to team member avatar file

Security

BearerPartner

Path

record_idnumberrequired

Appointment ID

Example:22123

record_hashstringrequired

HASH of the appointment

Example:'dawd4fs09rhf0s9fafef0'

Acceptstringrequired

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

Example:application/vnd.api.v2+json

Content-Typestringrequired

application/json

Authorizationstringrequired

Bearer partner_token, User user_token

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

Responses

Created

Bodyapplication/json

successboolean

Execution success status (true)

Example:true

dataArray of objects

Array of objects

Example:

[
  {
    "id": 13132699,
    "services": [ … ],
    "company": { … },
    "staff": { … },
    "clients_count": 1,
    "date": "2026-09-21T23:00:00.000-05:00",
    "datetime": "2026-10-24T17:30:00-0500",
    "create_date": "2026-10-20T21:40:24-0500",
    "comment": "",
    "deleted": true,
    "attendance": 0,
    "length": 1800,
    "notify_by_sms": 0,
    "notify_by_email": 0,
    "master_requested": false,
    "online": true,
    "api_id": "",
    "last_change_date": "2026-10-24T23:54:02-0500",
    "prepaid": false,
    "prepaid_confirmed": false,
    "activity_id": 0
  },
  {
    "id": 13133413,
    "services": [ … ],
    "company": { … },
    "staff": { … },
    "clients_count": 1,
    "date": "2026-09-21T23:00:00.000-05:00",
    "datetime": "2026-10-24T17:30:00-0500",
    "create_date": "2026-10-20T21:40:24-0500",
    "comment": "",
    "deleted": true,
    "attendance": 0,
    "length": 1800,
    "notify_by_sms": 0,
    "notify_by_email": 0,
    "master_requested": false,
    "online": true,
    "api_id": "",
    "last_change_date": "2026-10-24T23:54:02-0500",
    "prepaid": false,
    "prepaid_confirmed": false,
    "activity_id": 0
  }
]

metaArray of objects

Metadata (empty array)

Example:

[]

Response

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