Sign in

v3

latestOpenAPI 3.1.02026-07-31121144224.9 KB
External: Sync Status

List Recent Sync Events

Return the most recent stored sync events (newest first).

Events are kept in Redis for 24 h. Use this to seed the UI before opening the SSE stream, or to inspect history without subscribing.

get/api/v1/users/{user_id}/sync/recent

Path parameters

user_idstring uuid required

Query parameters

limitinteger

Headers

X-Open-Wearables-API-Keystring nullable

Response

Successful Response

event_idstring uuid

Unique ID for this event.

run_idstring required

Identifier shared by all events of the same sync run.

user_idstring uuid required
providerstring required

Provider slug (e.g. 'garmin', 'apple', 'whoop').

source'pull' | 'webhook' | 'sdk' | 'backfill' | 'xml_import' | 'linked_account' required

How the sync was initiated / what transport delivers data.

stage'queued' | 'started' | 'fetching' | 'processing' | 'saving' | 'completed' | 'failed' | 'cancelled' required

Coarse-grained stage label for a sync run.

status'in_progress' | 'success' | 'partial' | 'failed' | 'cancelled' | 'skipped' required

Overall outcome state for the run.

messagestring nullable
progressnumber nullable

Optional 0..1 progress.

items_processedinteger nullable
items_totalinteger nullable
errorstring nullable
primary_user_idstring uuid nullable

For LINKED_ACCOUNT events: the OW user whose sync run produced this data.

metadataobject
started_atstring date-time nullable
ended_atstring date-time nullable
timestampstring date-time