Skip to content

Business Management (2.0.0)

Next-generation B2B API with improved design and consistency.

Base URL: https://api.alteg.io/api

🚀 Version Status

V2 is in active development. This API version is being actively developed and expanded. New features and improvements are released here first. We recommend using V2 for all new integrations.

Authentication

Requires both partner and user authorization:

Authorization: Bearer <partner_token>, User <user_token>

About v2

V2 endpoints offer improved request/response structures and consistent naming. This collection is actively growing as we modernize the API.

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

Team Members

Team member and position management.

Operations

List Positions (v2)

Request

Returns all staff positions for the specified company.

Response uses JSON:API format where type: "position" is the resource type.

Positions define organizational roles and can be assigned to staff members. Positions are stored at the salon group level but accessed via company.

Security
BearerPartnerUser
Path
company_idintegerrequired

Company (location) ID

Query
limitinteger

Maximum number of results to return

Default 100
offsetinteger

Number of results to skip for pagination

Default 0
Headers
Acceptstringrequired

API version header

Default application/vnd.api.v2+json
Authorizationstringrequired

Bearer {partner_token}, User {user_token}

curl -i -X GET \
  'https://developer.alteg.io/_mock/en/b2b-v2/openapi/companies/{company_id}/positions?limit=100&offset=0' \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>'

Responses

Positions retrieved successfully

Bodyapplication/json
dataArray of objects
metaobject
Response
application/json
{
  "data": [
    { … }
  ],
  "meta": {
    "pagination": { … }
  }
}

Create Position (v2)

Request

Creates a new staff position for the specified company. At least one salon ID must be provided.

Security
BearerPartnerUser
Path
company_idintegerrequired

Company (location) ID

Headers
Acceptstringrequired
Default application/vnd.api.v2+json
Content-Typestringrequired
Default application/json
Authorizationstringrequired

Bearer {partner_token}, User {user_token}

Bodyapplication/jsonrequired
titlestring[ 1 .. 100 ] charactersrequired

Position name

Example: "Senior Stylist"
salon_idsArray of integersnon-emptyrequired

IDs of salons where this position is available

Example: [1,2,3]
descriptionstring<= 1000 characters

Position description (optional)

Example: "Senior hair stylist with color specialization"
curl -i -X POST \
  'https://developer.alteg.io/_mock/en/b2b-v2/openapi/companies/{company_id}/positions' \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "Senior Stylist",
    "description": "Senior hair stylist with color specialization",
    "salon_ids": [
      1,
      2,
      3
    ]
  }'

Responses

Position created successfully

Headers
Locationstring

URL of the created resource

Bodyapplication/json
dataobject
metaobject
Response
application/json
{
  "data": {
    "type": "position",
    "id": "42",
    "attributes": { … }
  },
  "meta": {}
}

Get Position (v2)

Request

Retrieve details of a specific position by ID.

Response uses JSON:API format where type: "position" is the resource type.

Security
BearerPartnerUser
Path
company_idintegerrequired

Company (location) ID

position_idintegerrequired

Position ID

Headers
Acceptstringrequired

API version header

Default application/vnd.api.v2+json
Authorizationstringrequired

Bearer {partner_token}, User {user_token}

curl -i -X GET \
  'https://developer.alteg.io/_mock/en/b2b-v2/openapi/companies/{company_id}/positions/{position_id}' \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>'

Responses

Position retrieved successfully

Bodyapplication/json
dataobject
metaobject
Response
application/json
{
  "data": {
    "type": "position",
    "id": "42",
    "attributes": { … }
  },
  "meta": {}
}

Events

Group events (activities) management.

Operations

Tags

Client tagging system.

Operations