Skip to main content
The measurements module provides tools to fetch body metrics (weight, fat %, chest circumference) recorded for clients. Records remain scoped to the connected company. The connection’s health consent is required; per-client external-data grants are not required and do not limit the requested measurement date range.

Available Tools

list_measurement_types

List the types of metrics configured in the system (e.g. Weight, Waist, Fat Percentage).
  • Type: Read-only
  • Important Input Fields:
    • page (integer, optional): Page number, starting at 1.
    • limit (integer, optional): Items per page, default 10, maximum 100.
  • Returns: page, limit, total and types[]. Request the next page while page * limit < total.

get_client_measurements

Retrieve historical records of body measurements logged for a client.
  • Type: Read-only
  • Important Input Fields:
    • clientId (string, required): Unique identifier of the client.
    • measurementTypeKey (string, optional): Specific metric filter (e.g., weight).
    • dateFrom (string, optional): Start date range filter.
    • dateTo (string, optional): End date range filter.

log_client_measurement

log_client_measurement records an entry for an accessible company client. It requires the measurements module, its explicit write-tool grant and health consent. Required inputs are clientId, typeId, numeric value and unit. Use list_measurement_types to resolve the type and allowed units first. Optional measuredAt is a UTC ISO 8601 timestamp; omitting it uses the current time. An optional note is limited to 500 characters. The tool cannot define or edit measurement types.

Natural Language Examples

  • “Get the weight logs for client client_5f81 since January 2026.”
  • “Retrieve all fat percentage entries for client client_9823.”

JSON-RPC Call Example (get_client_measurements)