Withings

Withings Sleep API

Returns data related to user sleep activities, wether they are captured by an Activity Tracker or a Sleep Monitor. The data are only available once a synchronization occured between the device and Withings servers (which might include synchronizing with Withings mobile application or via Withings Mobile SDK).

GitHub OpenAPI

Operations 2

POST https://wbsapi.withings.net/v2/sleep Sleep v2 - Get #
POST https://wbsapi.withings.net/v2/sleep Sleep v2 - Getsummary #

Documentation

📖
Documentation
https://developer.withings.com/developer-guide/v3/data-api/all-available-health-data/
📖
Authentication
https://developer.withings.com/developer-guide/v3/integration-guide/public-health-data-api/get-access/oauth-web-flow/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/withings/refs/heads/main/openapi/withings-sleep-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/withings/refs/heads/main/json-schema/withings-activity-object.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/withings/refs/heads/main/json-schema/withings-measuregrp-object.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/withings/refs/heads/main/json-schema/withings-measure-object.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/withings/refs/heads/main/json-schema/withings-sleep-summary-object.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/withings/refs/heads/main/json-schema/withings-workout-object.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/withings/refs/heads/main/json-schema/withings-notify-object.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/withings/refs/heads/main/json-schema/withings-user-device-object.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/withings/refs/heads/main/json-schema/withings-heart-measurement-object.json

Other Resources

🔗
Webhooks
https://developer.withings.com/developer-guide/v3/data-api/notifications/notification-overview/
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/withings/refs/heads/main/examples/withings-measure-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/withings/refs/heads/main/examples/withings-sleep-summary-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/withings/refs/heads/main/examples/withings-activity-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/withings/refs/heads/main/examples/withings-oauth2-token-example.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/withings-sleep-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

withings-sleep-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: '2.0'
  title: Withings developer documentation Sleep API
  description: 'Returns data related to user sleep activities, wether they are captured by an Activity Tracker or a Sleep Monitor.


    The data are only available once a synchronization occured between the device and Withings servers (which might include synchronizing with Withings mobile application or via Withings Mobile SDK).'
servers:
- url: https://wbsapi.withings.net/
tags:


# --- truncated at 32 KB (35 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/withings/refs/heads/main/openapi/withings-sleep-api-openapi.yml