Skip to main content
GET
Get Sdk Sync Status

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

X-Open-Wearables-API-Key
string | null

Path Parameters

user_id
string<uuid>
required

Query Parameters

provider
string
required

SDK provider slug, e.g. apple, samsung, health_connect.

Response

Successful Response

Where the server says a user's SDK sync for one provider stands.

The server is the source of truth: a device that lost its local state (e.g. after a logout) reads this to know where to resume from.

provider
string
required

Canonical SDK provider slug.

Example:

"apple"

historicalSyncCompleted
boolean | null
required

Whether a historical export for this provider has finished every data type it covered. False when one exists but has not finished. Null when there is no historical export on record: nothing synced yet, or an SDK version that does not send syncSessionId.

syncedUntil
string<date-time> | null
required

Newest data held from this provider, across all types: where live sync continues from. Null when nothing has been synced yet.

Example:

"2026-11-01T22:15:00Z"

dataTypes
SDKDataTypeSyncState · object[]

Data held per type from this provider. Empty when nothing has been synced yet.