Skip to main content
Public API v1 exposes measurement entries, soft-archive, progress summaries, and read-only progress photos with short-lived signed URLs. Progress photo upload, permanent deletion and objective writes are not supported in v1.

Scopes

All four scopes on this page are consent-gated health scopes: the API client must be created with "consents": { "healthData": true }. Without that stored consent, these endpoints return 403 scopes.health_consent_required. See Authentication.

List measurement types

Required scope: measurements:read Response fields:

List measurement entries

Required scope: measurements:read Validation: Response fields: Historical access grants are applied when the client relationship has restricted history access.
Response:

Create measurement entry

Required scope: measurements:write Request body: Accepted numeric examples:
Rejected numeric example:
Response fields:
Response (201 Created):

Update measurement entry

Required scope: measurements:write Allowed fields: value, unit, measuredAt, note. Validation is identical to create. At least one allowed field is required. Response fields:

Archive measurement entry

Required scope: measurements:write Archiving hides the entry from product views and Public API reads. It does not permanently delete the measurement record. Validation: Response fields:

List measurement progress summaries

Required scope: progress_summaries:read Validation: Response fields: Summaries omit notes, coach IDs, company IDs, and health provider or processing metadata.

List progress photos

Required scope: progress_photos:read Validation: Response fields: Not exposed: raw imageUrl, private storage keys, createdBy, coachId, companyId, dimensions, file size, media provider metadata, or hard-delete controls.

Get progress photo

Required scope: progress_photos:read Response fields: The detail endpoint applies the same client access, historical progress-photo access, orientation, and date-range filters as the list endpoint. It never returns raw storage keys or the persisted imageUrl.

Not exposed in v1