User authentication and session management for B2B integrations
- Get user gift cards
Get Client Memberships
Get User Memberships
Get a List of Memberships by Filter
Get a List of Membership Types by ID
Get a List of Available Membership Types
Search available subscriptions for event
Check membership availability for event
Get client gift cards
Get a List of Gift Card Types by ID
Get a List of Available Gift Card Types
Get user gift cards
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
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 |
Security
BearerPartner
- 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
Example: [{"id":409726,"number":888,"balance":9000,"default_balance":9000,"type_id":27841,"status_id":2,"created_date":"2026-09-21T23:00:00.000-05:00","expiration_date":"2026-09-21T23:00:00.000-05:00","type":{"id":27841,"title":"certificate 9000","balance":9000,"is_multi":true,"company_group_id":128284,"item_type_id":0,"expiration_type_id":2,"expiration_timeout":365,"expiration_timeout_unit_id":1,"is_allow_empty_code":false,"item_type":{"id":0,"title":"No limits"}},"status":{"id":2,"title":"activated"}}]
Response
application/json
{ "success": true, "data": [ { … } ], "meta": { "count": 1 } }
- Mock serverhttps://developer.alteg.io/_mock/en/b2b-v1/openapi/user/loyalty/certificates
- Productionhttps://api.alteg.io/api/v1/user/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/user/loyalty/certificates?company_id=0' \
-H 'Accept: string' \
-H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}_HERE>' \
-H 'Content-Type: string'OK
Array of objects with data
Example: [{"id":409726,"number":888,"balance":9000,"default_balance":9000,"type_id":27841,"status_id":2,"created_date":"2026-09-21T23:00:00.000-05:00","expiration_date":"2026-09-21T23:00:00.000-05:00","type":{"id":27841,"title":"certificate 9000","balance":9000,"is_multi":true,"company_group_id":128284,"item_type_id":0,"expiration_type_id":2,"expiration_timeout":365,"expiration_timeout_unit_id":1,"is_allow_empty_code":false,"item_type":{"id":0,"title":"No limits"}},"status":{"id":2,"title":"activated"}}]
Response
application/json
{ "success": true, "data": [ { … } ], "meta": { "count": 1 } }
Request
A list of gift card types available at the location can be obtained by querying the location ID and gift card type IDs.
The list is an array of gift card types.
Security
BearerPartnerUser
- Mock serverhttps://developer.alteg.io/_mock/en/b2b-v1/openapi/company/{location_id}/loyalty/certificate_types/fetch
- Productionhttps://api.alteg.io/api/v1/company/{location_id}/loyalty/certificate_types/fetch
- 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}/loyalty/certificate_types/fetch' \
-H 'Accept: application/vnd.api.v2+json' \
-H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
-H 'Content-Type: string'OK
Array of objects with data
Example: [{"id":1,"title":"Fixed burn date certificate without application restrictions","balance":10,"is_multi":true,"company_group_id":12,"item_type_id":0,"expiration_type_id":1,"expiration_date":"2026-09-21T23:00:00.000-05:00","expiration_timeout":0,"expiration_timeout_unit_id":0,"is_allow_empty_code":true},{"id":11,"title":"Certificate valid for 6 months from the date of sale for any goods without services","balance":100,"is_multi":false,"company_group_id":12,"item_type_id":2,"expiration_type_id":2,"expiration_timeout":6,"expiration_timeout_unit_id":3,"is_allow_empty_code":false}]
Response
application/json
{ "success": true, "data": [ { … } ], "meta": { "count": 1 } }