Appointments

Booking records and visit management

Operations

Get list of appointments

Request

Filtering Appointments

staff_id: team member ID.

Use this to retrieve appointments for a specific team member

client_id: Client ID

Use this to retrieve appointments for a specific client

created_user_id: User ID

User who created the appointment

Use this to filter appointments created by a specific user

start_date: Session start date (inclusive)

Returns appointments with a session starting on or after this date

end_date: Session end date (inclusive)

Returns appointments with a session ending on or before this date

c_start_date: Appointment creation date from

Returns appointments created on or after this date

c_end_date: Appointment creation date until

Returns appointments created on or before this date

changed_after: Modified or created after this datetime

Returns appointments created or modified after the specified date and time

changed_before: Modified or created before this datetime

Returns appointments created or modified before the specified date and time

Security

BearerPartnerUser

Path

location_idnumberrequired

location ID

Query

pagenumber

Page number

Example:page=1

countnumber

Number of appointments per page

Example:count=50

team_member_idnumber

team member ID, if you only need appointments for a specific team member

Example:team_member_id=7572

client_idnumber

Client ID. If you need appointments for a specific client

Example:client_id=572

created_user_idnumber

The ID of the user who created the appointment. If you need appointments created by a specific user

Example:created_user_id=7572

start_datestring

Session date starting at (filter by session date). If you need appointments for a session starting from a specific date

Example:start_date=2026-01-21

end_datestring

Session date to. If you need appointments for a session before a specific date

Example:end_date=2026-01-21

c_start_datestring

Appointment creation date starting from(filter by appointment creation date). If you need appointments created since a specific date

Example:c_start_date=2026-01-21

c_end_datestring

Appointment creation date by (filter by appointment creation date).

Example:c_end_date=2026-01-21

changed_afterstring

The date the appointment was modified/created. If you need appointments created/modified starting from a specific date and time

Example:changed_after=2026-01-21T23:00:00

changed_beforestring

The date the appointment was modified/created. If you need appointments created/modified before a specific date and time

Example:changed_before=2026-01-21T23:00:00

include_consumablesnumber

Flag for including a list of consumables by appointments in the response

Example:include_consumables=0

include_finance_transactionsnumber

Flag to include in the response financial transactions by appointments

Example:include_finance_transactions=0

with_deletedboolean

Include deleted appointments in output (with_deleted=1 will return deleted appointments as well)

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?page=1&count=50&team_member_id=7572&client_id=572&created_user_id=7572&start_date=2026-01-21&end_date=2026-01-21&c_start_date=2026-01-21&c_end_date=2026-01-21&changed_after=2026-01-21T23%3A00%3A00&changed_before=2026-01-21T23%3A00%3A00&include_consumables=0&include_finance_transactions=0&with_deleted=true' \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
  -H 'Content-Type: string'

Responses

Bodyapplication/json

successboolean

Execution success status (true)

Example:true

dataArray of objects

Array of objects with data

Example:

[
  {
    "id": 2,
    "company_id": 4564,
    "staff_id": 9,
    "services": [ … ],
    "goods_transactions": [],
    "staff": { … },
    "date": "2026-09-21T23:00:00.000-05:00",
    "datetime": "2026-09-21T23:00:00.000-05:00",
    "create_date": "2026-01-16T20:35:11-0500",
    "comment": "do not write down",
    "online": false,
    "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": 8262996,
    "created_user_id": 1073232,
    "deleted": false,
    "paid_full": 0,
    "prepaid": false,
    "prepaid_confirmed": false,
    "last_change_date": "2026-01-16T20:35:15-0500",
    "custom_color": "",
    "custom_font_color": "",
    "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": []
  },
  {
    "id": 9,
    "company_id": 4564,
    "staff_id": 49,
    "services": [],
    "goods_transactions": [],
    "staff": { … },
    "date": "2026-09-21T23:00:00.000-05:00",
    "datetime": "2026-09-21T23:00:00.000-05:00",
    "create_date": "2026-01-16T20:35:11-0500",
    "comment": "",
    "online": true,
    "visit_attendance": 1,
    "attendance": 1,
    "confirmed": 1,
    "seance_length": 10800,
    "length": 10800,
    "sms_before": 0,
    "sms_now": 0,
    "sms_now_text": "",
    "email_now": 0,
    "notified": 0,
    "master_request": 1,
    "api_id": "",
    "from_url": "",
    "review_requested": 0,
    "visit_id": 8262996,
    "created_user_id": 1073232,
    "deleted": false,
    "paid_full": 0,
    "prepaid": false,
    "prepaid_confirmed": false,
    "last_change_date": "2026-01-09T20:45:30-0500",
    "custom_color": "f44336",
    "custom_font_color": "#ffffff",
    "record_labels": [ … ],
    "activity_id": 0,
    "custom_fields": {},
    "documents": [ … ],
    "consumables": [],
    "finance_transactions": []
  }
]

metaobject

Metadata (contains the page number and the number of appointments per page)