Skip to content
/
Updating permission value...

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

Getting permission values and user role

Request

Return user role and list of permissions values.

Security
BearerPartnerUser
Path
location_idnumberrequired

ID of a location.

Example: 123
user_idnumberrequired

ID of a user.

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
curl -i -X GET \
  https://developer.alteg.io/_mock/en/b2b-v1/openapi/company/123/users/123/permissions \
  -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(user_role_permissions)

Data on the permissions and user role

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": {
    "is_editable": true,
    "staff_id": 12345,
    "user_role": "owner",
    "has_any_paid_permission": null,
    "user_permissions": [ … ]
  },
  "meta": {}
}

Updating permission values and user role

Request

Updates the role and permissions of the user, as well as the team member who is attached to this user.

Security
BearerPartnerUser
Path
location_idnumberrequired

ID of a location.

Example: 123
user_idnumberrequired

ID of a user.

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
user_rolestring

Name of role

Enum"worker""administrator""accountant""manager""owner""free_readonly""free_readonly_admin"
user_permissionsArray of objects(Model object "Permission value")

List of user permissions values

Example: [{"slug":"timetable_access","value":true}]
staff_idnumber

team member ID attached to user

curl -i -X PUT \
  https://developer.alteg.io/_mock/en/b2b-v1/openapi/company/123/users/123/permissions \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "user_role": "worker",
    "user_permissions": [
      {
        "slug": "timetable_access",
        "value": true
      }
    ],
    "staff_id": 0
  }'

Responses

OK

Bodyapplication/json
successboolean(response_success_true_object)

Response status.

dataobject(user_role_permissions)

Data on the permissions and user role

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": {
    "is_editable": true,
    "staff_id": 12345,
    "user_role": "owner",
    "has_any_paid_permission": null,
    "user_permissions": [ … ]
  },
  "meta": {}
}

Create and Send an Invitation

Request

An invitation to manage a location is sent via email or phone as a link. By following the link and completing registration, the user gains access to manage the location according to the permissions assigned. Permission assignment is performed in a separate request after the invitation is sent.

Security
BearerPartnerUser
Path
location_idnumberrequired

ID of a location.

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
invitesArray of objectsrequired

Array of invites

invites[].​namestring

User name

Example: "Olivia"
invites[].​searchstring

Phone number or email address of the user

Example: "mail@gmail.com"
invites[].​positionstring or null

Position

Example: "Administrator"
invites[].​user_rolestring or null

Role name

Enum"worker""administrator""accountant""manager""owner"
Example: "administrator"
invites[].​user_permissionsArray of objects or null(Model object "Permission value")

List of user permissions

Example: [{"slug":"timetable_access","value":true}]
invites[].​staff_idnumber or null

team member ID bound to user

Example: 12
curl -i -X POST \
  https://developer.alteg.io/_mock/en/b2b-v1/openapi/user/invite/123 \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "invites": [
      {
        "name": "Olivia",
        "search": "mail@gmail.com",
        "position": "Administrator",
        "user_role": "administrator",
        "user_permissions": [
          {
            "slug": "timetable_access",
            "value": true
          }
        ],
        "staff_id": 12
      }
    ]
  }'

Responses

Accepted

Bodyapplication/json
successboolean

Send success status (true)

Example: true
datastring

Is null

metaobject

Metadata (contains a message that the data has been saved)

Example: {"message":"Saved"}
Response
application/json
{
  "success": true,
  "meta": {
    "message": "Saved"
  }
}

Appointments

Booking records and visit management

Operations

Events

Group events and class management

Operations

Schedule & Resources

Timetables, schedules, and resource allocation

Operations

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