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

Events

Group events (activities) management.

Operations

Tags

Client tagging system.

Operations

List Tags (v2)

Request

Returns all tags for the specified company, optionally filtered by entity type.

Response uses JSON:API format where type: "tag" is the resource type name (not to be confused with entity_type attribute).

Entity types:

  • common (0) - General tags
  • client (1) - Client tags
  • record (2) - Appointment/record tags
  • activity (3) - Activity/event tags

Use the entity query parameter to filter by type. Accepts both string aliases and numeric values.

Security
BearerPartnerUser
Path
company_idintegerrequired

Company (location) ID

Query
entitystring

Filter by entity type (alias or numeric code)

Enum"common""client""record""activity""0""1""2""3"
Example: entity=client
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}/tags?entity=client' \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>'

Responses

Tags retrieved successfully

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

Create Tag (v2)

Request

Creates a new tag for the specified company.

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
titlestringrequired

Tag name

Example: "VIP Client"
colorstringrequired

Tag color in

Example: "#ff2828"
entityinteger

Entity type (0 - general, 1 - client, 2 - appointment, 3 - activity)

Default 0
Enum0123
iconstring

Icon name

Example: "star"
curl -i -X POST \
  'https://developer.alteg.io/_mock/en/b2b-v2/openapi/companies/{company_id}/tags' \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "VIP Client",
    "color": "#ff2828",
    "entity": 0,
    "icon": "star"
  }'

Responses

Tag created successfully

Bodyapplication/json
dataobject
metaArray of objects
Response
application/json
{
  "data": {
    "type": "tag",
    "id": "241627",
    "attributes": { … }
  },
  "meta": []
}

Get Tag (v2)

Request

Returns detailed information about a specific tag.

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

Security
BearerPartnerUser
Path
company_idintegerrequired

Company (location) ID

tag_idintegerrequired

Tag 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}/tags/{tag_id}' \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>'

Responses

Tag details retrieved successfully

Bodyapplication/json
dataobject
metaArray of objects
Response
application/json
{
  "data": {
    "type": "tag",
    "id": "241625",
    "attributes": { … }
  },
  "meta": []
}