Magicline Open API
/
API reference
/
Studios

Magicline API

  • Appointment, bookable appointment and slots operations
  • Class and slots operations
  • Cross studio operations
  • Get customers and contracts
  • Retrieve customer accounting details
  • Retrieve customer communication details
  • Get device information
  • Employee operations
  • Debt collection operations
  • Manage membership contracts
  • Membership operations
  • Get studio information
  • Get trial offers information
Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Demo tenant
https://open-api-demo.open-api.magicline.com/
Mock server
https://redocly.sportalliance.com/_mock/apis/magicline/openapi/openapi/

Appointments

Appointment, bookable appointment and slots operations

Operations

Classes

Class and slots operations

Operations

Cross Studio

Cross studio operations

Operations

Customers

Get customers and contracts

Operations

Customers Account

Retrieve customer accounting details

Operations

Customers Communication

Retrieve customer communication details

Operations

Customers Self-service

Operations

Devices

Get device information

Operations

Employees

Employee operations

Operations

Finance

Debt collection operations

Operations

Membership Self-service

Manage membership contracts

Operations

Memberships

Membership operations

Operations

Studios

Get studio information

Operations

Get studio utilization

Request

Required Scopes: STUDIO_READ

Returns information about current checkin count and maximum studio capacity

curl -i -X GET \
  https://open-api-demo.open-api.magicline.com/v1/studios/utilization \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
capacityinteger(int32)

Maximum customers allowed into a facility, if set to null there is no capacity restriction

Example: 100
countinteger(int32)required

Number of currently checked in customers of a facility, count can be higher than capacity

Example: 10
Response
application/json
{
  "capacity": 100,
  "count": 10
}

Get studio general information

Request

Required Scopes: STUDIO_READ

Returns studio's general information for authenticated subject

curl -i -X GET \
  https://open-api-demo.open-api.magicline.com/v1/studios/information \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
namestring

Studio name

Example: "Example studio"
descriptionstring

Studio description

Example: "Example studio description"
emailstring

Studio email address

Example: "operator@example.com"
logoUrlstring

Url to studio logo

Example: "https://example.com"
telephonestring

Studio telephone

Example: "0831/6901234-10"
websitestring

Studio website url

Example: "https://example.com"
openingHoursArray of objects(StudioOpeningHours)

Studio opening hours

streetstring

Studio address' street

Example: "Kastanienallee"
houseNumberstring

Studio address' house number

Example: "83"
zipstring

Studio address' zip code

Example: "84439"
citystring

Studio address' city

Example: "Berlin"
countrystring

Studio address' country

Example: "Germany"
countryCodestring(ISO 3166-1)

Studio address' country code

Example: "DE"
studioIdinteger(int64)required

Studio Id

Example: 123
accessCodeConfigurationobject(StudioAccessCodeConfiguration)required

Studio access code configurations

accessCodeConfiguration.​enabledboolean

Whether or not the access code is enabled

Response
application/json
{
  "name": "Example studio",
  "description": "Example studio description",
  "email": "operator@example.com",
  "logoUrl": "https://example.com",
  "telephone": "0831/6901234-10",
  "website": "https://example.com",
  "openingHours": [
    { … }
  ],
  "street": "Kastanienallee",
  "houseNumber": "83",
  "zip": "84439",
  "city": "Berlin",
  "country": "Germany",
  "countryCode": "DE",
  "studioId": 123,
  "accessCodeConfiguration": {
    "enabled": true
  }
}

Confirm contract activation

Request

If your integration has webhook access, then you need to activate webhook events via this endpoint

curl -i -X POST \
  https://open-api-demo.open-api.magicline.com/v1/studios/confirmActivation \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

OK

Response
No content

Trial Offers

Get trial offers information

Operations