Skip to content

MMS API V2 (2.0.0)

RESTful API specification for integrating gym management systems with the EGYM platform. This OpenAPI document defines all available endpoints, request/response schemas, authentication requirements, and error codes.

Key Features:

  • Member account and membership management
  • RFID assignment and management
  • Real-time gym visit tracking (check-in/check-out)
  • EGYM product booking (Smart Strength, EGYM+)
  • Trainer task creation and tracking
  • Webhook subscriptions for event notifications
  • Push notifications to EGYM mobile apps
  • Member migration from V1 API
Download OpenAPI description
mms-v2.json
mms-v2.yaml
Overview
URL
https://egym.com/
MMS Connect Team
connect@egym.com
Terms of Service
Languages
Servers
Mock server
https://developer.egym.com/_mock/mms-api-v2/apis/mms-v2/
Test
https://one-mms-service.ext-1.test.co.egym.coffee/
Prod
https://mms.api.egym.com/

Member Account

These operations are needed to create and update member accounts and their membership information.

Operations

Member Account Roles

These operation are needed to assign and retrieve member account roles

Operations

Member RFIDs

Operations with RFIDs

Operations

Products booking

Operations on EGYM products. Currently available products are EGYM Smart Strength (Machine Admission) and EGYM+

Operations

Retrieve user activated products

Request

Returns a list of products that are activated for the specified user and gym and are active now or in the future.

Security
mms
Path
accountIdstringrequired
curl -i -X GET \
  'https://developer.egym.com/_mock/mms-api-v2/apis/mms-v2/api/v2/accounts/{accountId}/products' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Ok

Bodyapplication/jsonArray [
productIdstringnon-emptyrequired

The ID of the product.

startDatestring(date)

The date from which the specified product is active and can be used by the user. It must be today’s or future date in Timezone of the club. format: yyyy-MM-dd

endDatestring(date)

The date to which the specified product is active and can be used by the user. It must be future date in Timezone of the club. format: yyyy-MM-dd. Max date is 2050-12-31

]
Response
application/json
[
  {
    "productId": "string",
    "startDate": "2019-08-24",
    "endDate": "2019-08-24"
  }
]

Activate a product or update product booking

Request

This endpoint activates or updates a product for a user in a gym. The product is active starting from the specified start date to the end date in Timezone of the club.

Security
mms
Path
accountIdstringrequired
Bodyapplication/jsonrequired
productIdstringnon-emptyrequired

The ID of the product.

startDatestring(date)

The date from which the specified product is active and can be used by the user. It must be today’s or future date in Timezone of the club. format: yyyy-MM-dd

endDatestring(date)

The date to which the specified product is active and can be used by the user. It must be future date in Timezone of the club. format: yyyy-MM-dd. Max date is 2050-12-31

curl -i -X PUT \
  'https://developer.egym.com/_mock/mms-api-v2/apis/mms-v2/api/v2/accounts/{accountId}/products' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "productId": "string",
    "startDate": "2019-08-24",
    "endDate": "2019-08-24"
  }'

Responses

Ok

Bodyapplication/json
productIdstringnon-emptyrequired

The ID of the product.

startDatestring(date)

The date from which the specified product is active and can be used by the user. It must be today’s or future date in Timezone of the club. format: yyyy-MM-dd

endDatestring(date)

The date to which the specified product is active and can be used by the user. It must be future date in Timezone of the club. format: yyyy-MM-dd. Max date is 2050-12-31

Response
application/json
{
  "productId": "string",
  "startDate": "2019-08-24",
  "endDate": "2019-08-24"
}

Retrieve gym products

Request

Returns a list of products that are available in the gym and can be activated for a user.

Security
mms
curl -i -X GET \
  https://developer.egym.com/_mock/mms-api-v2/apis/mms-v2/api/v2/products \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Ok

Bodyapplication/jsonArray [
productIdstringread-only

The ID of the product.

titlestringread-only

Product title.

descriptionstringread-only

Product description.

scopestring

The scope of the bookable package.

Enum"LOCATION""CHAIN""BRAND"
]
Response
application/json
[
  {
    "productId": "string",
    "title": "string",
    "description": "string",
    "scope": "LOCATION"
  }
]

Member Account NFC

Note that NFC API endpoints are in beta as we've been tuning setup processes on both EGYM and partner sides.

Operations

Migrating members

These operations are needed to migrate members from V1 API to V2 API.

Operations

Gym Visit

These operations are needed to transmit the information to EGYM, that a specific member is currently in the gym. Based on that information several business logics are built, to provide a seamless training floor experience to the members of that gym. For example the trainer on the Training Floor is informed that this member is here and that he should complete some tasks.

Operations

Trainer Task

These operations are needed to create and update trainer tasks.

Operations

Webhooks

Operations with webhooks

Operations

Push notifications

Send push notifications to EGYM mobile apps

Operations