External: Users

Get User

Changed on

Returns one user with its latest sync state and connection summary.

get/api/v1/users/{user_id}

Request

  • Base URL: https://api.openwearables.io (the document declares no server; this is the origin it was published from)
  • URL: https://api.openwearables.io/api/v1/users/{user_id}
  • Auth: OAuth 2 (password, token URL /api/v1/auth/login)

Path parameters

user_idstring uuid required

Query parameters

includeUserInclude[]

Optional expansions to embed; repeat the parameter for several

Headers

X-Open-Wearables-API-Keystring nullable

Response

Successful Response

idstring uuid required
created_atstring date-time required
first_namestring nullable
last_namestring nullable
emailstring email nullable
external_user_idstring nullable

Deprecated: no data-fetching endpoint (timeseries, workouts, sleep, summaries, health-scores, etc.) accepts external_user_id - they all require the Open Wearables UUID. This field was added early in the project but never wired into those endpoints, so it only works as a filter on GET /users. Store the UUID returned by POST /users in your own system instead.

last_synced_atstring date-time nullable
last_synced_providerstring nullable

Provider that synced most recently, or null if none of them ever synced

has_active_connectionboolean

Whether any connection is active. Mirrors the has_active_connection filter

has_womens_health_databoolean

Whether the user has any menstrual cycle events, from any provider

Changes

  • 4e61b8720ebbRevision changes
    • info

      added the new optional query request parameter include

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status