Health

1 operation. Every schema and example on this page is generated from the platform contract.

GET/api/v1/health/connection

Get the member's health-connection status for a store.

Health-connection status for the signed-in customer at a given store: whether the store has the health / performance feature on, whether connecting the given provider is allowed, and the member own connection record (consents, capability level, sync + target fields) for that store and provider. The member is resolved from the session; the store and provider are context, never identity.

auth customer:readop getCustomerHealthConnectionrate limited errors

Parameters

store_idstring · uuidqueryrequired

Store whose health-connection status to read (context, not identity).

providerenumqueryoptional

Health data provider (defaults to apple_health).

apple_healthhealth_connectstrava

Response, 200

feature_enabledbooleanrequired

Whether the store has the health / performance feature enabled.

connection_allowedbooleanrequired

Whether the member may connect this provider (feature on and provider permitted).

connectionobjectrequired

The member's own connection record for this store + provider, or null if none / feature gated.

27 child fields

idstringrequired

customer_idstringrequired

store_idstringrequired

providerenumrequired

apple_healthhealth_connectstrava

connection_statusenumrequired

disconnectedconnectedrevokederror

capability_levelanyrequired

consent_connectionbooleanrequired

consent_recapbooleanrequired

consent_recommendationsbooleanrequired

consent_coach_visibilitybooleanrequired

consent_penalty_reviewbooleanrequired

consent_versionstring, nullablerequired

connected_atstring, nullablerequired

disconnected_atstring, nullablerequired

last_sync_atstring, nullablerequired

last_errorstring, nullablerequired

provider_user_idstring, nullablerequired

provider_metadataobjectrequired

weekly_target_visitsnumber, nullablerequired

weekly_target_sourceenumrequired

defaultonboardingmanualadaptive

weekly_target_set_atstring, nullablerequired

target_bump_dismissed_untilstring, nullablerequired

max_heart_rate_bpmnumber, nullablerequired

max_hr_sourceenumrequired

manualage_estimateobserved_peak

inference_enabledbooleanrequired

created_atstringrequired

updated_atstringrequired

curl -G "https://www.membber.com/api/v1/health/connection" \
  -H "Authorization: Bearer $MEMBBER_TOKEN" \
  --data-urlencode "store_id=6659c139-0000-4000-8000-d0c500000066"

import { createMembberClient } from "@membber/sdk-ts";

const membber = createMembberClient({
  getAccessToken: () => process.env.MEMBBER_TOKEN,
});

const { data, error } = await membber.raw.GET("/api/v1/health/connection", {
  params: { query: { store_id: "6659c139-0000-4000-8000-d0c500000066" } },
});

if (error) {
  // Typed error envelope: { error: { code, message, requestId } }
  throw new Error(`${error.error.code}: ${error.error.message}`);
}
console.log(data);

import MembberSwift

let client = MembberClient(
    serverURL: MembberClient.productionServerURL,
    tokenProvider: { session.accessToken }
)

let response = try await client.api.getCustomerHealthConnection(
    query: .init(storeId: "6659c139-0000-4000-8000-d0c500000066")
).ok.body.json

print(response)

Response, 200

{
  "feature_enabled": true,
  "connection_allowed": true,
  "connection": {
    "id": "00000d1b-0000-4000-8000-d0c500000000",
    "customer_id": "96607d1c-0000-4000-8000-d0c500000096",
    "store_id": "6659c139-0000-4000-8000-d0c500000066",
    "provider": "apple_health",
    "connection_status": "disconnected",
    "capability_level": "<capability_level>",
    "consent_connection": true,
    "consent_recap": true,
    "consent_recommendations": true,
    "consent_coach_visibility": true,
    "consent_penalty_review": true,
    "consent_version": "<consent_version>",
    "connected_at": "<connected_at>",
    "disconnected_at": "<disconnected_at>",
    "last_sync_at": "<last_sync_at>",
    "last_error": "<last_error>",
    "provider_user_id": "cf8619c1-0000-4000-8000-d0c5000000cf",
    "provider_metadata": {},
    "weekly_target_visits": 1,
    "weekly_target_source": "default",
    "weekly_target_set_at": "<weekly_target_set_at>",
    "target_bump_dismissed_until": "<target_bump_dismissed_until>",
    "max_heart_rate_bpm": 1,
    "max_hr_source": "manual",
    "inference_enabled": true,
    "created_at": "<created_at>",
    "updated_at": "<updated_at>"
  }
}