Skip to content
/
Upload account image

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

Partially update an account

Request

Partially update an account using accountId. Only non-null fields in the request will be updated. This is optimized for small, incremental changes.

Security
mms
Path
accountIdstringrequired
Bodyapplication/jsonrequired
emailstring

The Member email address. It should be unique within the gym chain.

firstNamestring

The Member first name.

Example: "John"
lastNamestring

The Member last name.

Example: "Wick"
dateOfBirthstring(date)

The Member date of birth. format: yyyy-MM-dd

genderstring

The Member gender. Please note that NON_BINARY is not correctly supported yet, we send it as FEMALE for the usage of the machines.

Enum"MALE""FEMALE""NON_BINARY"
contactobject(ContactDTO)

The user's contact information

membershipobject(PatchMembershipDTO)

The membership details.

curl -i -X PATCH \
  'https://developer.egym.com/_mock/mms-api-v2/apis/mms-v2/api/v2/accounts/{accountId}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "email": "string",
    "firstName": "John",
    "lastName": "Wick",
    "dateOfBirth": "2019-08-24",
    "gender": "MALE",
    "contact": {
      "phone": "string",
      "street": "string",
      "streetNumber": "string",
      "zipCode": "string",
      "city": "string",
      "state": "string",
      "country": "DE"
    },
    "membership": {
      "membershipId": "string",
      "agreementNumber": "string",
      "membershipType": "BASIC",
      "membershipSubType": "string",
      "endOfContract": "2019-08-24",
      "startOfContract": "2019-08-24",
      "referringMemberId": "string",
      "barcode": "string"
    }
  }'

Responses

No Content

Response
No content

Upload account image

Request

This endpoint allows to upload a profile picture to the specified user using accountId (Supported formats: JPG, JPEG, PNG. Max file size: 16MB)

Security
mms
Path
accountIdstringrequired
Headers
Content-Lengthinteger(int32)required
Bodymultipart/form-data
fileany(Part)required
curl -i -X PUT \
  'https://developer.egym.com/_mock/mms-api-v2/apis/mms-v2/api/v2/accounts/{accountId}/images' \
  -H 'Content-Length: 0' \
  -H 'Content-Type: multipart/form-data' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

No Content

Response
No content

Delete account image

Request

This endpoint allows to delete a profile picture of the specified user using accountId

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

Responses

No Content

Response
No content

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

Webhooks

Operations with webhooks

Operations

Push notifications

Send push notifications to EGYM mobile apps

Operations