Skip to content
/
Get Event (v2)

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

Create Event (v2)

Request

Creates an Event using the v2 API.

Note: This is the v2 version of the Events API with enhanced features.

Security
BearerPartnerUser
Path
location_idintegerrequired

Location (business) ID

Example: 1
Headers
Acceptstringrequired

API version header

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

Bearer {partner_token}, User {user_token}

Bodyapplication/jsonrequired
staff_idintegerrequired

Team member ID who will conduct the event.

Example: 1
service_idintegerrequired

Service ID for this event.

Example: 500
resource_instance_idsArray of integersrequired

List of resource instance IDs (required, can be empty array).

Example: [123,432]
label_idsArray of integersrequired

List of category/tag IDs (required, can be empty array).

Example: [123,432]
datestring(date-time)required

Event date and time.

Example: "2026-11-22 14:00:00"
lengthintegerrequired

Event duration in seconds.

Example: 3600
capacityintegerrequired

Number of available slots for this event.

Example: 4
technical_break_durationinteger or null

Technical break duration in seconds.

  • If not provided: defaults to null
  • Value null: uses location's default setting (Settings → Timetable → Technical breaks) or keeps current value when updating
  • If value > 0: break duration must be included in the length parameter (length = services + break)
  • Accepts only multiples of 300 (5-minute intervals)
  • Maximum value: 3600 (1 hour)
Example: 300
One of:

Technical break duration in seconds.

  • If not provided: defaults to null
  • Value null: uses location's default setting (Settings → Timetable → Technical breaks) or keeps current value when updating
  • If value > 0: break duration must be included in the length parameter (length = services + break)
  • Accepts only multiples of 300 (5-minute intervals)
  • Maximum value: 3600 (1 hour)
integer
commentstring

Event comment or description.

Example: "Beginner group session"
colorstring

Event color (hex format).

Example: "#9c27b0"
instructionsstring

Instructions for the event.

Example: "Bring two balls"
stream_linkstring

Stream link for online events.

Example: "https://stream.com/some_link"
forceboolean

Skip resource availability check (true - skip check, false - validate).

Default false
Example: false
curl -i -X POST \
  https://developer.alteg.io/_mock/en/b2b-v2/openapi/companies/1/activities \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "staff_id": 1,
    "service_id": 500,
    "resource_instance_ids": [
      123,
      432
    ],
    "label_ids": [
      123,
      432
    ],
    "date": "2026-11-22 14:00:00",
    "length": 3600,
    "technical_break_duration": 300,
    "capacity": 4,
    "comment": "Beginner group session",
    "color": "#9c27b0",
    "instructions": "Bring two balls",
    "stream_link": "https://stream.com/some_link",
    "force": false
  }'

Responses

Event created successfully

Bodyapplication/json
dataobject

Created event details (JSON:API format)

metaArray of objects
Response
application/json
{
  "data": {
    "type": "activity",
    "id": "10126531",
    "attributes": { … }
  },
  "meta": [
    {}
  ]
}

Get Event (v2)

Request

Returns detailed information about a specific Event using v2 API.

Security
BearerPartnerUser
Path
location_idintegerrequired

Location (business) ID

event_idintegerrequired

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

Responses

Event details retrieved successfully

Bodyapplication/json
dataobject

Event details (JSON:API format)

metaArray of objects
Response
application/json
{
  "data": {
    "type": "activity",
    "id": "10126531",
    "attributes": { … }
  },
  "meta": [
    {}
  ]
}

Update Event (v2)

Request

Updates an existing Event using v2 API.

Security
BearerPartnerUser
Path
location_idintegerrequired

Location (business) ID

event_idintegerrequired

Event ID

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

Bearer {partner_token}, User {user_token}

Bodyapplication/jsonrequired
staff_idintegerrequired

Team member ID

service_idintegerrequired

Service ID

resource_instance_idsArray of integersrequired

List of resource instance IDs (required, can be empty)

label_idsArray of integersrequired

List of category/tag IDs (required, can be empty)

datestring(date-time)required

Event date and time

lengthintegerrequired

Event duration in seconds

capacityintegerrequired

Number of available slots

technical_break_durationinteger or null

Technical break duration (multiples of 300, max 3600)

One of:

Technical break duration (multiples of 300, max 3600)

integer
commentstring

Event comment

colorstring

Event color (hex format)

instructionsstring

Instructions for the event

stream_linkstring

Stream link for online events

forceboolean

Skip resource availability check

Default false
curl -i -X PUT \
  'https://developer.alteg.io/_mock/en/b2b-v2/openapi/companies/{location_id}/activities/{event_id}' \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "staff_id": 0,
    "service_id": 0,
    "resource_instance_ids": [
      0
    ],
    "label_ids": [
      0
    ],
    "date": "2019-08-24T14:15:22Z",
    "length": 0,
    "technical_break_duration": 0,
    "capacity": 0,
    "comment": "string",
    "color": "string",
    "instructions": "string",
    "stream_link": "string",
    "force": false
  }'

Responses

Event updated successfully

Bodyapplication/json
dataobject

Updated event details (JSON:API format)

metaArray of objects
Response
application/json
{
  "data": {
    "type": "activity",
    "id": "10126531",
    "attributes": { … }
  },
  "meta": [
    {}
  ]
}

Tags

Client tagging system.

Operations