Withings

App · 14 actions

Read your Withings scale, blood pressure, sleep, activity, workout and ECG data, and start workflows when a new reading, night or workout arrives.

Actions

ActionWhat it does
Get activity through the dayRead minute-by-minute samples (steps, heart rate, calories and more) for up to 24 hours.
Get daily activityRead one summary per day: steps, distance, floors, active time, calories and heart rate.
Get ECG recordingGet one ECG's full signal, in micro-volts, with its sampling rate.
Get goalsGet the person's daily step goal, sleep goal and weight goal.
Get measurementsRead weigh-ins, body composition, blood pressure, heart rate, temperature, SpO2 and other measurements, each as a real number such as weight_kg.
Get notificationCheck a notification subscription for an address and kind of data.
Get sleep stagesRead a night's sleep stages (awake, light, deep, REM) with heart rate, breathing and snoring through it, for up to 24 hours.
Get sleep summariesRead one summary per night: time asleep, deep, light and REM sleep, wake-ups, heart and breathing rates and the sleep score.
Get workoutsRead workouts, such as runs, rides and swims, with their duration, calories, distance and heart rate.
List devicesList the Withings devices linked to the account, with their battery level and when each last synced.
List ECG recordingsList ECG recordings from a ScanWatch, Move ECG or BPM Core, with each one's atrial fibrillation result and heart rate.
List notificationsList the account's notification subscriptions and where each is sent.
Revoke notificationStop Withings sending a kind of notification to an address.
Subscribe to notificationsHave Withings send a message to an address of yours whenever new data of a kind arrives.

Get activity through the day

Read minute-by-minute samples (steps, heart rate, calories and more) for up to 24 hours. Without times, gives the most recent samples.

Inputs

Fromstartdate and time
The start of the window.
Toenddate and time
The end, within 24 hours of the start.
Data to includedata_fieldslist
Which readings to include. Leave empty for all of them.One or more of: steps, elevation (Floors climbed), calories (Active calories), distance (Distance (m)), stroke (Swim strokes), pool_lap (Pool laps), duration (Duration (s)), heart_rate (Heart rate), spo2_auto (SpO2), rmssd (Heart rate variability (RMSSD)), and 5 more.

Outputs

countnumber
How many were returned
sampleslist
The samples, oldest first
Example output
{
  "count": 1,
  "samples": [
    {
      "calories": 4.2,
      "distance": 84.0,
      "duration": 60,
      "heart_rate": 96,
      "steps": 112,
      "time": "2026-11-05T10:00:00Z",
      "timestamp": 1793872800
    }
  ]
}

Get daily activity

Read one summary per day: steps, distance, floors, active time, calories and heart rate. Defaults to the last 7 days.

Inputs

Fromstart_datedate
The first day. Defaults to 7 days before the last.
Toend_datedate
The last day. Defaults to today.
Changed sincechanged_sincedate and time
Only data added or changed after this moment. Use instead of the dates.
Offsetoffsetnumber
The next_offset an earlier run of this step gave, to read on from there.At least 0.

Outputs

countnumber
How many were returned
dayslist
One summary per day
moretrue/false
Whether Withings has more than this step read
next_offsetnumber
Give this to the same step's Offset to read the rest; 0 when there is none
Example output
{
  "count": 1,
  "days": [
    {
      "active": 1800,
      "calories": 412.6,
      "date": "2026-11-05",
      "deviceid": "b7d1c9e2f3a44b5c8d6e7f8091a2b3c4d5e6f708",
      "distance": 6812.5,
      "elevation": 7,
      "hr_average": 74,
      "hr_max": 151,
      "hr_min": 52,
      "intense": 540,
      "is_tracker": true,
      "moderate": 1260,
      "modified_at": "2026-11-06T05:10:00Z",
      "soft": 4320,
      "steps": 9241,
      "timezone": "Europe/Paris",
      "totalcalories": 2311.9
    }
  ],
  "more": false,
  "next_offset": 0
}

Get ECG recording

Get one ECG's full signal, in micro-volts, with its sampling rate.

Inputs

ECG recordingsignal_idtextRequired
The recording's signal id, from 'List ECG recordings' or an earlier step.
Filtered signalwith_filteredtrue/false
Get the filtered version.
Include inactive intervalswith_intervalstrue/false
Include the signal's inactive features too.

Outputs

duration_secondsnumber
How long the recording is
heart_rateobject
The average heart rate and when
modeltext
The device, such as Move ECG
sample_countnumber
How many samples
sampling_frequencynumber
Samples a second (Hz)
signallist
The signal
signal_idtext
The recording's signal id
wear_positionnumber
Where the device was worn (code)
Example output
{
  "duration_seconds": 0.0,
  "heart_rate": {
    "date": 1793790922,
    "value": 68
  },
  "model": "Move ECG",
  "sample_count": 4,
  "sampling_frequency": 300,
  "signal": [
    12,
    18,
    25,
    31
  ],
  "signal_id": "11873462",
  "wear_position": 1
}

Get goals

Get the person's daily step goal, sleep goal and weight goal.

Inputs

None.

Outputs

sleep_hoursnumber
Sleep a night (hours)
sleep_secondsnumber
Sleep a night (seconds)
stepsnumber
Steps a day
weight_kgnumber
Target weight (kg)
Example output
{
  "sleep_hours": 8.0,
  "sleep_seconds": 28800,
  "steps": 10000,
  "weight_kg": 70.0
}

Get measurements

Read weigh-ins, body composition, blood pressure, heart rate, temperature, SpO2 and other measurements, each as a real number such as weight_kg.

Inputs

Measurementsmeasure_typeslist
Which to read. Leave empty for all of them.One or more of: 1 (Weight (kg)), 4 (Height (m)), 5 (Fat-free mass (kg)), 6 (Fat ratio (%)), 8 (Fat mass (kg)), 9 (Diastolic blood pressure (mmHg)), 10 (Systolic blood pressure (mmHg)), 11 (Heart pulse (bpm)), 12 (Temperature (°C)), 54 (SpO2 (%)), and 33 more.
Measurements or goalsmeasure_categorytext
Read what was measured, or the goals the person set. Defaults to measurements.One of: 1 (Measurements (default)), 2 (Goals the person set).
Fromstartdate and time
Only measurements taken from this moment.
Toenddate and time
Only measurements taken up to this moment.
Changed sincechanged_sincedate and time
Only data added or changed after this moment. Use instead of the dates.
Offsetoffsetnumber
The next_offset an earlier run of this step gave, to read on from there.At least 0.

Outputs

countnumber
How many were returned
groupslist
The measurements, newest last
moretrue/false
Whether Withings has more than this step read
next_offsetnumber
Give this to the same step's Offset to read the rest; 0 when there is none
Example output
{
  "count": 1,
  "groups": [
    {
      "attribution": "Taken by a device",
      "attribution_code": 0,
      "device_id": "a5e0b6f3c2d14e6c9b8a7f6e5d4c3b2a1f0e9d8c",
      "group_id": 5820134971,
      "kind": "measurement",
      "measures": [
        {
          "label": "Weight (kg)",
          "name": "weight_kg",
          "position": null,
          "type": 1,
          "value": 72.35
        },
        {
          "label": "Fat ratio (%)",
          "name": "fat_ratio_percent",
          "position": null,
          "type": 6,
          "value": 18.4
        }
      ],
      "model": "Body+",
      "modified_at": "2026-11-05T06:42:31Z",
      "readings": {
        "fat_ratio_percent": 18.4,
        "weight_kg": 72.35
      },
      "taken_at": "2026-11-05T06:42:10Z",
      "taken_at_unix": 1793860930
    }
  ],
  "more": false,
  "next_offset": 0
}

Get notification

Check a notification subscription for an address and kind of data.

Inputs

Callback URLcallback_urltextRequired
The https:// address Withings sends the notification to.
Notification typenotification_typetext
Which kind of new data. Leave empty for weight and body composition, Withings' default.One of: 1 (Weight and body composition), 2 (Temperature), 4 (Blood pressure and heart rate), 16 (Activity and workouts), 44 (Sleep), 46 (Profile changes), 54 (ECG recordings), 55 (Failed ECG recordings), 58 (Glucose), 61 (Stethoscope recordings), 62 (Heart rate variability), 63 (Urine analysis (U-Scan)).

Outputs

A notification subscription

callback_urltext
Where Withings sends it
commenttext
The comment given when subscribing
notification_nametext
What it notifies about, such as Weight and body composition
notification_typetext
Withings' notification type code, such as 1
Example output
{
  "callback_url": "https://example.com/withings",
  "comment": "",
  "notification_name": "Weight and body composition",
  "notification_type": "1"
}

Get sleep stages

Read a night's sleep stages (awake, light, deep, REM) with heart rate, breathing and snoring through it, for up to 24 hours.

Inputs

Fromstartdate and timeRequired
The start of the window.
Toenddate and time
The end, within 24 hours. Defaults to 24 hours on.
Data to includedata_fieldslist
Which readings to include. Leave empty for all of them.One or more of: hr (Heart rate), rr (Breathing rate), snoring, sdnn_1 (Heart rate variability (SDNN)), rmssd (Heart rate variability (RMSSD)), hrv_quality (Heart rate variability quality), mvt_score (Movement in bed), chest_movement_rate (Chest movement rate), withings_index (Withings index (breathing events)), breathing_sounds (Breathing sounds).

Outputs

countnumber
How many were returned
segmentslist
The night's stages, in order
Example output
{
  "count": 1,
  "segments": [
    {
      "duration_seconds": 1800,
      "enddate": 1793922000,
      "ended_at": "2026-11-05T23:40:00Z",
      "hr": [
        {
          "time": "2026-11-05T23:10:00Z",
          "timestamp": 1793920200,
          "value": 55
        }
      ],
      "model": "Sleep Analyzer",
      "rr": [],
      "snoring": [],
      "startdate": 1793920200,
      "started_at": "2026-11-05T23:10:00Z",
      "state": 2,
      "state_name": "deep"
    }
  ]
}

Get sleep summaries

Read one summary per night: time asleep, deep, light and REM sleep, wake-ups, heart and breathing rates and the sleep score. Defaults to the last 7 days.

Inputs

Fromstart_datedate
The first day. Defaults to 7 days before the last.
Toend_datedate
The last day. Defaults to today.
Changed sincechanged_sincedate and time
Only data added or changed after this moment. Use instead of the dates.

Outputs

countnumber
How many were returned
moretrue/false
Whether Withings has more nights than it returned; choose fewer days to see them
nightslist
One summary per night
Example output
{
  "count": 1,
  "more": false,
  "nights": [
    {
      "data": {
        "deepsleepduration": 5400,
        "hr_average": 58,
        "lightsleepduration": 13692,
        "remsleepduration": 5820,
        "sleep_score": 81,
        "total_sleep_time": 24912,
        "total_timeinbed": 27420,
        "wakeupcount": 2
      },
      "date": "2026-11-06",
      "ended_at": "2026-11-06T06:18:00Z",
      "id": 2418876521,
      "modified_at": "2026-11-06T06:40:00Z",
      "started_at": "2026-11-05T22:41:00Z",
      "timezone": "Europe/Paris",
      "total_sleep_hours": 6.92
    }
  ]
}

Get workouts

Read workouts, such as runs, rides and swims, with their duration, calories, distance and heart rate. Defaults to the last 7 days.

Inputs

Fromstart_datedate
The first day. Defaults to 7 days before the last.
Toend_datedate
The last day. Defaults to today.
Changed sincechanged_sincedate and time
Only data added or changed after this moment. Use instead of the dates.
Offsetoffsetnumber
The next_offset an earlier run of this step gave, to read on from there.At least 0.

Outputs

countnumber
How many were returned
moretrue/false
Whether Withings has more than this step read
next_offsetnumber
Give this to the same step's Offset to read the rest; 0 when there is none
workoutslist
The workouts
Example output
{
  "count": 1,
  "more": false,
  "next_offset": 0,
  "workouts": [
    {
      "category": 2,
      "category_name": "Run",
      "data": {
        "calories": 318,
        "distance": 6120,
        "hr_average": 148,
        "steps": 5904
      },
      "date": "2026-11-05",
      "deviceid": "b7d1c9e2f3a44b5c8d6e7f8091a2b3c4d5e6f708",
      "duration_seconds": 2370,
      "ended_at": "2026-11-05T17:41:30Z",
      "id": 3021987443,
      "modified_at": "2026-11-05T17:45:00Z",
      "started_at": "2026-11-05T17:02:00Z",
      "timezone": "Europe/Paris"
    }
  ]
}

List devices

List the Withings devices linked to the account, with their battery level and when each last synced.

Inputs

None.

Outputs

countnumber
How many were returned
deviceslist
The devices
Example output
{
  "count": 1,
  "devices": [
    {
      "battery": "high",
      "deviceid": "a5e0b6f3c2d14e6c9b8a7f6e5d4c3b2a1f0e9d8c",
      "first_used_at": "2025-01-12T08:00:00Z",
      "last_synced_at": "2026-11-05T06:42:31Z",
      "model": "Body+",
      "model_id": 5,
      "timezone": "Europe/Paris",
      "type": "Scale"
    }
  ]
}

List ECG recordings

List ECG recordings from a ScanWatch, Move ECG or BPM Core, with each one's atrial fibrillation result and heart rate.

Inputs

Fromstartdate and time
Only recordings from this moment.
Toenddate and time
Only recordings up to this moment.
Offsetoffsetnumber
The next_offset an earlier run of this step gave, to read on from there.At least 0.

Outputs

countnumber
How many were returned
moretrue/false
Whether Withings has more than this step read
next_offsetnumber
Give this to the same step's Offset to read the rest; 0 when there is none
recordingslist
The recordings
Example output
{
  "count": 1,
  "more": false,
  "next_offset": 0,
  "recordings": [
    {
      "afib": "Negative",
      "afib_details": "Negative, normal heart rate",
      "device_id": "c2e8f4a6b1d34c7e9f0a1b2c3d4e5f6a7b8c9d0e",
      "diastolic_bp_mmhg": null,
      "heart_rate": 68,
      "model": "Move ECG",
      "modified_at": "2026-11-04T09:16:00Z",
      "recorded_at": "2026-11-04T09:15:22Z",
      "signal_id": 11873462,
      "systolic_bp_mmhg": null,
      "timestamp": 1793790922
    }
  ]
}

List notifications

List the account's notification subscriptions and where each is sent.

Inputs

Notification typenotification_typetext
Only this kind. Leave empty for all.One of: 1 (Weight and body composition), 2 (Temperature), 4 (Blood pressure and heart rate), 16 (Activity and workouts), 44 (Sleep), 46 (Profile changes), 54 (ECG recordings), 55 (Failed ECG recordings), 58 (Glucose), 61 (Stethoscope recordings), 62 (Heart rate variability), 63 (Urine analysis (U-Scan)).

Outputs

countnumber
How many were returned
notificationslist
The subscriptions
Example output
{
  "count": 1,
  "notifications": [
    {
      "callback_url": "https://example.com/withings",
      "comment": "",
      "notification_name": "Weight and body composition",
      "notification_type": "1"
    }
  ]
}

Revoke notification

Stop Withings sending a kind of notification to an address.

Inputs

Callback URLcallback_urltextRequired
The https:// address Withings sends the notification to.
Notification typenotification_typetext
Which kind of new data. Leave empty for weight and body composition, Withings' default.One of: 1 (Weight and body composition), 2 (Temperature), 4 (Blood pressure and heart rate), 16 (Activity and workouts), 44 (Sleep), 46 (Profile changes), 54 (ECG recordings), 55 (Failed ECG recordings), 58 (Glucose), 61 (Stethoscope recordings), 62 (Heart rate variability), 63 (Urine analysis (U-Scan)).

Outputs

callback_urltext
The address
notification_typetext
The notification type code
revokedtrue/false
True once Withings stopped it
Example output
{
  "callback_url": "https://example.com/withings",
  "notification_type": "1",
  "revoked": true
}

Subscribe to notifications

Have Withings send a message to an address of yours whenever new data of a kind arrives. Triggers subscribe by themselves; use this for another system.

Inputs

Callback URLcallback_urltextRequired
The https:// address Withings should send to. It must answer a HEAD request, which Withings sends to check it.
Notification typenotification_typetextRequired
Which kind of new data.One of: 1 (Weight and body composition), 2 (Temperature), 4 (Blood pressure and heart rate), 16 (Activity and workouts), 44 (Sleep), 46 (Profile changes), 54 (ECG recordings), 55 (Failed ECG recordings), 58 (Glucose), 61 (Stethoscope recordings), 62 (Heart rate variability), 63 (Urine analysis (U-Scan)).
Commentcommenttext
A note to remember it by.

Outputs

callback_urltext
Where Withings sends it
commenttext
The comment given when subscribing
notification_nametext
What it notifies about, such as Weight and body composition
notification_typetext
Withings' notification type code, such as 1
subscribedtrue/false
True once Withings accepted it
Example output
{
  "callback_url": "https://example.com/withings",
  "comment": "",
  "notification_name": "Weight and body composition",
  "notification_type": "1",
  "subscribed": true
}

On this page