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
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

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

Retrieve task details

Request

This endpoint returns the details of a specific trainer task.

Security
mms
Path
taskIdinteger(int64)required
curl -i -X GET \
  'https://developer.egym.com/_mock/mms-api-v2/apis/mms-v2/api/v2/tasks/{taskId}' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Ok

Bodyapplication/json
idstringread-only

The ID of the task

namestringnon-emptyrequired

Task name

typestring

Task type

Enum"GENERAL""ANAMNESIS""COORDINATION_FITNESS_TEST""HEALTH_FITNESS_TEST""PWC_FITNESS_TEST""MAX_FORCE_FITNESS_TEST""MOBILITY_SCREEN_FITNESS_TEST""BLOOD_PRESSURE_FITNESS_TEST""POLAR_FITNESS_TEST""INBODY_FITNESS_TEST"
dueDatestring(date)required

Task completion deadline date. format: yyyy-MM-dd

authorIdstringnon-emptyrequired

The author of the task. EGYM account ID

targetIdstringnon-emptyrequired

The account of task related to. EGYM account ID

completerIdstring

The account who solved the task. EGYM account ID

completedboolean

If this task has been completed in the gym this will be true, false otherwise.

Response
application/json
{ "id": "string", "name": "string", "type": "GENERAL", "dueDate": "2019-08-24", "authorId": "string", "targetId": "string", "completerId": "string", "completed": true }

Update a task

Request

This endpoint updates trainer task in a gym.

Security
mms
Path
taskIdinteger(int64)required
Bodyapplication/jsonrequired
namestringnon-emptyrequired

Task name

typestring

Task type

Enum"GENERAL""ANAMNESIS""COORDINATION_FITNESS_TEST""HEALTH_FITNESS_TEST""PWC_FITNESS_TEST""MAX_FORCE_FITNESS_TEST""MOBILITY_SCREEN_FITNESS_TEST""BLOOD_PRESSURE_FITNESS_TEST""POLAR_FITNESS_TEST""INBODY_FITNESS_TEST"
dueDatestring(date)required

Task completion deadline date. format: yyyy-MM-dd

authorIdstringnon-emptyrequired

The author of the task. EGYM account ID

targetIdstringnon-emptyrequired

The account of task related to. EGYM account ID

completerIdstring

The account who solved the task. EGYM account ID

completedboolean

If this task has been completed in the gym this will be true, false otherwise.

curl -i -X PUT \
  'https://developer.egym.com/_mock/mms-api-v2/apis/mms-v2/api/v2/tasks/{taskId}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "name": "string",
    "type": "GENERAL",
    "dueDate": "2019-08-24",
    "authorId": "string",
    "targetId": "string",
    "completerId": "string",
    "completed": true
  }'

Responses

Ok

Bodyapplication/json
idstringread-only

The ID of the task

namestringnon-emptyrequired

Task name

typestring

Task type

Enum"GENERAL""ANAMNESIS""COORDINATION_FITNESS_TEST""HEALTH_FITNESS_TEST""PWC_FITNESS_TEST""MAX_FORCE_FITNESS_TEST""MOBILITY_SCREEN_FITNESS_TEST""BLOOD_PRESSURE_FITNESS_TEST""POLAR_FITNESS_TEST""INBODY_FITNESS_TEST"
dueDatestring(date)required

Task completion deadline date. format: yyyy-MM-dd

authorIdstringnon-emptyrequired

The author of the task. EGYM account ID

targetIdstringnon-emptyrequired

The account of task related to. EGYM account ID

completerIdstring

The account who solved the task. EGYM account ID

completedboolean

If this task has been completed in the gym this will be true, false otherwise.

Response
application/json
{ "id": "string", "name": "string", "type": "GENERAL", "dueDate": "2019-08-24", "authorId": "string", "targetId": "string", "completerId": "string", "completed": true }

Retrieve all tasks

Request

This endpoint returns a list of trainer tasks that are available in the gym. Can be filtered by modified date time.

Security
mms
Query
modifiedSincestring(date-time)
curl -i -X GET \
  'https://developer.egym.com/_mock/mms-api-v2/apis/mms-v2/api/v2/tasks?modifiedSince=2019-08-24T14%3A15%3A22Z' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Ok

Bodyapplication/jsonArray [
idstringread-only

The ID of the task

namestringnon-emptyrequired

Task name

typestring

Task type

Enum"GENERAL""ANAMNESIS""COORDINATION_FITNESS_TEST""HEALTH_FITNESS_TEST""PWC_FITNESS_TEST""MAX_FORCE_FITNESS_TEST""MOBILITY_SCREEN_FITNESS_TEST""BLOOD_PRESSURE_FITNESS_TEST""POLAR_FITNESS_TEST""INBODY_FITNESS_TEST"
dueDatestring(date)required

Task completion deadline date. format: yyyy-MM-dd

authorIdstringnon-emptyrequired

The author of the task. EGYM account ID

targetIdstringnon-emptyrequired

The account of task related to. EGYM account ID

completerIdstring

The account who solved the task. EGYM account ID

completedboolean

If this task has been completed in the gym this will be true, false otherwise.

]
Response
application/json
[ { "id": "string", "name": "string", "type": "GENERAL", "dueDate": "2019-08-24", "authorId": "string", "targetId": "string", "completerId": "string", "completed": true } ]

Webhooks

Operations with webhooks

Operations

Push notifications

Send push notifications to EGYM mobile apps

Operations