Skip to content
/User

User Details

Request

This endpoint returns a user

Security
user
curl -i -X GET \
  https://developer.egym.com/_mock/equipment/partner-api/api/v1/users \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Ok

Bodyapplication/json
userIdstring

The userId assigned by EGYM, for example -1c2yqo37vn9m. Can be null on xID authentication if BMA User is not linked to EGYM account.

Example:"-1c2yqo37vn9m"
bmaUserIdstring

Temporary solution for Matrix. The BMA userId assigned by egym, for example d101df00-ab9d-40f5-8f03-3c50aaa364d6. Only available during xID authentication

Example:"d101df01-ab9d-40f5-8f03-3c50aaa364d6"
firstNamestringrequired

The user's first name.

lastNamestring

The user's last name.

imageobject(ImageReferenceDTO)

The user profile image.

emailstring

The email address of the user. Not available by default. Only available if needed for use case.

genderstring

The gender of the user.

Enum:"MALE""FEMALE""NON_BINARY"
dateOfBirthstring, (date)

The date of birth in ISO 8601 format (yyyy-MM-dd).

optInsobject

List of opt-ins.

heightnumber, (double)

The body height of the user in centimeters.

Example:180
weightnumber, (double)

The body weight of the user in kilograms.

Example:75
localestring

The user locale is either in ISO 15897 standard format. i.e.: 'en_US' or just language. i.e.: 'en'

Example:"en_US"
unitSystemstring

The user Unit System.

Enum:"METRIC""US_CUSTOMARY""IMPERIAL"
trainingProgramstring

The Smart Cardio training program.

Enum:"WEIGHT_LOSS""FITNESS""MUSCLE_GAIN""BBP""BBP_AND_WEIGHT_LOSS""REHASPORT""IMMUNITY"
trainingPlanPreferencesobject(TrainingPlanPreferencesDTO)

Training Preferences of the User. Deprecates trainingGoal and trainingProgram.

onboardingChecklistobject(OnboardingChecklistDTO)

Genius Onboarding Checklist of the User. Denotes the onboarding progress statuses for the user.

termsAndConditionsAcceptedboolean

Informs if the terms and conditions of EGYM have been accepted.

cardioTestInfoobject(CardioTestUserInfoDTO)

The cardio test user information. It is enabled only for Smart Cardio.

trainingGoalstringdeprecated

The user training goal.

Enum:"WEIGHT_LOSS""FITNESS""MUSCLE_GAIN""BBP""BBP_AND_WEIGHT_LOSS""REHASPORT"
Response
{
  "userId": "-1c2yqo37vn9m",
  "bmaUserId": "d101df01-ab9d-40f5-8f03-3c50aaa364d6",
  "firstName": "string",
  "lastName": "string",
  "image": {
    "imageType": "EXERCISE",
    "imageId": "string"
  },
  "email": "string",
  "gender": "MALE",
  "dateOfBirth": "2019-08-24",
  "optIns": {
    "property1": true,
    "property2": true
  },
  "height": 180,
  "weight": 75,
  "locale": "en_US",
  "unitSystem": "METRIC",
  "trainingGoal": "WEIGHT_LOSS",
  "trainingProgram": "WEIGHT_LOSS",
  "trainingPlanPreferences": {
    "trainingGoalType": "WEIGHT_LOSS",
    "trainingExperience": "BEGINNER",
    "daysPerWeek": 1,
    "trainingMuscleGroupPreferences": [ … ],
    "workoutDurationInMinutes": 5
  },
  "onboardingChecklist": {
    "preferences": { … },
    "strengthTest": { … },
    "bodyMeasurement": { … },
    "machineSettingsMeasurements": { … }
  },
  "termsAndConditionsAccepted": true,
  "cardioTestInfo": {
    "reminder": 1553074207520,
    "instructions": [ … ]
  }
}