Withings API icon

Withings API

Withings API Integration
Join our community

Actions11

Overview

This node integrates with the Withings API to retrieve various health-related measurements data for a user. Specifically, when configured for the "Measure" resource and the "Get Measurements" operation, it fetches detailed measurement records such as weight, height, blood pressure, heart pulse, temperature, and other body composition metrics.

Common scenarios where this node is beneficial include:

  • Health and fitness applications that need to import or synchronize user biometric data from Withings devices.
  • Wellness dashboards aggregating multiple health metrics for analysis or visualization.
  • Automated workflows that trigger actions based on updated health measurements (e.g., alert if blood pressure exceeds a threshold).

Practical example: A fitness coach uses this node to automatically pull weekly weight and muscle mass measurements from clients’ Withings accounts to monitor progress without manual data entry.

Properties

Name Meaning
Additional Fields Optional parameters to refine data retrieval:
- Start Date: Retrieve data from this timestamp.
- End Date: Retrieve data up to this timestamp.
- Last Update: Get only data updated after this timestamp.
- Offset: Skip a number of records (for pagination).
Measure Type Select one or more types of measurements to retrieve. Options include:
Weight, Height, Fat Free Mass, Fat Ratio, Fat Mass Weight, Diastolic Blood Pressure, Systolic Blood Pressure, Heart Pulse, Temperature, SpO2, Body Temperature, Skin Temperature, Muscle Mass, Hydration, Bone Mass, Pulse Wave Velocity.

Output

The node outputs JSON objects containing the results of the Withings API call. The structure includes:

  • success: Boolean indicating if the API call was successful.
  • resource: The resource type, here always "measure".
  • operation: The operation performed, here "getmeas".
  • Measurement data fields as returned by the Withings API under the body property, which typically contains arrays of measurement groups and individual measures with timestamps, types, and values.

If the API call fails, the output JSON will contain:

  • success: false
  • error: Error message string
  • status: HTTP status code or API error code
  • errorCode: Specific error code from the API (if any)
  • resource and operation for context

The node does not output binary data.

Dependencies

  • Requires an OAuth2 API credential for authenticating with the Withings API.
  • Network access to https://wbsapi.withings.net endpoints.
  • The node internally handles retries, token refresh attempts, and rate limiting delays.

Troubleshooting

Common Issues

  • Authentication errors: Invalid or expired OAuth tokens can cause 401/403 errors.
  • API rate limits: Too many requests in a short time may result in temporary blocks.
  • Incorrect parameter formats: Dates must be valid timestamps; invalid inputs may cause API errors.
  • Network issues: Connectivity problems can lead to request timeouts.

Error Messages and Resolutions

  • Errors mentioning token expiration or unauthorized access suggest reconnecting the Withings account credentials.
  • If the node repeatedly fails after multiple retry attempts, verify that the Withings developer account and app permissions are correctly set.
  • For API errors with specific status codes, consult Withings API documentation for meaning and corrective actions.
  • Temporary API downtime may cause failures; retry after some time.

Links and References

Discussion