Vital · Schema

VitalUser

An end user on the Junction (Vital) platform. Each user represents a person whose wearable, device, and lab data is ingested under your team. Identified by a Junction-issued user_id (UUID) and an optional client_user_id (your own opaque identifier).

Health DataWearablesLab TestingDigital HealthHealthtechHealthcareHIPAAHealthKitHealth ConnectEHREMRBiomarkersDiagnosticsContinuous Glucose MonitoringSleepActivityHeart RateWebhooksPhlebotomyLab Orders

Properties

Name Type Description
user_id string Junction-assigned unique identifier for the user.
client_user_id string Your application's opaque identifier for the user. Must be unique within the team.
team_id string Identifier of the team that owns this user.
created_on string ISO-8601 timestamp of when the user was created.
fallback_time_zone stringnull IANA time zone applied when device-reported time zone is unavailable (e.g., America/New_York).
fallback_birth_date stringnull Fallback birth date used for age-dependent calculations.
connected_sources array Providers the user has connected (Fitbit, Garmin, Oura, etc.).
View JSON Schema on GitHub

JSON Schema

vital-user-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/vital-io/main/json-schema/vital-user-schema.json",
  "title": "VitalUser",
  "description": "An end user on the Junction (Vital) platform. Each user represents a person whose wearable, device, and lab data is ingested under your team. Identified by a Junction-issued user_id (UUID) and an optional client_user_id (your own opaque identifier).",
  "type": "object",
  "required": ["user_id", "client_user_id", "team_id"],
  "properties": {
    "user_id": {
      "type": "string",
      "format": "uuid",
      "description": "Junction-assigned unique identifier for the user."
    },
    "client_user_id": {
      "type": "string",
      "description": "Your application's opaque identifier for the user. Must be unique within the team."
    },
    "team_id": {
      "type": "string",
      "format": "uuid",
      "description": "Identifier of the team that owns this user."
    },
    "created_on": {
      "type": "string",
      "format": "date-time",
      "description": "ISO-8601 timestamp of when the user was created."
    },
    "fallback_time_zone": {
      "type": ["string", "null"],
      "description": "IANA time zone applied when device-reported time zone is unavailable (e.g., America/New_York)."
    },
    "fallback_birth_date": {
      "type": ["string", "null"],
      "format": "date",
      "description": "Fallback birth date used for age-dependent calculations."
    },
    "connected_sources": {
      "type": "array",
      "description": "Providers the user has connected (Fitbit, Garmin, Oura, etc.).",
      "items": {
        "type": "object",
        "properties": {
          "provider": {"type": "string"},
          "created_on": {"type": "string", "format": "date-time"},
          "status": {"type": "string", "enum": ["connected", "error", "paused", "disconnected"]}
        }
      }
    }
  }
}