User authentication and session management for B2B integrations
Business Management (1.0.0)
Full-featured B2B API for business operations.
Base URL: https://api.alteg.io/api
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.
Download OpenAPI description
Overview
Languages
Servers
Mock server
https://developer.alteg.io/_mock/en/b2b-v1/openapi/
Production
https://api.alteg.io/api/v1/
Request
The method allows you to get users of the location.
location User object:
| Attribute | Type | Description |
|---|---|---|
| id | number | User ID |
| name | string | User name |
| phone | string | User phone |
| string | User email | |
| information | string | User information |
| is_approved | boolean | Whether the user accepted the invitation to manage the location |
| is_non_deletable | boolean | Whether the user is non-deletable |
Security
BearerPartnerUser
- Mock serverhttps://developer.alteg.io/_mock/en/b2b-v1/openapi/company/{location_id}/users
- Productionhttps://api.alteg.io/api/v1/company/{location_id}/users
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://developer.alteg.io/_mock/en/b2b-v1/openapi/company/{location_id}/users?filter%5Bis_approved%5D=1' \
-H 'Accept: application/vnd.api.v2+json' \
-H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
-H 'Content-Type: string'OK
Response data.
Example: [{"id":10,"name":"Bob","phone":"+13155550184","email":"test@gmail.com","information":"manager","is_approved":false,"is_non_deletable":false},{"id":11,"name":"Oliver","phone":"+13155550185","email":"test@gmail.com","information":"Administrator","is_approved":true,"is_non_deletable":true}]
Response
application/json
{ "success": true, "data": [ { … }, { … } ], "meta": { "count": 2 } }
- Mock serverhttps://developer.alteg.io/_mock/en/b2b-v1/openapi/company/{location_id}/users/{user_id}
- Productionhttps://api.alteg.io/api/v1/company/{location_id}/users/{user_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
'https://developer.alteg.io/_mock/en/b2b-v1/openapi/company/123/users/{user_id}' \
-H 'Accept: application/vnd.api.v2+json' \
-H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
-H 'Content-Type: application/json'- Mock serverhttps://developer.alteg.io/_mock/en/b2b-v1/openapi/user/permissions/{location_id}
- Productionhttps://api.alteg.io/api/v1/user/permissions/{location_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://developer.alteg.io/_mock/en/b2b-v1/openapi/user/permissions/{location_id}' \
-H 'Accept: application/vnd.api.v2+json' \
-H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
-H 'Content-Type: string'OK
Object with access rights categories
Example: {"timetable":{"timetable_access":true,"master_id":1000238,"position_id":0,"last_days_count":1000,"schedule_edit_access":true,"timetable_phones_access":true,"timetable_transferring_record_access":true,"timetable_statistics_access":true,"timetable_waiting_list_access":false},"record_form":{"record_form_access":true,"record_form_client_access":true,"records_autocomplete_access":true,"create_records_access":true,"edit_records_access":true,"edit_records_attendance_access":true,"records_services_cost_access":true,"records_services_discount_access":true,"record_edit_full_paid_access":true,"delete_records_access":true,"delete_customer_came_records_access":true,"delete_paid_records_access":true,"records_goods_access":true,"records_goods_create_transaction_access":true,"records_goods_create_last_days_count":-1,"records_goods_edit_transaction_access":true,"records_goods_edit_last_days_count":-1,"records_goods_cost_access":true,"records_goods_discount_access":true,"records_finances_access":true,"records_finances_last_days_count":-1,"records_finances_pay_from_deposits_access":true,"records_group_id_access":true,"records_group_id":134178,"record_form_client_add_access":true,"records_autocomplete_phone_access":true,"assistants_management_access":true,"assistants_reward_share_edit_access":true,"records_edit_last_days_count":-1,"records_edit_date_and_master_access":true,"records_edit_duration_access":true,"records_edit_comment_access":true,"records_edit_services_access":true,"records_consumables_edit_access":true,"record_edit_full_paid_client_came_access":true,"record_edit_full_paid_client_confirm_access":true,"custom_fields_client_values_read_access":true,"custom_fields_client_values_edit_access":true,"custom_fields_record_values_read_access":true,"custom_fields_record_values_edit_access":true},"finances":{"finances_access":true,"finances_accounts_ids":[],"finances_transactions_access":true,"finances_last_days_count":-1,"finances_create_transactions_access":true,"finances_create_last_days_count":-1,"finances_edit_transactions_access":true,"finances_edit_last_days_count":-1,"finances_delete_transactions_access":true,"finances_transactions_excel_access":true,"finances_expenses_ids":[],"finances_accounts_access":true,"finances_accounts_limited_access":false,"finances_accounts_banalce_access":true,"finances_suppliers_read_access":true,"finances_suppliers_create_access":true,"finances_suppliers_update_access":true,"finances_suppliers_delete_access":true,"finances_suppliers_excel_access":true,"finances_expenses_read_access":true,"expenses_read_access":true,"finances_expenses_create_access":true,"expenses_create_access":true,"finances_expenses_update_access":true,"expenses_update_access":true,"finances_expenses_delete_access":true,"expenses_delete_access":true,"finances_kkm_transactions_access":true,"kkm_transactions_accounts_access":true,"finances_kkm_settings_read_access":true,"kkm_settings_reed_access":true,"finances_kkm_settings_update_access":true,"kkm_settings_update_access":true,"finances_settings_invoicing_read_access":true,"settings_invoicing_read_access":true,"finances_settings_invoicing_update_access":true,"settings_invoicing_update_access":true,"finances_options_read_access":true,"options_read_access":true,"finances_options_update_access":true,"options_update_access":true,"finances_salary_schemes_access":true,"finances_salary_calc_access":true,"finances_salary_not_limitation_today_access":true,"finances_payroll_calculation_create_access":true,"finances_payroll_calculation_create_not_limitation_today_access":true,"finances_salary_access_master_checkbox":true,"finances_salary_access_master_id":1000237,"get_salary_access_master_id":1000237,"finances_salary_master_not_limitation_today_access":true,"finances_payroll_calculation_create_by_master_access":true,"calculation_create_by_master_not_limitation_today_access":true,"finances_period_report_access":true,"finances_period_report_excel_access":true,"finances_year_report_access":true,"finances_year_report_excel_access":true,"finances_print_check_access":true,"finances_z_report_access":true,"finances_z_report_no_limit_today_access":true,"finances_z_report_excel_access":true},"clients":{"clients_access":true,"client_phones_access":true,"clients_phones_email_access":true,"clients_card_phone_access":true,"clients_delete_access":true,"clients_excel_access":true,"excel_access":true,"client_comments_list_access":true,"client_comments_add_access":true,"client_comments_own_edit_access":true,"client_comments_other_edit_access":true,"client_files_list_access":true,"client_files_upload_access":true,"client_files_delete_access":true,"clients_visit_master_id":0,"get_visit_master_id":0,"clients_phones_access":true,"clients_edit_access":true,"clients_deposits_access":true,"clients_deposits_create_access":true,"clients_deposits_history_access":true,"clients_deposits_topup_access":true,"clients_loyalty_read_access":true,"clients_loyalty_settings_access":true,"clients_card_comment_access":true,"clients_card_comment_edit_access":true,"clients_surname_middle_name_access":true,"clients_surname_middle_name_edit_access":true,"clients_show_attendance_history_access":true},"dashboard":{"dashboard_access":true,"dash_access":true,"dash_phones_access":true,"dash_records_access":true,"dash_records_last_days_count":-1,"dash_records_excel_access":true,"dash_records_phones_access":true,"dash_message_access":true,"dash_message_excel_access":true,"dash_message_phones_access":true,"dash_reviews_access":true,"dash_reviews_delete_access":true,"dashboard_calls_access":true,"dashboard_calls_excel_access":true,"dashboard_calls_phones_access":true},"notification":{"notification":true,"web_push":true,"web_phone_push":true,"notification_sms_ending_license":true,"notification_sms_low_balance":true,"notification_email_ending_license":true},"loyalty":{"loyalty_access":true,"has_loyalty_access":true,"loyalty_cards_manual_transactions_access":true,"has_loyalty_cards_manual_transactions_access":true,"loyalty_certificate_and_abonement_manual_transactions_access":true,"loyalty_abonement_balance_edit_access":true,"loyalty_abonement_history_access":true,"loyalty_abonement_period_edit_access":true,"loyalty_cards_issue_and_removal_access":true,"loyalty_certificate_balance_edit_access":true,"loyalty_certificate_period_edit_access":true},"storages":{"storages_access":true,"storages_ids":[],"storages_transactions_access":true,"storages_last_days_count":-1,"storages_move_goods_access":true,"storages_create_transactions_access":true,"storages_create_last_days_count":-1,"storages_create_transactions_buy_access":true,"storages_create_transactions_sale_access":true,"storages_edit_transactions_access":true,"storages_edit_last_days_count":-1,"storages_edit_transactions_buy_access":true,"storages_edit_transactions_sale_access":true,"storages_delete_transactions_access":true,"storages_transactions_excel_access":true,"storages_transactions_types":[],"storages_inventory_access":true,"storages_inventory_create_edit_access":true,"storages_inventory_delete_access":true,"storages_inventory_excel_access":true,"storages_remnants_report_access":true,"storages_remnants_report_excel_access":true,"storages_sales_report_access":true,"storages_sales_report_excel_access":true,"storages_consumable_report_access":true,"storages_consumable_report_excel_access":true,"storages_write_off_report_access":true,"storages_write_off_report_excel_access":true,"storages_turnover_report_access":true,"storages_turnover_report_excel_access":true,"storages_goods_crud_access":true,"storages_goods_create_access":true,"storages_goods_update_access":true,"storages_goods_title_edit_access":true,"storages_goods_category_edit_access":true,"storages_goods_selling_price_edit_access":true,"storages_goods_cost_price_edit_access":true,"storages_goods_units_edit_access":true,"storages_goods_critical_balance_edit_access":true,"storages_goods_masses_edit_access":true,"storages_goods_comment_edit_access":true,"storages_goods_archive_access":true,"storages_goods_delete_access":true,"storages_limited_access":false,"storages_goods_prime_cost_view_access":true},"settings":{"settings_access":true,"settings_basis_access":true,"settings_information_access":true,"users_access":true,"delete_users_access":true,"create_users_access":true,"edit_users_access":true,"limited_users_access":false,"settings_services_access":true,"settings_services_create_access":true,"services_edit":true,"settings_services_edit_title_access":true,"settings_services_relation_category_access":true,"settings_services_edit_price_access":true,"settings_services_edit_image_access":true,"settings_services_edit_online_seance_date_time_access":true,"settings_services_edit_online_pay_access":true,"settings_services_edit_services_related_resource_access":true,"settings_positions_read":true,"settings_positions_create":true,"settings_positions_delete":true,"edit_master_service_and_duration":true,"tech_card_edit":true,"services_delete":true,"settings_master_access":true,"master_create":true,"master_edit":true,"master_delete":true,"settings_master_dismiss_access":true,"schedule_edit":true,"settings_notifications_access":true,"settings_email_notifications_access":true,"settings_template_notifications_access":true,"webhook_read_access":true,"settings_clients_labels_access":true,"settings_close_docs_access":true,"settings_user_notifications_access":true,"is_salon_tips_manager":false},"comers":{"comers_access":false,"comers_info_vehicle_view_access":false,"comers_info_vehicle_edit_access":false},"other":{"stat_access":true,"billing_access":true,"send_sms":true,"salon_to_salon_group_add_access":true,"analytics_constructor_access":true,"billing_invoices_access":true,"auth_enable_check_ip":false,"auth_list_allowed_ip":[]},"online_record":{"online_record_access":true,"online_record_privacy_policy_access":true},"security_access":false,"security_2fa_access":false,"security_data_changes_access":false,"security_employee_changes_access":false,"security_export_import_access":false,"security_logins_access":false}
Response
application/json
{ "success": true, "data": { "timetable": { … }, "record_form": { … }, "finances": { … }, "clients": { … }, "dashboard": { … }, "notification": { … }, "loyalty": { … }, "storages": { … }, "settings": { … }, "other": { … } }, "meta": [] }