Skip to content
Connect API
/
/Studios

Magicline Connect API (1.0.0)

Scope of this API

This API can be used to integrate Magicline operations into third party clients like websites or apps.

Following operations are supported

  • Online contract conclusion
  • Trial session slot booking
  • Lead creation
Download OpenAPI description
connectapi.json
connectapi.yaml
Overview
URL

https://developer.sportalliance.com/

Languages
Servers
Generated server url

https://connectdemo.api.magicline.com/

Mock server

https://redocly.sportalliance.com/_mock/apis/magicline/connectapi/connectapi/

Campaigns

List your marketing campaigns

Operations

Terminal

/terminal

Operations

TrialSessions

Allow prospects to book a trial session

Operations

Tenant

Tenant information

Operations

Referral

Additional referral information for member creation

Operations

Image

Allow prospect to upload image

Operations

Promotions

Getting information about external promotion participation

Operations

AddressData

/addressdata

Operations

ContractVoucher

/contractvoucher

Operations

Validation

/validation

Operations

Contracts

Cancel contracts

Operations

CreditCard Tokenization

Store credit cards for new members

Operations

BankAccount

Operations

FeatureCheck

Operations

I18n

Operations

Leads

Operations

Studios

Operations

Get the studio's default communication settings.

Request

Get the studio's default communication settings. The returned list contains an entry for each existing message category.

Path
studioIdinteger(int64)required
curl -i -X GET \
  'https://connectdemo.api.magicline.com/connect/v1/studio/{studioId}/communication-settings'

Responses

OK

Body*/*Array [
communicationChannelsArray of objects(CommunicationChannelDto)

A list containing all channels. Each channel contains information on whether it is active and / or customer overridable.

messageCategoryobject(MessageCategoryDto)

The message category

]

getSepaAgreementTextForRateBundle

Request

Path
studioIdinteger(int64)required
rateBundleIdinteger(int64)required
Query
languagestring

Language to pick the right translation (IETF BCP 47 language tags)

Example: language=de-DE
curl -i -X GET \
  'https://connectdemo.api.magicline.com/connect/v1/studio/{studioId}/rate/{rateBundleId}/sepa/agreement?language=de-DE'

Responses

OK

Body*/*
string

getSepaAgreementText

Request

Path
studioIdinteger(int64)required
curl -i -X GET \
  'https://connectdemo.api.magicline.com/connect/v1/studio/{studioId}/sepa/agreement'

Responses

OK

Body*/*
string

Get utilization for the studio.

Request

Return information about the utilization of this studio. Needs to be enabled for public view in the configuration.

Path
studioIdinteger(int64)required
curl -i -X GET \
  'https://connectdemo.api.magicline.com/connect/v1/studio/{studioId}/utilization'

Responses

OK

Body*/*
endTimeobject(LocalTime)
itemsArray of objects(UtilizationItemDto)required
items[].​endTimeobject(LocalTime)required
items[].​endTime.​hourinteger(int32)
items[].​endTime.​minuteinteger(int32)
items[].​endTime.​nanointeger(int32)
items[].​endTime.​secondinteger(int32)
items[].​isCurrentbooleanrequired
items[].​levelstringrequired
Enum"HIGH""NORMAL""LOW"
items[].​percentageinteger(int32)required
items[].​startTimeobject(LocalTime)required
items[].​startTime.​hourinteger(int32)
items[].​startTime.​minuteinteger(int32)
items[].​startTime.​nanointeger(int32)
items[].​startTime.​secondinteger(int32)
startTimeobject(LocalTime)

List all studios

Request

You can add optional filters. Parameters addressSearchQuery and studioTags are combined by AND

Query
studioTagsArray of strings

Filter by identifier of StudioTag (german wording: Standort Code). Dynamic attribute configured at studio (e.g for Brands or Locations). Multiple Tags are combined by OR.

addressSearchQuerystring

Search prefix for zipCode or city of studio address.

curl -i -X GET \
  'https://connectdemo.api.magicline.com/connect/v2/studio?studioTags=string&addressSearchQuery=string'

Responses

OK

Body*/*Array [
addressobject(ConnectApiStudioAddressDto)
closingDatestring(date)

Studio is either fully closed, or temporarily closed from this date on. It is up to the studio owner to decide how to interpret this value on his website.

currencyCodestring

Studio currency code

Enum"UNDEFINED""AED""AFN""ALL""AMD""ANG""AOA""ARS""AUD""AWG"
hasRateBundlesboolean

Does this studio has contract offers for online sign up

idinteger(int64)required

Id of current data block. See name field parameter or name of Dto!

masterStudioIdinteger(int64)
openingDatestring(date)

If this value is set, inform the customer about a delayed contract start. Send start date with min value of openingDate!

openingHoursArray of objects(StudioAvailabilityDto)

List of day ranges with openingHours, dayOfWeek 1 = MONDAY, dayOfWeek 7 = SUNDAY. Might be one range 1 - 7 if openingHours does not differ from day to day or multiple ranges like 1-5 and 6-7 if the studio has different opening hours on week days and weekends.

studioEmailstring
studioNamestringrequired
studioPhonestring
studioTagsArray of objects(ConnectApiStudioTagDto)
trialSessionBookableboolean

Has this studio trial session configured for online booking of slots

trialSessionNamestring

Name of the trial session benefit which you can book appointments for

zoneIdobject

Timezone of the studios location

]

Fetch detail information for one studio

Request

Path
studioIdinteger(int64)required
curl -i -X GET \
  'https://connectdemo.api.magicline.com/connect/v2/studio/details/{studioId}'

Responses

OK

Body*/*
addressobject(ConnectApiStudioAddressDto)
centralLegalLinksArray of objects(CentralLegalLinkDto)

Legal Links configured on the Operating Company currently active on the Studio

closingDatestring(date)

Studio is either fully closed, or temporarily closed from this date on. It is up to the studio owner to decide how to interpret this value on his website.

currencyCodestring

Studio currency code

Enum"UNDEFINED""AED""AFN""ALL""AMD""ANG""AOA""ARS""AUD""AWG"
defaultLocalestring

The Studios default Locale

hasRateBundlesboolean

Does this studio has contract offers for online sign up

idinteger(int64)required

Id of current data block. See name field parameter or name of Dto!

masterStudioIdinteger(int64)
openingDatestring(date)

If this value is set, inform the customer about a delayed contract start. Send start date with min value of openingDate!

openingHoursArray of objects(StudioAvailabilityDto)

List of day ranges with openingHours, dayOfWeek 1 = MONDAY, dayOfWeek 7 = SUNDAY. Might be one range 1 - 7 if openingHours does not differ from day to day or multiple ranges like 1-5 and 6-7 if the studio has different opening hours on week days and weekends.

referralProgramActiveboolean

Whether the studio has an active referral program configuration

studioEmailstring
studioNamestringrequired
studioPhonestring
studioTagsArray of objects(ConnectApiStudioTagDto)
trialSessionBookableboolean

Has this studio trial session configured for online booking of slots

trialSessionHoursArray of objects(StudioAvailabilityDto)

List of day range and timeframe where trial session can be booked, dayOfWeek 1 = MONDAY, dayOfWeek 7 = SUNDAY.Might be one range 1 - 7 if trialSessionHours does not differ from day to day or multiple ranges like 1-5 and 6-7 if the studio has different trialSessionHours on week days and weekends.

trialSessionNamestring

Name of the trial session benefit which you can book appointments for

zoneIdobject

Timezone of the studios location

Fetch information for one studio

Request

Path
studioIdinteger(int64)required
curl -i -X GET \
  'https://connectdemo.api.magicline.com/connect/v2/studio/{studioId}'

Responses

OK

Body*/*
addressobject(ConnectApiStudioAddressDto)
closingDatestring(date)

Studio is either fully closed, or temporarily closed from this date on. It is up to the studio owner to decide how to interpret this value on his website.

currencyCodestring

Studio currency code

Enum"UNDEFINED""AED""AFN""ALL""AMD""ANG""AOA""ARS""AUD""AWG"
hasRateBundlesboolean

Does this studio has contract offers for online sign up

idinteger(int64)required

Id of current data block. See name field parameter or name of Dto!

masterStudioIdinteger(int64)
openingDatestring(date)

If this value is set, inform the customer about a delayed contract start. Send start date with min value of openingDate!

openingHoursArray of objects(StudioAvailabilityDto)

List of day ranges with openingHours, dayOfWeek 1 = MONDAY, dayOfWeek 7 = SUNDAY. Might be one range 1 - 7 if openingHours does not differ from day to day or multiple ranges like 1-5 and 6-7 if the studio has different opening hours on week days and weekends.

studioEmailstring
studioNamestringrequired
studioPhonestring
studioTagsArray of objects(ConnectApiStudioTagDto)
trialSessionBookableboolean

Has this studio trial session configured for online booking of slots

trialSessionNamestring

Name of the trial session benefit which you can book appointments for

zoneIdobject

Timezone of the studios location

Fetch enabled communication feature modules for one studio

Request

Path
studioIdinteger(int64)required
curl -i -X GET \
  'https://connectdemo.api.magicline.com/connect/v2/studio/{studioId}/communicationFeatures'

Responses

OK

Body*/*Array [
string
Enum"ANALYTICS""CALENDAR""CASH_REGISTER""CHECK_IN""CHECK_IN_BENEFITS""CHECK_IN_DISCOUNT""CLASSES""CORPORATE_FITNESS""CROSS_LOCATION_SALES""CUSTOMER_GROUPS"
]

Previews

Operations