User authentication and session management for B2B integrations
- Check membership availability for event
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.
Request
Retrieves subscriptions that can be used to create a client schedule for a series of events.
This method returns subscriptions (memberships) that:
- Belong to the specified client
- Are valid and active
- Can be applied to the specified activity
- Have remaining visits available
Use cases:
- Display available subscriptions when scheduling recurring activity sessions
- Check which subscriptions cover specific activity types
- Validate subscription applicability before creating schedules
Note: Returns subscriptions with their types and availability intervals.
- Mock serverhttps://developer.alteg.io/_mock/en/b2b-v1/openapi/api/v1/company/{location_id}/client/{client_id}/loyalty/abonements/search_for_activity
- Productionhttps://api.alteg.io/api/v1/api/v1/company/{location_id}/client/{client_id}/loyalty/abonements/search_for_activity
- 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/api/v1/company/720441/client/146915197/loyalty/abonements/search_for_activity?event_id=12345' \
-H 'Accept: application/vnd.api.v2+json' \
-H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}_HERE>' \
-H 'Content-Type: application/json'{ "data": [ { … } ], "included": [ {} ] }
Request
Validates a specific subscription for creating activity schedules.
Returns:
- Last possible appointment date based on membership expiration
- Available visit count for the selected subscription
- Schedule day IDs that can be booked
Use cases:
- Validate subscription before creating recurring appointments
- Check if subscription has enough visits for schedule
- Determine last bookable date based on expiration
- Pre-validate schedule parameters
Note: Requires schedule_day_ids parameter to check specific dates.
- Mock serverhttps://developer.alteg.io/_mock/en/b2b-v1/openapi/api/v1/company/{location_id}/client/{client_id}/loyalty/abonements/{membership_id}/check_for_activity
- Productionhttps://api.alteg.io/api/v1/api/v1/company/{location_id}/client/{client_id}/loyalty/abonements/{membership_id}/check_for_activity
- 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/api/v1/company/720441/client/146915197/loyalty/abonements/5248829/check_for_activity?event_id=12345&schedule_day_ids=1%2C2%2C3%2C4%2C5' \
-H 'Accept: application/vnd.api.v2+json' \
-H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}_HERE>' \
-H 'Content-Type: application/json'{ "data": { "id": "check_1", "type": "loyalty_abonement_check", "attributes": { … } } }
Request
Returns a list of client gift cards by phone
| Attribute | Type | Description |
|---|---|---|
| id | int | Gift card ID |
| number | string | Gift card code |
| balance | decimal | Current balance |
| default_balance | decimal | Initial balance |
| type_id | int | Gift card type identifier |
| status_id | int | Status ID |
| created_date | timestamp | Date of sale |
| expiration_date | datetime | Burn date |
| type | object | Object with gift card type information |
| status | object | An object with information about the current gift card status |
The type array contains the following objects:
| Attribute | Type | Description |
|---|---|---|
| id | int | Gift card type identifier |
| title | string | Type name |
| balance | decimal | Gift card denomination |
| is_multi | boolean | Is it available for multiple debits |
| company_group_id | int | ID of the chain where the certificate type was created |
| item_type_id | int | Restriction on the use of redemption points. 0 - no limit, 1 - services only, 2 - some services + all products, 3 - some services, 4 - products only |
| expiration_type_id | int | The ID of the expiration limit. 0 - unlimited, 1 - fixed date, 2 - fixed term |
| expiration_date | timestamp | Burn date of all gift cards. Populated with expiration_type_id = 1 |
| expiration_timeout | int | Validity period of gift card. Populated with expiration_type_id = 2 |
| expiration_timeout_unit_id | int | Time units. 1 - Day, 2 - Week, 3 - Month, 4 - Year |
| is_allow_empty_code | boolean | Sale without code |
| item_type | object | Object with item_type_id and its name |
- Mock serverhttps://developer.alteg.io/_mock/en/b2b-v1/openapi/loyalty/certificates
- Productionhttps://api.alteg.io/api/v1/loyalty/certificates
- 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/loyalty/certificates?copmany_id=0&phone=0' \
-H 'Accept: string' \
-H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}_HERE>' \
-H 'Content-Type: string'OK
Array of objects with data
{ "success": true, "data": [ { … } ], "meta": { "count": 1 } }