Skip to content
/Body Measurement

Body Measurement

Operations

Get Body Measurement

Request

This endpoint retrieves the latest body measurement of the user

Security
user
Query
metricsArray of strings

Subset of BodyMetricType values to include in the response. When omitted, all available metric types are returned.

Items Enum:"BMI""WEIGHT_KG""HEIGHT_CM""BODY_FAT_PERCENTS""WAIST_TO_HIP_RATIO""HIP_CM""WAIST_CM""BODY_MUSCLE_PERCENTS""BODY_FAT_MASS_KG""SKELETAL_MUSCLE_MASS_KG"
curl -i -X GET \
  'https://developer.egym.com/_mock/equipment/partner-api/api/v1/measurements/body?metrics=BMI' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Ok

Bodyapplication/json
dataobject

Map of body metric types to their latest recorded numeric values. Keys are BodyMetricType enum string values. Only metrics that have been measured for the user are present in the response.

Example:
{
  "BMI": 22.5,
  "WEIGHT_KG": 75,
  "HEIGHT_CM": 180,
  "BODY_FAT_PERCENTS": 18.3,
  "WAIST_CM": 82
}
Response
{
  "data": {
    "BMI": 22.5,
    "WEIGHT_KG": 75,
    "HEIGHT_CM": 180,
    "BODY_FAT_PERCENTS": 18.3,
    "WAIST_CM": 82
  }
}