Sign in
External: Connections

Get Connections Endpoint

Get all connections for a user, enriched with provider capability metadata.

get/api/v1/users/{user_id}/connections

Path parameters

user_idstring uuid required

Headers

X-Open-Wearables-API-Keystring nullable

Response

Successful Response

user_idstring uuid required
providerstring required
provider_user_idstring nullable
provider_usernamestring nullable
scopestring nullable
idstring uuid required
status'active' | 'revoked' | 'expired' required

Status of a user connection to a provider.

last_synced_atstring date-time nullable required
created_atstring date-time required
updated_atstring date-time required
icon_urlstring nullable

Relative URL to provider icon (e.g., '/static/provider-icons/garmin.svg'). Resolve against the API base URL.

max_historical_daysinteger nullable
rest_pullboolean
webhook_streamboolean
webhook_pingboolean
webhook_callbackboolean
live_sync_mode'pull' | 'webhook'
linked_user_idsstring[]

Changes

Changed in 1 of the 9 revisions of this API.1

  • e91ac2fa92891See the full diff
    • ○

      added the optional property / to the response with the status

      response-optional-property-added