Developers
V1MeOnboardingExport

Download your setup sessions and their original questions as portable JSON

Owner-only, up to 100 sessions per page. Follow nextCursor until null. This is separate from clinical passport readings; no public download URL is created.

GET
/v1/me/onboarding/export

Authorization

bearer
AuthorizationBearer <token>

In: header

Query Parameters

cursor?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

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/me/onboarding/export"
{  "format": "medbuk.onboarding",  "exportedAt": "2019-08-24T14:15:22Z",  "sessions": [    {      "revision": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "status": "draft",        "version": 1,        "definition": {          "name": "string",          "slides": [            {              "id": "string",              "title": {                "en-MY": "string",                "ms-MY": "string",                "zh-Hans-MY": "string"              },              "body": {                "en-MY": "string",                "ms-MY": "string",                "zh-Hans-MY": "string"              },              "image": {                "url": "http://example.com",                "alt": {                  "en-MY": "string",                  "ms-MY": "string",                  "zh-Hans-MY": "string"                }              }            }          ],          "questions": [            {              "id": "string",              "prompt": {                "en-MY": "string",                "ms-MY": "string",                "zh-Hans-MY": "string"              },              "kind": "single",              "options": [                {                  "id": "string",                  "label": {                    "en-MY": "string",                    "ms-MY": "string",                    "zh-Hans-MY": "string"                  }                },                {                  "id": "string",                  "label": {                    "en-MY": "string",                    "ms-MY": "string",                    "zh-Hans-MY": "string"                  }                }              ],              "maxSelections": 1            }          ]        },        "createdAt": "2019-08-24T14:15:22Z",        "updatedAt": "2019-08-24T14:15:22Z",        "publishedAt": "2019-08-24T14:15:22Z"      },      "progress": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "revisionId": "bae12d01-48af-47b3-9304-b09ef0081cd6",        "version": 1,        "status": "in_progress",        "locale": "en-MY",        "stepId": "string",        "seenSlideIds": [          "string"        ],        "answers": {          "property1": [            "string"          ],          "property2": [            "string"          ]        },        "startedAt": "2019-08-24T14:15:22Z",        "updatedAt": "2019-08-24T14:15:22Z",        "completedAt": "2019-08-24T14:15:22Z"      }    }  ],  "nextCursor": "53a4a333-2825-45a4-80d2-5f430d088f36"}

Start a signed-in session on the current revision, idempotent per account and revision POST

Optional goals/preferences only. This functional setup state does not grant health, social, analytics or marketing consent. A retry returns the existing session even after its revision is archived.

Save your setup state with optimistic concurrency; terminal sessions are immutable PATCH

All answers are optional; only option IDs in the pinned revision are accepted. On a 409 read the latest session. Explicitly delete your setup data before starting over.