Connections

Sync recent data now

Waits up to 25 seconds for the service. History keeps importing in the background.

post/integrations/{provider}/sync

Request

  • Base URL: https://bodylab.lol/api/v1
  • URL: https://bodylab.lol/api/v1/integrations/{provider}/sync
  • Auth: HTTP bearer

Path parameters

providerstring required

A connected service. Known values: garmin, oura, apple_health. Treat unknown values as "other".

Headers

X-Client-Platformstring

The native client's platform, e.g. ios. Server-side and non-native callers omit it.

X-Client-Versionstring

The native client's own semver version. With X-Client-Platform, a version below that platform's minimum is refused with CLIENT_UPGRADE_REQUIRED (426).

Response

OK

statusstring required

How a sync run went (running while it's in progress). Known values: running, ok, partial, rate_limited, reauth_required, error. Treat unknown values as "other".

activitiesAddedinteger required
wellnessDaysinteger required
markersWritteninteger required
bodyScansWritteninteger required

Body composition readings recorded or refreshed, which for a scale is the whole of what a sync did.

errorstring

Changes

No recorded changes to this operation across all 1 revision of this API.