Skip to content
/
Get an Appointment

Get an Appointment

Request

Security
BearerPartnerUser
Path
location_idnumberrequired

location ID

record_idnumberrequired

Appointment ID

Query
include_consumablesnumber
Example:include_consumables=0
include_finance_transactionsnumber
Example:include_finance_transactions=0
include_loyalty_transactionsnumber

Flag to add loyalty_transactions: active loyalty payments of the Appointment's Visit (loyalty card, Membership or gift card write-offs). An empty array when the Appointment has no Visit.

Example:include_loyalty_transactions=0
Headers
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/b2b-v1/openapi/locations/{location_id}/appointments/{record_id}?include_consumables=0&include_finance_transactions=0&include_loyalty_transactions=0&short_link_token=0' \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
  -H 'Content-Type: string'

Responses

OK

Bodyapplication/json
successboolean

Execution success status (true)

Example:true
dataobject

Object with data

Example:
{
  "id": 2,
  "company_id": 4564,
  "staff_id": 9,
  "services": [
    { … }
  ],
  "goods_transactions": [],
  "staff": {
    "id": 9,
    "name": "Alex Taylor",
    "specialization": "hair extension",
    "position": { … },
    "avatar": "http://app.alteg.io/images/no-master-sm.png",
    "avatar_big": "http://app.alteg.io/images/no-master.png",
    "rating": 0,
    "votes_count": 0
  },
  "client": {
    "id": 18936825,
    "name": "lx",
    "phone": "+13155550175",
    "card": "",
    "email": "client@example.com",
    "success_visits_count": 37,
    "fail_visits_count": 3
  },
  "clients_count": 1,
  "date": "2026-09-21T23:00:00.000-05:00",
  "datetime": "2026-09-21T23:00:00.000-05:00",
  "create_date": "2026-01-17T19:41:44-0500",
  "comment": "do not write down",
  "visit_attendance": 0,
  "attendance": 0,
  "confirmed": 1,
  "seance_length": 3600,
  "length": 3600,
  "sms_before": 0,
  "sms_now": 0,
  "sms_now_text": "",
  "email_now": 0,
  "notified": 0,
  "master_request": 0,
  "api_id": "",
  "from_url": "",
  "review_requested": 0,
  "visit_id": 8263004,
  "created_user_id": 1073232,
  "deleted": false,
  "paid_full": 0,
  "prepaid": false,
  "prepaid_confirmed": false,
  "last_change_date": "2026-01-17T19:44:14-0500",
  "custom_color": "f44336",
  "custom_font_color": "#ffffff",
  "record_labels": [
    { … },
    { … }
  ],
  "activity_id": 0,
  "custom_fields": {},
  "documents": [
    { … }
  ],
  "sms_remain_hours": 5,
  "email_remain_hours": 1,
  "bookform_id": 0,
  "record_from": "",
  "is_mobile": 0,
  "is_sale_bill_printed": false,
  "consumables": [
    { … }
  ],
  "finance_transactions": [
    { … }
  ]
}
metaArray of objects

Metadata (empty array)

Example:
[]
Response
{
  "success": true,
  "data": {
    "id": 2,
    "company_id": 4564,
    "staff_id": 9,
    "services": [ … ],
    "goods_transactions": [],
    "staff": { … },
    "client": { … },
    "clients_count": 1,
    "date": "2026-09-21T23:00:00.000-05:00",
    "datetime": "2026-09-21T23:00:00.000-05:00",
    "create_date": "2026-01-17T19:41:44-0500",
    "comment": "do not write down",
    "visit_attendance": 0,
    "attendance": 0,
    "confirmed": 1,
    "seance_length": 3600,
    "length": 3600,
    "sms_before": 0,
    "sms_now": 0,
    "sms_now_text": "",
    "email_now": 0,
    "notified": 0,
    "master_request": 0,
    "api_id": "",
    "from_url": "",
    "review_requested": 0,
    "visit_id": 8263004,
    "created_user_id": 1073232,
    "deleted": false,
    "paid_full": 0,
    "prepaid": false,
    "prepaid_confirmed": false,
    "last_change_date": "2026-01-17T19:44:14-0500",
    "custom_color": "f44336",
    "custom_font_color": "#ffffff",
    "record_labels": [ … ],
    "activity_id": 0,
    "custom_fields": [],
    "documents": [ … ],
    "sms_remain_hours": 5,
    "email_remain_hours": 1,
    "bookform_id": 0,
    "record_from": "",
    "is_mobile": 0,
    "is_sale_bill_printed": false,
    "consumables": [ … ],
    "finance_transactions": [ … ]
  },
  "meta": []
}