Withings website screenshot

Withings

Withings is a connected health device platform providing a REST API for accessing data from smart scales, blood pressure monitors, sleep trackers, thermometers, and fitness watches. The API uses OAuth2 for authentication and provides access to a wide range of health biomarkers including body composition, cardiovascular data, sleep metrics, activity tracking, and clinical-grade measurements. Partners and developers can integrate Withings health data into their applications for remote patient monitoring, wellness platforms, and research applications.

Withings publishes 16 APIs on the APIs.io network, including answers API, device API, dropshipment API, and 13 more. Tagged areas include Health, Wearables, Connected Devices, Body Composition, and Sleep Tracking.

The Withings catalog on APIs.io includes 1 JSON-LD context and 1 Spectral governance ruleset.

Withings’ developer surface includes documentation, API reference, authentication, engineering blog, and 13 more developer resources.

🌐 Visit website 📡 Source on GitHub
43.3/100 developing ▼ -5.2 Agent 39/100 agent ready Full breakdown ↓
scored 2026-07-28 · rubric v0.6
AccessFreemium
18 APIs
HealthWearablesConnected DevicesBody CompositionSleep TrackingBlood PressureActivity TrackingRemote Patient MonitoringOAuth2Webhooks

Kin Score

Kin Score Kin Score How this is scored →
scored 2026-07-28 · rubric v0.6
Composite quality — 43.3/100 · developing
Contract Quality 16.7 / 25
Developer Ergonomics 6.5 / 20
Commercial Clarity 5.8 / 20
Operational Transparency 3.1 / 13
Governance 8.3 / 12
Discoverability 6.9 / 10
Agent readiness — 39/100 · agent ready
Machine-Readable Contract 18 / 18
Agentic Access Contract 10 / 10
MCP Server 0 / 12
Machine-Readable Auth 10 / 10
Idempotency 0 / 9
Stable Error Semantics 0 / 8
Request/Response Examples 7 / 7
Rate-Limit Signaling 7 / 7
Typed Event Surface 6 / 6
Agent Skills 0 / 5
Well-Known Catalog 0 / 4
Consent & Bot Identity 0 / 3
A2A Agent Card 0 / 8
Dry-Run / Simulate Mode 0 / 4
Improve this rating by publishing the missing artifacts — every area above can be raised, and the full rubric is at apis.io/rating/. This rating is computed from github.com/api-evangelist/withings: open an issue to ask a question, or submit a pull request to add artifacts. Want it done for you? Prioritized profiling — $2,500 →

APIs 18

Individual APIs this provider publishes, each with its own machine-readable definition.

Withings Mobile SDK

The Withings Mobile SDK allows developers to integrate Withings health data directly into iOS and Android mobile applications. The SDK handles device pairing, data synchronizati...

Withings Advanced Research API

The Withings Advanced Research API provides access to detailed and granular health biomarker data for academic and clinical research purposes, including full biomarker packs wit...

Withings answers API

These webservices allows you to get user's answers from surveys

Withings device API

The device API from Withings — 3 operation(s) for device.

Withings dropshipment API

The following services are part of the Logistics APIs. Refer to [this section](/developer-guide/v3/integration-guide/dropship-only/logistics-api/overview-create-order) for more ...

Withings heart API

Returns ECG (EKG) signal points in micro-volt (μV). You can use the [Heart - List](#operation/heartv2-list) service to get the list of ECG records and their corresponding ```sig...

Withings measure API

The following services gives access to several types of Health Data collected by a user. The data are only available once a synchronization occured between the device and Within...

Withings notify API

These services will allow you to be notified when new data is collected by Withings devices, or when specific events happen. Learn more about our notification services in [the d...

Withings nudge API

These webservices allows you to to manage Health Nudges. Read the [Health Nudges Integration Guide](/developer-guide/v3/integration-guide/health-nudges/health-nudge-overview) fo...

Withings nudgecampaign API

These webservices allows you to to manage Health Nudges Campaign. Read the [Health Nudges Integration Guide](/developer-guide/v3/integration-guide/health-nudges/health-nudge-ove...

Withings oauth2 API


The Withings API uses OAuth 2.0, an industry-standard protocol for authorization.
OAuth 2.0 enables your application to access user-specific data with a secure and seaml...

Withings order API

The following services are part of the Logistics APIs. Refer to [this section](/developer-guide/v3/integration-guide/dropship-only/logistics-api/overview-create-order) for more ...

Withings rawdata API

Raw Data webservices are part of the Advanced research API that allows to collect high frequency PPG and accelerometer data (around 25Hz). These APIs are compatible only with th...

Withings signature API

The following services are part of the Logistics APIs. Refer to [this section](/developer-guide/v3/integration-guide/dropship-only/logistics-api/overview-create-order) for more ...

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

Withings stetho API

First the [Stetho - List](#operation/stethov2-list) API should be called to fetch the stetho signalIds which should be fetched individually using the [Stetho - Get](#operation/s...

Withings survey API

These webservices allows you to to manage user's surveys

Withings user API

The user API from Withings — 7 operation(s) for user.

Scroll for all 18

GraphQL 1

GraphQL schemas published by this provider.

Withings GraphQL Schema

This conceptual GraphQL schema models the Withings health platform API, which provides access to data from Withings connected health devices including smart scales, blood pressu...

GRAPHQL

Pricing Plans 1

Published pricing tiers and plan structures.

Withings Plans Pricing

2 plans

PLANS

Rate Limits 1

Documented rate limits and quota policies.

Withings Rate Limits

0 limits

RATE LIMITS

FinOps 1

Cost, billing, and metering signals for API financial operations.

Withings Finops

FINOPS

Semantic Vocabularies 1

JSON-LD contexts and semantic vocabularies used across these APIs.

Withings Context

0 classes · 65 properties

JSON-LD

Spectral Rules 1

Spectral governance rulesets for linting and validating these APIs.

Withings API Rules

5 rules · 4 warnings 1 info

SPECTRAL

JSON Schema 8

Standalone JSON Schema definitions for this provider's data models.

Activity Object

25 properties

JSON SCHEMA

Heart Measurement Object

8 properties

JSON SCHEMA

Measure Object

6 properties

JSON SCHEMA

Measuregrp Object

12 properties

JSON SCHEMA

Notify Object

3 properties

JSON SCHEMA

Sleep Summary Object

12 properties

JSON SCHEMA

User Device Object

14 properties

JSON SCHEMA

Workout Object

11 properties

JSON SCHEMA

Scroll for all 8

Examples 4

Example request and response payloads for these APIs.

Withings Activity Example

3 fields

EXAMPLE

Withings Measure Example

3 fields

EXAMPLE

Withings Oauth2 Token Example

3 fields

EXAMPLE

Withings Sleep Summary Example

3 fields

EXAMPLE

Security Posture 1

Authentication, domain security, vulnerability disclosure, and trust-center signals.

Withings Domain Security

TLSv1.3 · HSTS · DMARC

SECURITY

Agentic Access 1

Recommended x-agentic-access execution contracts for AI agents.

Withings Agentic Access

62 operations · 61 acting · 3 human-in-the-loop

62 operations · 61 acting

AGENTIC

Resources

Documentation 2

Reference material describing how the API behaves

Documentation
Documentation
 APIReference
APIReference

Agent Surfaces 1

MCP servers, agent skills, and machine-readable catalogs

AgenticAccess
AgenticAccess

Design & Contract 3

Pagination, idempotency, versioning, errors, and events

Webhooks
Webhooks
 Vocabulary
Vocabulary
 JSONLDContext
JSONLDContext

Build 1

SDKs, sample code, and the tooling you integrate with

Postman
Postman

Access & Security 2

Authentication, authorization, and security posture

DomainSecurity
DomainSecurity
 Authentication
Authentication

Operate 2

Status, limits, changes, and where to get help

StatusPage
StatusPage
 RateLimits
RateLimits

Commercial 2

Pricing, plans, and the legal terms of use

Plans
Plans
 FinOps
FinOps

Company 3

The organization behind the API

Website
Website
 LinkedIn
LinkedIn
 Blog
Blog

Other 1

Properties that don't map to a standard resource type

X
X

Source (apis.yml)

apis.yml Raw ↑ 
aid: withings
name: Withings
description: Withings is a connected health device platform providing a REST API for accessing data from smart scales, blood
  pressure monitors, sleep trackers, thermometers, and fitness watches. The API uses OAuth2 for authentication and provides
  access to a wide range of health biomarkers including body composition, cardiovascular data, sleep metrics, activity tracking,
  and clinical-grade measurements. Partners and developers can integrate Withings health data into their applications for
  remote patient monitoring, wellness platforms, and research applications.
type: Index
accessModel:
  pricing: freemium
  onboarding: unknown
  trial: false
  try_now: false
  public: false
  label: Freemium
  confidence: medium
  source:
  - plans
  generated: '2026-07-22'
  method: derived
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/icons/withings.png
url: https://raw.githubusercontent.com/api-evangelist/withings/refs/heads/main/apis.yml
created: '2026-06-13'
modified: '2026-06-13'
specificationVersion: '0.19'
tags:
- Health
- Wearables
- Connected Devices
- Body Composition
- Sleep Tracking
- Blood Pressure
- Activity Tracking
- Remote Patient Monitoring
- OAuth2
- Webhooks
apis:
- name: Withings Mobile SDK
  description: The Withings Mobile SDK allows developers to integrate Withings health data directly into iOS and Android mobile
    applications. The SDK handles device pairing, data synchronization, and health metric collection with native implementations
    for both platforms.
  image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
  humanURL: https://developer.withings.com/developer-guide/v3/integration-guide/sdk-integration-guides/
  baseURL: https://developer.withings.com
  tags:
  - Mobile SDK
  - iOS
  - Android
  - Health Data
  properties:
  - type: Documentation
    url: https://developer.withings.com/developer-guide/v3/integration-guide/sdk-integration-guides/
  - type: iOSResources
    url: https://developer.withings.com/sdk/v2/tree/sources/ios/
  - type: AndroidResources
    url: https://developer.withings.com/sdk/v2/tree/sources/android/
- name: Withings Advanced Research API
  description: The Withings Advanced Research API provides access to detailed and granular health biomarker data for academic
    and clinical research purposes, including full biomarker packs with extended data sets beyond the standard API offering.
  image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
  humanURL: https://developer.withings.com/developer-guide/v3/withings-solutions/withings-api-plans/
  baseURL: https://wbsapi.withings.net
  tags:
  - Research
  - Biomarkers
  - Clinical Data
  - Health Analytics
  properties:
  - type: Documentation
    url: https://developer.withings.com/developer-guide/v3/withings-solutions/withings-api-plans/
- aid: withings:withings-answers-api
  name: Withings answers API
  description: These webservices allows you to get user's answers from surveys
  humanURL: https://developer.withings.com/
  baseURL: https://wbsapi.withings.net
  tags:
  - answers
  properties:
  - type: OpenAPI
    url: openapi/withings-answers-api-openapi.yml
  - type: Documentation
    url: https://developer.withings.com/developer-guide/v3/data-api/all-available-health-data/
  - type: Authentication
    url: https://developer.withings.com/developer-guide/v3/integration-guide/public-health-data-api/get-access/oauth-web-flow/
  - type: Webhooks
    url: https://developer.withings.com/developer-guide/v3/data-api/notifications/notification-overview/
  - type: JSONSchema
    url: json-schema/withings-activity-object.json
  - type: JSONSchema
    url: json-schema/withings-measuregrp-object.json
  - type: JSONSchema
    url: json-schema/withings-measure-object.json
  - type: JSONSchema
    url: json-schema/withings-sleep-summary-object.json
  - type: JSONSchema
    url: json-schema/withings-workout-object.json
  - type: JSONSchema
    url: json-schema/withings-notify-object.json
  - type: JSONSchema
    url: json-schema/withings-user-device-object.json
  - type: JSONSchema
    url: json-schema/withings-heart-measurement-object.json
  - type: Examples
    url: examples/withings-measure-example.json
  - type: Examples
    url: examples/withings-sleep-summary-example.json
  - type: Examples
    url: examples/withings-activity-example.json
  - type: Examples
    url: examples/withings-oauth2-token-example.json
  - type: GraphQL
    url: graphql/withings-graphql.md
- aid: withings:withings-device-api
  name: Withings device API
  description: The device API from Withings — 3 operation(s) for device.
  humanURL: https://developer.withings.com/
  baseURL: https://wbsapi.withings.net
  tags:
  - device
  properties:
  - type: OpenAPI
    url: openapi/withings-device-api-openapi.yml
  - type: Documentation
    url: https://developer.withings.com/developer-guide/v3/data-api/all-available-health-data/
  - type: Authentication
    url: https://developer.withings.com/developer-guide/v3/integration-guide/public-health-data-api/get-access/oauth-web-flow/
  - type: Webhooks
    url: https://developer.withings.com/developer-guide/v3/data-api/notifications/notification-overview/
  - type: JSONSchema
    url: json-schema/withings-activity-object.json
  - type: JSONSchema
    url: json-schema/withings-measuregrp-object.json
  - type: JSONSchema
    url: json-schema/withings-measure-object.json
  - type: JSONSchema
    url: json-schema/withings-sleep-summary-object.json
  - type: JSONSchema
    url: json-schema/withings-workout-object.json
  - type: JSONSchema
    url: json-schema/withings-notify-object.json
  - type: JSONSchema
    url: json-schema/withings-user-device-object.json
  - type: JSONSchema
    url: json-schema/withings-heart-measurement-object.json
  - type: Examples
    url: examples/withings-measure-example.json
  - type: Examples
    url: examples/withings-sleep-summary-example.json
  - type: Examples
    url: examples/withings-activity-example.json
  - type: Examples
    url: examples/withings-oauth2-token-example.json
  - type: GraphQL
    url: graphql/withings-graphql.md
- aid: withings:withings-dropshipment-api
  name: Withings dropshipment API
  description: 'The following services are part of the Logistics APIs. Refer to [this section](/developer-guide/v3/integration-guide/dropship-only/logistics-api/overview-create-order)
    for more information.


    The Logistics APIs allows partners to dropship devices directly to their program members.


    **Important**: To receive automatic notification on order status, please fill a dropshipment notify URI for your API application
    in your [Developer Dashboard](https://developer.withings.com/dashboard/).'
  humanURL: https://developer.withings.com/
  baseURL: https://wbsapi.withings.net
  tags:
  - dropshipment
  properties:
  - type: OpenAPI
    url: openapi/withings-dropshipment-api-openapi.yml
  - type: Documentation
    url: https://developer.withings.com/developer-guide/v3/data-api/all-available-health-data/
  - type: Authentication
    url: https://developer.withings.com/developer-guide/v3/integration-guide/public-health-data-api/get-access/oauth-web-flow/
  - type: Webhooks
    url: https://developer.withings.com/developer-guide/v3/data-api/notifications/notification-overview/
  - type: JSONSchema
    url: json-schema/withings-activity-object.json
  - type: JSONSchema
    url: json-schema/withings-measuregrp-object.json
  - type: JSONSchema
    url: json-schema/withings-measure-object.json
  - type: JSONSchema
    url: json-schema/withings-sleep-summary-object.json
  - type: JSONSchema
    url: json-schema/withings-workout-object.json
  - type: JSONSchema
    url: json-schema/withings-notify-object.json
  - type: JSONSchema
    url: json-schema/withings-user-device-object.json
  - type: JSONSchema
    url: json-schema/withings-heart-measurement-object.json
  - type: Examples
    url: examples/withings-measure-example.json
  - type: Examples
    url: examples/withings-sleep-summary-example.json
  - type: Examples
    url: examples/withings-activity-example.json
  - type: Examples
    url: examples/withings-oauth2-token-example.json
  - type: GraphQL
    url: graphql/withings-graphql.md
- aid: withings:withings-heart-api
  name: Withings heart API
  description: 'Returns ECG (EKG) signal points in micro-volt (μV).


    You can use the [Heart - List](#operation/heartv2-list) service to get the list of ECG records and their corresponding
    ```signalid``` and then use [Heart - Get](#operation/heartv2-get) to get the signal details.


    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).'
  humanURL: https://developer.withings.com/
  baseURL: https://wbsapi.withings.net
  tags:
  - heart
  properties:
  - type: OpenAPI
    url: openapi/withings-heart-api-openapi.yml
  - type: Documentation
    url: https://developer.withings.com/developer-guide/v3/data-api/all-available-health-data/
  - type: Authentication
    url: https://developer.withings.com/developer-guide/v3/integration-guide/public-health-data-api/get-access/oauth-web-flow/
  - type: Webhooks
    url: https://developer.withings.com/developer-guide/v3/data-api/notifications/notification-overview/
  - type: JSONSchema
    url: json-schema/withings-activity-object.json
  - type: JSONSchema
    url: json-schema/withings-measuregrp-object.json
  - type: JSONSchema
    url: json-schema/withings-measure-object.json
  - type: JSONSchema
    url: json-schema/withings-sleep-summary-object.json
  - type: JSONSchema
    url: json-schema/withings-workout-object.json
  - type: JSONSchema
    url: json-schema/withings-notify-object.json
  - type: JSONSchema
    url: json-schema/withings-user-device-object.json
  - type: JSONSchema
    url: json-schema/withings-heart-measurement-object.json
  - type: Examples
    url: examples/withings-measure-example.json
  - type: Examples
    url: examples/withings-sleep-summary-example.json
  - type: Examples
    url: examples/withings-activity-example.json
  - type: Examples
    url: examples/withings-oauth2-token-example.json
  - type: GraphQL
    url: graphql/withings-graphql.md
- aid: withings:withings-measure-api
  name: Withings measure API
  description: The following services gives access to several types of Health Data collected by a user. 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).
  humanURL: https://developer.withings.com/
  baseURL: https://wbsapi.withings.net
  tags:
  - measure
  properties:
  - type: OpenAPI
    url: openapi/withings-measure-api-openapi.yml
  - type: Documentation
    url: https://developer.withings.com/developer-guide/v3/data-api/all-available-health-data/
  - type: Authentication
    url: https://developer.withings.com/developer-guide/v3/integration-guide/public-health-data-api/get-access/oauth-web-flow/
  - type: Webhooks
    url: https://developer.withings.com/developer-guide/v3/data-api/notifications/notification-overview/
  - type: JSONSchema
    url: json-schema/withings-activity-object.json
  - type: JSONSchema
    url: json-schema/withings-measuregrp-object.json
  - type: JSONSchema
    url: json-schema/withings-measure-object.json
  - type: JSONSchema
    url: json-schema/withings-sleep-summary-object.json
  - type: JSONSchema
    url: json-schema/withings-workout-object.json
  - type: JSONSchema
    url: json-schema/withings-notify-object.json
  - type: JSONSchema
    url: json-schema/withings-user-device-object.json
  - type: JSONSchema
    url: json-schema/withings-heart-measurement-object.json
  - type: Examples
    url: examples/withings-measure-example.json
  - type: Examples
    url: examples/withings-sleep-summary-example.json
  - type: Examples
    url: examples/withings-activity-example.json
  - type: Examples
    url: examples/withings-oauth2-token-example.json
  - type: GraphQL
    url: graphql/withings-graphql.md
- aid: withings:withings-notify-api
  name: Withings notify API
  description: "These services will allow you to be notified when new data is collected by Withings devices, or when specific\
    \ events happen.\n\t\tLearn more about our notification services in [the dedicated section](/developer-guide/v3/data-api/notifications/notification-overview/)"
  humanURL: https://developer.withings.com/
  baseURL: https://wbsapi.withings.net
  tags:
  - notify
  properties:
  - type: OpenAPI
    url: openapi/withings-notify-api-openapi.yml
  - type: Documentation
    url: https://developer.withings.com/developer-guide/v3/data-api/all-available-health-data/
  - type: Authentication
    url: https://developer.withings.com/developer-guide/v3/integration-guide/public-health-data-api/get-access/oauth-web-flow/
  - type: Webhooks
    url: https://developer.withings.com/developer-guide/v3/data-api/notifications/notification-overview/
  - type: JSONSchema
    url: json-schema/withings-activity-object.json
  - type: JSONSchema
    url: json-schema/withings-measuregrp-object.json
  - type: JSONSchema
    url: json-schema/withings-measure-object.json
  - type: JSONSchema
    url: json-schema/withings-sleep-summary-object.json
  - type: JSONSchema
    url: json-schema/withings-workout-object.json
  - type: JSONSchema
    url: json-schema/withings-notify-object.json
  - type: JSONSchema
    url: json-schema/withings-user-device-object.json
  - type: JSONSchema
    url: json-schema/withings-heart-measurement-object.json
  - type: Examples
    url: examples/withings-measure-example.json
  - type: Examples
    url: examples/withings-sleep-summary-example.json
  - type: Examples
    url: examples/withings-activity-example.json
  - type: Examples
    url: examples/withings-oauth2-token-example.json
  - type: GraphQL
    url: graphql/withings-graphql.md
- aid: withings:withings-nudge-api
  name: Withings nudge API
  description: These webservices allows you to to manage Health Nudges. Read the [Health Nudges Integration Guide](/developer-guide/v3/integration-guide/health-nudges/health-nudge-overview)
    for more information.
  humanURL: https://developer.withings.com/
  baseURL: https://wbsapi.withings.net
  tags:
  - nudge
  properties:
  - type: OpenAPI
    url: openapi/withings-nudge-api-openapi.yml
  - type: Documentation
    url: https://developer.withings.com/developer-guide/v3/data-api/all-available-health-data/
  - type: Authentication
    url: https://developer.withings.com/developer-guide/v3/integration-guide/public-health-data-api/get-access/oauth-web-flow/
  - type: Webhooks
    url: https://developer.withings.com/developer-guide/v3/data-api/notifications/notification-overview/
  - type: JSONSchema
    url: json-schema/withings-activity-object.json
  - type: JSONSchema
    url: json-schema/withings-measuregrp-object.json
  - type: JSONSchema
    url: json-schema/withings-measure-object.json
  - type: JSONSchema
    url: json-schema/withings-sleep-summary-object.json
  - type: JSONSchema
    url: json-schema/withings-workout-object.json
  - type: JSONSchema
    url: json-schema/withings-notify-object.json
  - type: JSONSchema
    url: json-schema/withings-user-device-object.json
  - type: JSONSchema
    url: json-schema/withings-heart-measurement-object.json
  - type: Examples
    url: examples/withings-measure-example.json
  - type: Examples
    url: examples/withings-sleep-summary-example.json
  - type: Examples
    url: examples/withings-activity-example.json
  - type: Examples
    url: examples/withings-oauth2-token-example.json
  - type: GraphQL
    url: graphql/withings-graphql.md
- aid: withings:withings-nudgecampaign-api
  name: Withings nudgecampaign API
  description: These webservices allows you to to manage Health Nudges Campaign. Read the [Health Nudges Integration Guide](/developer-guide/v3/integration-guide/health-nudges/health-nudge-overview)
    for more information.
  humanURL: https://developer.withings.com/
  baseURL: https://wbsapi.withings.net
  tags:
  - nudgecampaign
  properties:
  - type: OpenAPI
    url: openapi/withings-nudgecampaign-api-openapi.yml
  - type: Documentation
    url: https://developer.withings.com/developer-guide/v3/data-api/all-available-health-data/
  - type: Authentication
    url: https://developer.withings.com/developer-guide/v3/integration-guide/public-health-data-api/get-access/oauth-web-flow/
  - type: Webhooks
    url: https://developer.withings.com/developer-guide/v3/data-api/notifications/notification-overview/
  - type: JSONSchema
    url: json-schema/withings-activity-object.json
  - type: JSONSchema
    url: json-schema/withings-measuregrp-object.json
  - type: JSONSchema
    url: json-schema/withings-measure-object.json
  - type: JSONSchema
    url: json-schema/withings-sleep-summary-object.json
  - type: JSONSchema
    url: json-schema/withings-workout-object.json
  - type: JSONSchema
    url: json-schema/withings-notify-object.json
  - type: JSONSchema
    url: json-schema/withings-user-device-object.json
  - type: JSONSchema
    url: json-schema/withings-heart-measurement-object.json
  - type: Examples
    url: examples/withings-measure-example.json
  - type: Examples
    url: examples/withings-sleep-summary-example.json
  - type: Examples
    url: examples/withings-activity-example.json
  - type: Examples
    url: examples/withings-oauth2-token-example.json
  - type: GraphQL
    url: graphql/withings-graphql.md
- aid: withings:withings-oauth2-api
  name: Withings oauth2 API
  description: "<br>The Withings API uses OAuth 2.0, an industry-standard protocol for authorization.<br> OAuth 2.0 enables\
    \ your application to access user-specific data with a secure and seamless way without requiring users to share their\
    \ Withings credentials with your app.<br>\n                  <br>\n                  The Withings API supports the Authorization\
    \ Code Flow, which is suitable for server-side\napplications. In this flow, your application will obtain an authorization\
    \ code from the user, which can then be exchanged for an access token and refresh token.\n                  <br><br>\n\
    \                  There are two ways to obtain the authorization code:<br>\n                  <br>\n                \
    \  1. **Web Authorization Flow**: Redirect the user to the Withings authorization endpoint,\nwhere they can grant permission\
    \ for your app to access their Withings data.<br>\n                  2. **Account Creation Flow (contract partners only)**:\
    \ Obtain the authorization\ncode after account creation (Cellular Devices/SDK only) .<br>\n                  <br>\n  \
    \                To use OAuth 2.0 with the Withings API, follow these general steps:<br>\n                  <br>\n   \
    \               1. **Request user authorization/Create an account**: Use one of the two methods\nmentioned above to obtain\
    \ an authorization code from the user.<br>\n                  2. **Obtain an access token**: Exchange the authorization\
    \ code for an access token\nand refresh token.<br>\n                  3. **Access the API**: Include the access token\
    \ in your API requests to access user-specific\ndata from the Withings API.<br>\n                  4. **Refresh tokens**:\
    \ Use the refresh token to obtain new access tokens when the\ncurrent ones expire.<br>\n                  <br>\n     \
    \             Please refer to the appropriate [Integration Guide](https://developer.withings.com/developer-guide/v3/withings-solutions/integration-guides)\n\
    to know which method you should use."
  humanURL: https://developer.withings.com/
  baseURL: https://wbsapi.withings.net
  tags:
  - oauth2
  properties:
  - type: OpenAPI
    url: openapi/withings-oauth2-api-openapi.yml
  - type: Documentation
    url: https://developer.withings.com/developer-guide/v3/data-api/all-available-health-data/
  - type: Authentication
    url: https://developer.withings.com/developer-guide/v3/integration-guide/public-health-data-api/get-access/oauth-web-flow/
  - type: Webhooks
    url: https://developer.withings.com/developer-guide/v3/data-api/notifications/notification-overview/
  - type: JSONSchema
    url: json-schema/withings-activity-object.json
  - type: JSONSchema
    url: json-schema/withings-measuregrp-object.json
  - type: JSONSchema
    url: json-schema/withings-measure-object.json
  - type: JSONSchema
    url: json-schema/withings-sleep-summary-object.json
  - type: JSONSchema
    url: json-schema/withings-workout-object.json
  - type: JSONSchema
    url: json-schema/withings-notify-object.json
  - type: JSONSchema
    url: json-schema/withings-user-device-object.json
  - type: JSONSchema
    url: json-schema/withings-heart-measurement-object.json
  - type: Examples
    url: examples/withings-measure-example.json
  - type: Examples
    url: examples/withings-sleep-summary-example.json
  - type: Examples
    url: examples/withings-activity-example.json
  - type: Examples
    url: examples/withings-oauth2-token-example.json
  - type: GraphQL
    url: graphql/withings-graphql.md
- aid: withings:withings-order-api
  name: Withings order API
  description: The following services are part of the Logistics APIs. Refer to [this section](/developer-guide/v3/integration-guide/dropship-only/logistics-api/overview-create-order)
    for more information.
  humanURL: https://developer.withings.com/
  baseURL: https://wbsapi.withings.net
  tags:
  - order
  properties:
  - type: OpenAPI
    url: openapi/withings-order-api-openapi.yml
  - type: Documentation
    url: https://developer.withings.com/developer-guide/v3/data-api/all-available-health-data/
  - type: Authentication
    url: https://developer.withings.com/developer-guide/v3/integration-guide/public-health-data-api/get-access/oauth-web-flow/
  - type: Webhooks
    url: https://developer.withings.com/developer-guide/v3/data-api/notifications/notification-overview/
  - type: JSONSchema
    url: json-schema/withings-activity-object.json
  - type: JSONSchema
    url: json-schema/withings-measuregrp-object.json
  - type: JSONSchema
    url: json-schema/withings-measure-object.json
  - type: JSONSchema
    url: json-schema/withings-sleep-summary-object.json
  - type: JSONSchema
    url: json-schema/withings-workout-object.json
  - type: JSONSchema
    url: json-schema/withings-notify-object.json
  - type: JSONSchema
    url: json-schema/withings-user-device-object.json
  - type: JSONSchema
    url: json-schema/withings-heart-measurement-object.json
  - type: Examples
    url: examples/withings-measure-example.json
  - type: Examples
    url: examples/withings-sleep-summary-example.json
  - type: Examples
    url: examples/withings-activity-example.json
  - type: Examples
    url: examples/withings-oauth2-token-example.json
  - type: GraphQL
    url: graphql/withings-graphql.md
- aid: withings:withings-rawdata-api
  name: Withings rawdata API
  description: Raw Data webservices are part of the Advanced research API that allows to collect high frequency PPG and accelerometer
    data (around 25Hz). These APIs are compatible only with the Withings ScanWatch. If you need more information about how
    to use these APIs and how to parse the data, please have a look the [dedicated integration guide](/developer-guide/v3/integration-guide/public-health-data-api/data-api/raw-data).
  humanURL: https://developer.withings.com/
  baseURL: https://wbsapi.withings.net
  tags:
  - rawdata
  properties:
  - type: OpenAPI
    url: openapi/withings-rawdata-api-openapi.yml
  - type: Documentation
    url: https://developer.withings.com/developer-guide/v3/data-api/all-available-health-data/
  - type: Authentication
    url: https://developer.withings.com/developer-guide/v3/integration-guide/public-health-data-api/get-access/oauth-web-flow/
  - type: Webhooks
    url: https://developer.withings.com/developer-guide/v3/data-api/notifications/notification-overview/
  - type: JSONSchema
    url: json-schema/withings-activity-object.json
  - type: JSONSchema
    url: json-schema/withings-measuregrp-object.json
  - type: JSONSchema
    url: json-schema/withings-measure-object.json
  - type: JSONSchema
    url: json-schema/withings-sleep-summary-object.json
  - type: JSONSchema
    url: json-schema/withings-workout-object.json
  - type: JSONSchema
    url: json-schema/withings-notify-object.json
  - type: JSONSchema
    url: json-schema/withings-user-device-object.json
  - type: JSONSchema
    url: json-schema/withings-heart-measurement-object.json
  - type: Examples
    url: examples/withings-measure-example.json
  - type: Examples
    url: examples/withings-sleep-summary-example.json
  - type: Examples
    url: examples/withings-activity-example.json
  - type: Examples
    url: examples/withings-oauth2-token-example.json
  - type: GraphQL
    url: graphql/withings-graphql.md
- aid: withings:withings-signature-api
  name: Withings signature API
  description: The following services are part of the Logistics APIs. Refer to [this section](/developer-guide/v3/integration-guide/dropship-only/logistics-api/overview-create-order)
    for more information.
  humanURL: https://developer.withings.com/
  baseURL: https://wbsapi.withings.net
  tags:
  - signature
  properties:
  - type: OpenAPI
    url: openapi/withings-signature-api-openapi.yml
  - type: Documentation
    url: https://developer.withings.com/developer-guide/v3/data-api/all-available-health-data/
  - type: Authentication
    url: https://developer.withings.com/developer-guide/v3/integration-guide/public-health-data-api/get-access/oauth-web-flow/
  - type: Webhooks
    url: https://developer.withings.com/developer-guide/v3/data-api/notifications/notification-overview/
  - type: JSONSchema
    url: json-schema/withings-activity-object.json
  - type: JSONSchema
    url: json-schema/withings-measuregrp-object.json
  - type: JSONSchema
    url: json-schema/withings-measure-object.json
  - type: JSONSchema
    url: json-schema/withings-sleep-summary-object.json
  - type: JSONSchema
    url: json-schema/withings-workout-object.json
  - type: JSONSchema
    url: json-schema/withings-notify-object.json
  - type: JSONSchema
    url: json-schema/withings-user-device-object.json
  - type: JSONSchema
    url: json-schema/withings-heart-measurement-object.json
  - type: Examples
    url: examples/withings-measure-example.json
  - type: Examples
    url: examples/withings-sleep-summary-example.json
  - type: Examples
    url: examples/withings-activity-example.json
  - type: Examples
    url: examples/withings-oauth2-token-example.json
  - type: GraphQL
    url: graphql/withings-graphql.md
- aid: withings:withings-sleep-api
  name: Withings 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).'
  humanURL: https://developer.withings.com/
  baseURL: https://wbsapi.withings.net
  tags:
  - sleep
  properties:
  - type: OpenAPI
    url: openapi/withings-sleep-api-openapi.yml
  - type: Documentation
    url: https://developer.withings.com/developer-guide/v3/data-api/all-available-health-data/
  - type: Authentication
    url: https://developer.withings.com/developer-guide/v3/integration-guide/public-health-data-api/get-access/oauth-web-flow/
  - type: Webhooks
    url: https://developer.withings.com/developer-guide/v3/data-api/notifications/notification-overview/
  - type: JSONSchema
    url: json-schema/withings-activity-object.json
  - type: JSONSchema
    url: json-schema/withings-measuregrp-object.json
  - type: JSONSchema
    url: json-schema/withings-measure-object.json
  - type: JSONSchema
    url: json-schema/withings-sleep-summary-object.json
  - type: JSONSchema
    url: json-schema/withings-workout-object.json
  - type: JSONSchema
    url: json-schema/withings-notify-object.json
  - type: JSONSchema
    url: json-schema/withings-user-device-object.json
  - type: JSONSchema
    url: json-schema/withings-heart-measurement-object.json
  - type: Examples
    url: examples/withings-measure-example.json
  - type: Examples
    url: examples/withings-sleep-summary-example.json
  - type: Examples
    url: examples/withings-activity-example.json
  - type: Examples
    url: examples/withings-oauth2-token-example.json
  - type: GraphQL
    url: graphql/withings-graphql.md
- aid: withings:withings-stetho-api
  name: Withings stetho API
  description: First the [Stetho - List](#operation/stethov2-list) API should be called to fetch the stetho signalIds which
    should be fetched individually using the [Stetho - Get](#operation/stethov2-get) API.
  humanURL: https://developer.withings.com/
  baseURL: https://wbsapi.withings.net
  tags:
  - stetho
  properties:
  - type: OpenAPI
    url: openapi/withings-stetho-api-openapi.yml
  - type: Documentation
    url: https://developer.withings.com/developer-guide/v3/data-api/all-available-health-data/
  - type: Authentication
    url: https://developer.withings.com/developer-guide/v3/integration-guide/public-health-data-api/get-access/oauth-web-flow/
  - type: Webhooks
    url: https://developer.withings.com/developer-guide/v3/data-api/notifications/notification-overview/
  - type: JSONSchema
    url: json-schema/withings-activity-object.json
  - type: JSONSchema
    url: json-schema/withings-measuregrp-object.json
  - type: JSONSchema
    url: json-schema/withings-measure-object.json
  - type: JSONSchema
    url: json-schema/withings-sleep-summary-object.json
  - type: JSONSchema
    url: json-schema/withings-workout-object.json
  - type: JSONSchema
    url: json-schema/withings-notify-object.json
  - type: JSONSchema
    url: json-schema/withings-user-device-object.json
  - type: JSONSchema
    url: json-schema/withings-heart-measurement-object.json
  - type: Examples
    url: examples/withings-measure-example.json
  - type: Examples
    url: examples/withings-sleep-summary-example.json
  - type: Examples
    url: examples/withings-activity-example.json
  - type: Examples
    url: examples/withings-oauth2-token-example.json
  - type: GraphQL
    url: graphql/withings-graphql.md
- aid: withings:withings-survey-api
  name: Withings survey API
  description: These webservices allows you to to manage user's surveys
  humanURL: https://developer.withings.com/
  baseURL: https://wbsapi.withings.net
  tags:
  - survey
  properties:
  - type: OpenAPI
    url: openapi/withings-survey-api-openapi.yml
  - type: Documentation
    url: https://developer.withings.com/developer-guide/v3/data-api/all-available-health-data/
  - type: Authentication
    url: https://developer.withings.com/developer-guide/v3/integration-guide/public-health-data-api/get-access/oauth-web-flow/
  - type: Webhooks
    url: https://developer.withings.com/developer-guide/v3/data-api/notifications/notification-overview/
  - type: JSONSchema
    url: json-schema/withings-activity-object.json
  - type: JSONSchema
    url: json-schema/withings-measuregrp-object.json
  - type: JSONSchema
    url: json-schema/withings-measure-object.json
  - type: JSONSchema
    url: json-schema/withings-sleep-summary-object.json
  - type: JSONSchema
    url: json-schema/withings-workout-object.json
  - type: JSONSchema
    url: json-schema/withings-notify-object.json
  - type: JSONSchema
    url: json-schema/withings-user-device-object.json
  - type: JSONSchema
    url: json-schema/withings-heart-measurement-object.json
  - type: Examples
    url: examples/withings-measure-example.json
  - type: Examples
    url: examples/withings-sleep-summary-example.json
  - type: Examples
    url: examples/withings-activity-example.json
  - type: Examples
    url: examples/withings-oauth2-token-example.json
  - type: GraphQL
    url: graphql/withings-graphql.md
- aid: withings:withings-user-api
  name: Withings user API
  description: The user API from Withings — 7 operation(s) for user.
  humanURL: https://developer.withings.com/
  baseURL: https://wbsapi.withings.net
  tags:
  - user
  properties:
  - type: OpenAPI
    url: openapi/withings-user-api-openapi.yml
  - type: Documentation
    url: https://developer.withings.com/developer-guide/v3/data-api/all-available-health-data/
  - type: Authentication
    url: https://developer.withings.com/developer-guide

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