Skip to content

Developer Tools (1.0.0)

APIs for partners building integrations with the Altegio platform. Base URL: https://api.alteg.io/api

Available Methods

Marketplace — Manage your marketplace applications: list connected locations, configure tariffs, handle billing, process installation/uninstallation callbacks. Webhooks — Configure event notifications for your integrations. Receive real-time updates when appointments, clients, or other entities change. VoIP Integration — Connect telephony systems to match incoming calls with client records and log call history. Dictionaries — Reference data for building forms and validations: countries, cities, business types.

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/developers/openapi/
Production
https://api.alteg.io/api/v1/

Marketplace

Marketplace application management, billing, and installation.

Operations

Webhooks

Event subscription and webhook configuration.

Operations

VoIP Integration

Telephony integration endpoints.

Operations

Dictionaries

Reference data (countries, cities, business types).

Operations

Get a list of countries

Request

Security
BearerPartner
Headers
Acceptstringrequired

e.g. application/vnd.api.v2+json

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

application/json

Authorizationstringrequired

Bearer partner_token

curl -i -X GET \
  https://developer.alteg.io/_mock/en/developers/openapi/countries \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}_HERE>' \
  -H 'Content-Type: string'

Responses

OK

Bodyapplication/json
successboolean

Execution success status (true)

Example: true
dataArray of objects

Array of objects with data

Example: [{"id":7,"title":"USA","full_title":"United States","iso_code":"US","phone_code":"1","phone_template":"+1 xxx-xxx-xxxx","phone_example":"+1 201-123-4567","currency":"$","exchange":32.99,"lang_id":2,"group_type":1,"is_eu":false},{"id":56,"title":"France","full_title":"France","iso_code":"FR","phone_code":"33","phone_template":"+33 x xx xx xx xx","phone_example":"+33 1 23 45 67 89","currency":"€","exchange":11.18,"lang_id":8,"group_type":1,"is_eu":true}]
metaArray of objects

Metadata (empty array)

Example: []
Response
application/json
{
  "success": true,
  "data": [
    { … },
    { … }
  ],
  "meta": []
}

Get a list of cities

Request

Security
BearerPartner
Query
country_idnumber

Country ID to get cities from

company_idnumber

Location ID. If passed, the city of the location will also be returned, regardless of whether it belongs to the specified country or not

Headers
Acceptstringrequired

e.g. application/vnd.api.v2+json

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

application/json

Authorizationstringrequired

Bearer partner_token

curl -i -X GET \
  'https://developer.alteg.io/_mock/en/developers/openapi/cities?country_id=0&company_id=0' \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}_HERE>' \
  -H 'Content-Type: string'

Responses

OK

Bodyapplication/json
successboolean

Execution success status (true)

Example: true
dataArray of objects

Array of objects with data

Example: [{"id":2,"country_id":7,"title":"New York"},{"id":1040,"country_id":30,"title":"Belfast"},{"id":1201,"country_id":38,"title":"București"},{"id":1334,"country_id":31,"title":"Budapest"}]
metaArray of objects

Metadata (empty array)

Example: []
Response
application/json
{
  "success": true,
  "data": [
    { … },
    { … },
    { … },
    { … }
  ],
  "meta": []
}

Get business types by group

Request

Security
BearerPartner
Headers
Acceptstringrequired

e.g. application/vnd.api.v2+json

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

application/json

Authorizationstringrequired

Bearer partner_token, User user_token

curl -i -X GET \
  https://developer.alteg.io/_mock/en/developers/openapi/references/business_groups_with_types \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}_HERE>' \
  -H 'Content-Type: string'

Responses

OK

Bodyapplication/json
successboolean

Execution success status (true)

Example: true
dataArray of objects

Array of objects with data

Example: [{"id":10,"title":"Domestic services","image":"https://app.alteg.io/images/business-groups/services.png","types":[{"id":31,"title":"Studio","business_group_id":10}]},{"id":1,"title":"beauty","image":"https://app.alteg.io/images/business-groups/beauty.png","types":[{"id":1,"title":"Beauty Salons","business_group_id":1},{"id":25,"title":"Spa","business_group_id":1}]}]
metaobject

Metadata (contains the number of business types found)

Example: {"count":10}
Response
application/json
{
  "success": true,
  "data": [
    { … },
    { … }
  ],
  "meta": {
    "count": 10
  }
}