Skip to main content
GET
/
api
/
v1
/
users
/
{user_id}
/
sync
/
recent
List Recent Sync Events
curl --request GET \
  --url https://api.example.com/api/v1/users/{user_id}/sync/recent \
  --header 'Authorization: Bearer <token>'
[
  {
    "run_id": "<string>",
    "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "provider": "<string>",
    "event_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "message": "<string>",
    "progress": 0.5,
    "items_processed": 1,
    "items_total": 1,
    "error": "<string>",
    "primary_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "metadata": {},
    "started_at": "2023-11-07T05:31:56Z",
    "ended_at": "2023-11-07T05:31:56Z",
    "timestamp": "2023-11-07T05:31:56Z"
  }
]

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

​
limit
integer
default:50
Required range: 1 <= x <= 200

Response

Successful Response

​
run_id
string
required

Identifier shared by all events of the same sync run.

​
user_id
string<uuid>
required
​
provider
string
required

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

​
source
enum<string>
required

How the sync was initiated / what transport delivers data.

Available options:
pull,
webhook,
sdk,
backfill,
xml_import,
linked_account
​
stage
enum<string>
required

Coarse-grained stage label for a sync run.

Available options:
queued,
started,
fetching,
processing,
saving,
completed,
failed,
cancelled
​
status
enum<string>
required

Overall outcome state for the run.

Available options:
in_progress,
success,
partial,
failed,
cancelled,
skipped
​
event_id
string<uuid>

Unique ID for this event.

​
message
string | null
​
progress
number | null

Optional 0..1 progress.

Required range: 0 <= x <= 1
​
items_processed
integer | null
Required range: x >= 0
​
items_total
integer | null
Required range: x >= 0
​
error
string | null
​
primary_user_id
string<uuid> | null

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

​
metadata
Metadata · object
​
started_at
string<date-time> | null
​
ended_at
string<date-time> | null
​
timestamp
string<date-time>