Developers
V1MePassportExport

Export your private passport readings as portable JSON

Includes original and superseded food-energy, BP, glucose, weight and pulse observations. Returns at most 1,000 readings per page, newest first; repeat with nextCursor until it is null. The JSON is returned directly to the authenticated owner, with no public file or URL.

GET
/v1/me/passport/export

Authorization

bearer
AuthorizationBearer <token>

In: header

Query Parameters

limit?integer
Range1 <= value <= 1000
Default1000
cursor?string
Match^[A-Za-z0-9_-]+$
Length1 <= length <= 512
category?string

Value in

  • "all"
  • "food"
  • "bp"
  • "glucose"
  • "other"

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/me/passport/export"
{  "format": "medbuk.health-passport",  "schemaVersion": "1.0.0",  "codes": [    "8480-6"  ],  "exportedAt": "2019-08-24T14:15:22Z",  "observations": [    {      "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"    }  ],  "nextCursor": "string"}

Request deletion of your private health passport POST

Legacy request endpoint. Creates an auditable pending request and returns 202 Accepted. Repeated requests return the existing open request. New clients use /v1/me/account/deletion to preserve a private status receipt after Better Auth credentials are removed. Processing uses the privileged deletion worker; clinical, financial/safety/audit records and backups are handled separately.

Save reviewed manual readings with explicit storage consent POST

Only the canonical CODES units and plausibility bounds are accepted. This route records manual entries after review and save; it does not perform OCR or write to native health stores. Reuse entryId and the same readings on retry. A changed payload or another owner's UUID returns 409. No existing health reading is updated.