Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

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).

Withings sleep API is one of 18 APIs that Withings publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 8 JSON Schema definitions.

Tagged areas include sleep. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and 8 JSON Schemas.

This API exposes 2 operations across 2 paths, and defines 1 schema. It is described by OpenAPI 3.0.3, at version 2.0.

Requests are made against a single base URL, https://wbsapi.withings.net/.

2 operations 2 paths 1 schemas 2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
2.0
Base URL
https://wbsapi.withings.net
Resource Areas
1

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 POST. Each is listed below with its method, path, parameters, and response codes.

sleep 2

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 betwe…

POST
https://wbsapi.withings.net/v2/sleep
Sleep v2 - Get
sleepv2-get 6 params → 200
POST
https://wbsapi.withings.net/v2/sleep
Sleep v2 - Getsummary
sleepv2-getsummary 6 params → 200

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is sleep_summary_object (12 properties). Each schema is shown below with its type and property counts.

sleep_summary_object
object
12 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

withings-sleep-api-openapi.yml Raw ↑

Other APIs Withings publishes across the network.

Withings Mobile SDK
Withings Advanced Research API
Withings answers API
Withings device API
Withings dropshipment API
Withings heart API
Withings measure API
Withings notify API
Withings nudge API
Withings nudgecampaign API
Withings oauth2 API
Withings order API