Skip to content
/
Create a Schedule

Business Management (1.0.0)

Full-featured B2B API for business operations.

Base URL: https://api.alteg.io/api

⚠️ Version Status

V1 will be gradually deprecated. We recommend using V2 API for new integrations. V1 endpoints are maintained for backward compatibility, but new features will be released in V2 only.

Authentication

Requires both partner and user authorization:

Authorization: Bearer <partner_token>, User <user_token>
Download OpenAPI description
openapi.json
openapi.yaml
Overview
License
Altegio API Agreement
Terms of Service
Languages
Servers
Mock server
https://developer.alteg.io/_mock/en/b2b-v1/openapi/
Production
https://api.alteg.io/api/v1/

Authentication B2B

User authentication and session management for B2B integrations

Operations

Locations

Manage business locations (salons, clinics, etc.)

Operations

Services

Service catalog management including categories and team member assignments

Operations

Team Members

Staff management including positions and scheduling

Operations

Clients

Client database management with comments, files, and visit history

Operations

Users & Permissions

User account management and role-based access control

Operations

Appointments

Booking records and visit management

Operations

Events

Group events and class management

Operations

Schedule & Resources

Timetables, schedules, and resource allocation

Operations

Search a Schedule by Event

Request

Search for a schedule based on the appointment or event linked to it, or based on the associated appointment or event.

Security
BearerPartnerUser
Path
location_idnumberrequired

ID of a location.

Example: 123
entity_typestringrequired

Type of an entity schedule is searched by:
record - individual appointment, currently not supported;
activity - group event.

Enum"record""activity"
Example: activity
entity_idnumberrequired

ID of an entity schedule is searched by.

Example: 123
Query
includeArray of strings

Requested set of an included models.

Items Enum"days""days.events_master""days.events_labels""days.events_resource_instances"
Headers
Acceptstringrequired

Should be equal to application/vnd.api.v2+json

Example: application/vnd.api.v2+json
Content-Typestringrequired

Should be equal to application/json

Example: application/json
curl -i -X GET \
  'https://developer.alteg.io/_mock/en/b2b-v1/openapi/company/123/schedules/search/activity/123?include=days' \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
  -H 'Content-Type: application/json'

Responses

OK

Bodyapplication/json
successboolean(response_success_true_object)

Response status.

dataobject(timetable_event_schedule)

Data for an existing schedule in a location.

metaArray of objects or arrays or object(response_meta_empty_object)

Additional response data (empty object or empty array)

Response
application/json
{
  "success": true,
  "data": {
    "id": 123,
    "created_at": "2026-01-01T12:12:12-05:00",
    "updated_at": "2026-01-01T12:12:12-05:00",
    "deleted_at": null,
    "original_entity_type": "activity",
    "original_entity_id": 123,
    "date_start": "2026-01-01",
    "date_end": "2026-02-01",
    "days": [ … ]
  },
  "meta": {}
}

Create a Schedule

Request

Creates a schedule for appointments or events based on the original associated entity.

Security
BearerPartnerUser
Path
location_idnumberrequired

ID of a location.

Example: 123
Query
includeArray of strings

Requested set of an included models.

Items Value"days"
Headers
Acceptstringrequired

Should be equal to application/vnd.api.v2+json

Example: application/vnd.api.v2+json
Content-Typestringrequired

Should be equal to application/json

Example: application/json
Bodyapplication/json
original_entity_typestringrequired

Type of entity the schedule will be based on:
record - individual appointment, currently not supported;
activity - group event.

Enum"record""activity"
Example: "activity"
original_entity_idnumberrequired

ID of entity the schedule will be based on.

Example: 123
date_endstring(date)required

Date of the schedule end.

Example: "2022-02-01"
add_clients_from_original_entitybooleanrequired

Add clients from original entity to all scheduled events.

Example: false
daysArray of objects[ 1 .. 7 ] itemsrequired

Each object represents schedule series settings for a specific day of the week. A minimum of 1 and a maximum of 7 schedule series can be defined (one for each day of the week).

days[].​day_of_weekstringrequired

The day of the week for the schedule series.

Enum"mon""tue""wed""thu""fri""sat""sun"
Example: "mon"
days[].​events_master_idnumberrequired

The ID of the team member assigned to the events in the schedule series.

Example: 123
days[].​events_timestringrequired

Start time of the events in the schedule series, formatted as HH:MM:SS.

Example: "14:00:00"
days[].​events_durationnumberrequired

Duration of each event in the schedule series, in seconds.

Example: 3600
days[].​events_capacitynumberrequired

The capacity of activities in the schedule series. For appointments, this should be set to 1.

Example: 4
days[].​labels_idsArray of numbers

An array of tag IDs associated with the events in the schedule series.

Example: [123]
days[].​resource_instances_idsArray of numbers

An array of resource instance IDs used in the events of the schedule series.

Example: [123]
curl -i -X POST \
  'https://developer.alteg.io/_mock/en/b2b-v1/openapi/company/123/schedules?include=days' \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "original_entity_type": "activity",
    "original_entity_id": 123,
    "date_end": "2022-02-01",
    "add_clients_from_original_entity": false,
    "days": [
      {
        "day_of_week": "mon",
        "events_master_id": 123,
        "events_time": "14:00:00",
        "events_duration": 3600,
        "events_capacity": 4,
        "labels_ids": [
          123
        ],
        "resource_instances_ids": [
          123
        ]
      }
    ]
  }'

Responses

Created

Bodyapplication/json
successboolean(response_success_true_object)

Response status.

dataobject(timetable_event_schedule)

Data for an existing schedule in a location.

metaArray of objects or arrays or object(response_meta_empty_object)

Additional response data (empty object or empty array)

Response
application/json
{
  "success": true,
  "data": {
    "id": 123,
    "created_at": "2026-01-01T12:12:12-05:00",
    "updated_at": "2026-01-01T12:12:12-05:00",
    "deleted_at": null,
    "original_entity_type": "activity",
    "original_entity_id": 123,
    "date_start": "2026-01-01",
    "date_end": "2026-02-01",
    "days": [ … ]
  },
  "meta": {}
}

Update a Schedule

Request

Updates the settings of a schedule containing appointments or events.

Security
BearerPartnerUser
Path
location_idnumberrequired

ID of a location.

Example: 123
schedule_idintegerrequired

ID of a schedule.

Example: 123
Headers
Acceptstringrequired

Should be equal to application/vnd.api.v2+json

Example: application/vnd.api.v2+json
Content-Typestringrequired

Should be equal to application/json

Example: application/json
Bodyapplication/json
date_endstring(date)

Date of the schedule end.

Example: "2022-02-01"
curl -i -X PATCH \
  https://developer.alteg.io/_mock/en/b2b-v1/openapi/company/123/schedules/123 \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "date_end": "2022-02-01"
  }'

Responses

OK

Bodyapplication/json
successboolean(response_success_true_object)

Response status.

dataobject(timetable_event_schedule)

Data for an existing schedule in a location.

metaArray of objects or arrays or object(response_meta_empty_object)

Additional response data (empty object or empty array)

Response
application/json
{
  "success": true,
  "data": {
    "id": 123,
    "created_at": "2026-01-01T12:12:12-05:00",
    "updated_at": "2026-01-01T12:12:12-05:00",
    "deleted_at": null,
    "original_entity_type": "activity",
    "original_entity_id": 123,
    "date_start": "2026-01-01",
    "date_end": "2026-02-01",
    "days": [ … ]
  },
  "meta": {}
}

Products

Product catalog and categories

Operations

Inventory

Stock management, storage operations, and tech cards

Operations

Sales

Sales transactions and document management

Operations

Payments

Payment processing, accounts, and KKM transactions

Operations

Notifications

SMS and email notifications to clients

Operations

Online Booking Settings

Configure online booking behavior and forms

Operations

Analytics & Reports

Business analytics, charts, and Z-reports

Operations

Tags

Label management for categorizing entities (deprecated, use v2)

Operations

Deposits

Client deposit accounts and operations

Operations

Loyalty Cards

Loyalty card types, issuance, and manual transactions

Operations

Subscriptions & Certificates

Membership subscriptions and gift certificates

Operations

Loyalty Programs

Discount programs, referral programs, and loyalty transactions

Operations

Salary

Staff salary calculations, payroll, and schemes

Operations

Notification Settings

Configure notification types and user preferences

Custom Fields

Custom field definitions for various entities

Operations

Chain Management

Multi-location chain operations and clients

Operations

Chain Loyalty Programs

Chain-level loyalty programs and transactions

Operations

Fiscalization

Tax system integration and KKM callbacks

Operations

Utilities

License info, phone validation, images, and tips

Operations