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

Retrieve user RFIDs

Request

Returns a list of RFIDs of the user.

Security
mms
Path
accountIdstringrequired
Query
allSourcesboolean

Allows to receive user RFIDs that were assigned not only by MMS but also by other sources.

Default false
curl -i -X GET \
  'https://developer.egym.com/_mock/mms-api-v2/apis/mms-v2/api/v2/accounts/{accountId}/rfids?allSources=false' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Ok

Bodyapplication/jsonArray [
rfidstring^0x([0-9a-fA-F]{2})+$required

String representing RFID value in hex (with leading "0x"). Please ensure that the RFID string after "0x" contains an even number of hexadecimal characters and that only RFID information is sent in this field, but no other medium like magnetic stripe card numbers or bar codes.

tagFormatstring

The rfid tag format.

Enum"HITAG1""MIFARE""LEGIC"
]
Response
application/json
[
  {
    "rfid": "string",
    "tagFormat": "HITAG1"
  }
]

Update RFIDs of a user

Request

Note: If this field is sent we will replace the RFID list of this user with the info sent (for an empty list, we will delete all RFID connections of this user). The operation does not affect RFIDs assigned from other sources like EGYM machines, Fitness Hub etc.

Security
mms
Path
accountIdstringrequired
Bodyapplication/jsonrequired
rfidsArray of objects(RfidDTO)required

List of the user's RFIDs

rfids[].​rfidstring^0x([0-9a-fA-F]{2})+$required

String representing RFID value in hex (with leading "0x"). Please ensure that the RFID string after "0x" contains an even number of hexadecimal characters and that only RFID information is sent in this field, but no other medium like magnetic stripe card numbers or bar codes.

rfids[].​tagFormatstring

The rfid tag format.

Enum"HITAG1""MIFARE""LEGIC"
curl -i -X PUT \
  'https://developer.egym.com/_mock/mms-api-v2/apis/mms-v2/api/v2/accounts/{accountId}/rfids' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "rfids": [
      {
        "rfid": "string",
        "tagFormat": "HITAG1"
      }
    ]
  }'

Responses

Ok

Response
No content

Add RFID

Request

Add RFID to specified user.

Security
mms
Path
accountIdstringrequired
Bodyapplication/jsonrequired
rfidstring^0x([0-9a-fA-F]{2})+$required

String representing RFID value in hex (with leading "0x"). Please ensure that the RFID string after "0x" contains an even number of hexadecimal characters and that only RFID information is sent in this field, but no other medium like magnetic stripe card numbers or bar codes.

tagFormatstring

The rfid tag format.

Enum"HITAG1""MIFARE""LEGIC"
curl -i -X POST \
  'https://developer.egym.com/_mock/mms-api-v2/apis/mms-v2/api/v2/accounts/{accountId}/rfids' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "rfid": "string",
    "tagFormat": "HITAG1"
  }'

Responses

Ok

Bodyapplication/json
rfidstring^0x([0-9a-fA-F]{2})+$required

String representing RFID value in hex (with leading "0x"). Please ensure that the RFID string after "0x" contains an even number of hexadecimal characters and that only RFID information is sent in this field, but no other medium like magnetic stripe card numbers or bar codes.

tagFormatstring

The rfid tag format.

Enum"HITAG1""MIFARE""LEGIC"
Response
application/json
{
  "rfid": "string",
  "tagFormat": "HITAG1"
}

Products booking

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

Operations

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