Withings API icon

Withings API

Withings API Integration

Overview

This node integrates with the Withings API to retrieve user-related health and device data. Specifically, for the "User" resource with the "Get" operation, it fetches detailed user information such as profile data, devices linked to the user, or user goals depending on the selected operation.

Common scenarios where this node is beneficial include:

  • Fetching a user's profile details for personalized health tracking.
  • Retrieving connected device information to understand what hardware is available.
  • Accessing user goals to monitor progress or adjust targets in health applications.

For example, you might use this node to get the latest user profile data before processing activity or sleep metrics, ensuring that all data is associated with the correct user context.

Properties

Name Meaning
Additional Fields Optional parameters to refine data retrieval:
- Start Date: Start timestamp for data filtering.
- End Date: End timestamp for data filtering.
- Last Update: Retrieve only data updated after this timestamp.
- Offset: Skip a number of records (pagination).

Output

The output JSON contains the following structure:

  • success: Boolean indicating if the API call was successful.
  • resource: The resource type requested ("user").
  • operation: The operation performed ("get").
  • Other fields depend on the Withings API response body and typically include user information such as profile details, device list, or goals.

Example output snippet:

{
  "success": true,
  "resource": "user",
  "operation": "get",
  "body": {
    // User-specific data returned by Withings API
  }
}

No binary data is output by this node.

Dependencies

  • Requires an OAuth2 API credential configured for Withings API access.
  • The node makes authenticated HTTP GET requests to the Withings API endpoints.
  • Network connectivity to https://wbsapi.withings.net is required.
  • The node handles token refresh internally but requires valid credentials with appropriate scopes.

Troubleshooting

  • Authentication Errors: If you encounter errors related to tokens, authorization, or permissions (e.g., 401 or 403 status codes), ensure your API credentials are valid and have not expired or been revoked. Reconnect the Withings account in n8n credentials.
  • API Rate Limits or Temporary Failures: The node implements retries with exponential backoff. If failures persist, check Withings API status or reduce request frequency.
  • Invalid Parameters: Ensure date/time fields are correctly formatted timestamps. Incorrect values may cause API errors.
  • Timeouts: Network issues or slow responses can cause timeouts; verify network stability and API availability.

Links and References

Discussion