get-body-measurements
Lists dated body measurements for the account, returned from newest to oldest. Use this tool to browse measurement history or retrieve multiple entries in one call. Kind: Read-onlyPage number to retrieve, starting at
1.Number of measurements to return per page. Maximum is
10.Results are paginated.
page starts at 1 and pageSize is capped at 10. Iterate with incrementing page values to walk through the full history.get-body-measurement
Retrieves the body measurement entry for a single specific date. Use this tool when the exact measurement date is already known. For browsing or discovering dates, useget-body-measurements instead.
Kind: Read-only
The date of the body measurement to retrieve, in
YYYY-MM-DD format. Example: 2024-03-15.At most one measurement entry exists per date. If no entry exists for the supplied date, the tool returns a
null body measurement rather than an error.create-body-measurement
Creates a new dated body measurement on the Hevy account. Supply the date and at least one numeric measurement field. Use this tool only for dates that do not yet have an entry; to modify an existing entry useupdate-body-measurement.
Kind: Write (mutation)
The date for the new measurement, in
YYYY-MM-DD format. Must be unique — no measurement entry may already exist for this date.Body weight in kilograms.
Lean body mass in kilograms.
Body fat percentage.
Neck circumference in centimeters.
Shoulder circumference in centimeters.
Chest circumference in centimeters.
Left bicep circumference in centimeters.
Right bicep circumference in centimeters.
Left forearm circumference in centimeters.
Right forearm circumference in centimeters.
Abdomen circumference in centimeters.
Waist circumference in centimeters.
Hips circumference in centimeters.
Left thigh circumference in centimeters.
Right thigh circumference in centimeters.
Left calf circumference in centimeters.
Right calf circumference in centimeters.
Fields set to
null or omitted are not sent to the API and cannot be used to clear previously stored values. To change an existing value, use update-body-measurement with the new numeric value.update-body-measurement
Updates the body measurement for a date that already has an existing entry. Supplydate and at least one numeric field to change. To create an entry for a date that has no record yet, use create-body-measurement.
Kind: Write (mutation)
The date of the measurement to update, in
YYYY-MM-DD format. An entry must already exist for this date.Body weight in kilograms.
Lean body mass in kilograms.
Body fat percentage.
Neck circumference in centimeters.
Shoulder circumference in centimeters.
Chest circumference in centimeters.
Left bicep circumference in centimeters.
Right bicep circumference in centimeters.
Left forearm circumference in centimeters.
Right forearm circumference in centimeters.
Abdomen circumference in centimeters.
Waist circumference in centimeters.
Hips circumference in centimeters.
Left thigh circumference in centimeters.
Right thigh circumference in centimeters.
Left calf circumference in centimeters.
Right calf circumference in centimeters.
You must provide at least one numeric measurement field; calling this tool with only
date and no measurement fields is rejected. Fields set to null are omitted and cannot clear previously stored values — only supplying a new numeric value overwrites an existing one.Date format
All body measurement tools use calendar dates inYYYY-MM-DD format — for example, 2024-03-15. There is no time component. The Hevy API enforces a strict one-entry-per-date constraint, so the date acts as the unique key for every measurement record.
Measurement fields
All numeric fields are optional on bothcreate-body-measurement and update-body-measurement. You may record any combination that is relevant to a given weigh-in.