Developers
V1MePassportRecordsIdHistory

Read retained private versions of one record

GET
/v1/me/passport/records/{id}/history

Authorization

bearer
AuthorizationBearer <token>

In: header

Path Parameters

id*string
Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid

Query Parameters

beforeVersion?integer
Range0 <= value <= 9007199254740991
limit?integer
Range1 <= value <= 50
Default20
portions?"optional"

Value in

  • "optional"

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/me/passport/records/497f6eca-6276-4993-bfeb-53cbbbba6f08/history"
{  "versions": [    {      "entryId": "09a8b554-45ca-4bab-a638-265db4b3e828",      "version": 0,      "readings": [        {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "entryId": "09a8b554-45ca-4bab-a638-265db4b3e828",          "code": "8480-6",          "valueNum": 0,          "valueText": "string",          "unit": "string",          "effectiveAt": "2019-08-24T14:15:22Z",          "recordedAt": "2019-08-24T14:15:22Z",          "source": "healthkit",          "confidence": 0,          "supersedesId": "688cf67a-2e6c-4e49-8750-5bc8809fcd6f",          "meal": {            "names": [              "string"            ],            "mealType": "breakfast"          }        }      ],      "meal": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "note": "string",        "mealType": "breakfast",        "totalKcal": 0,        "items": [          {            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",            "name": "string",            "grams": 0,            "kcal": 0,            "source": "search",            "confidence": 0          }        ]      }    }  ],  "nextBeforeVersion": 0}

Correct, hide or restore your private saved record POST

Hide is reversible presentation state, not erasure. Corrections append a replacement and retain original provenance/history. Reuse the exact operationId and payload on uncertain retry; expectedVersion rejects stale changes. A successful retry acknowledges the original operation and returns the latest record state, which may include later actions. Hidden records do not contribute to current Passport or meal summaries.

Seven-day private health passport summary GET

All-time current entry count and earliest recorded date, plus seven calendar days in the requested IANA timezone. Daily BP values are arithmetic averages by code; food energy is the sum of saved estimates. No ranges, diagnosis or health score. Independent of history filters and pagination; superseded and hidden values are excluded.