JSON Export File Format
Last modified by Eleni Cojocariu on 2026/11/11 11:02
Content
Reference
Users and administrators export bookmarks as JSON files. Page references are written without their wiki, so that a file can be imported into another wiki.
| Key | Type | What it holds |
|---|---|---|
| format | String | advanced-bookmarks for a user export, advanced-bookmarks-wiki for a wiki export. |
| formatVersion | Number | 1 |
| exportedAt | String | Date of the export, in ISO 8601 format. |
| folders | Array | User export: the folders, each with id, name, parent (id of the parent folder, empty at the top level) and order. |
| bookmarks | Array | User export: the bookmarks, each with page (page reference), label (empty to display the page reference), folder (id of the folder, empty for "Uncategorized"), order and panel (true when selected for the Panel). |
| users | Array | Wiki export: one object per user, with user, folders and bookmarks. Local users are written without their wiki; global users of a farm keep the main wiki prefix, such as xwiki:XWiki.jdoe. |
A user export, indented for reading:
{
"format": "advanced-bookmarks",
"formatVersion": 1,
"exportedAt": "2026-10-27T17:52:27.605775143Z",
"folders": [
{"id": "c460da96-9230-40bf-949d-355ed987bb51", "name": "Projects", "parent": "", "order": 0}
],
"bookmarks": [
{"page": "Sandbox.TestPage1", "label": "Release plan", "folder": "c460da96-9230-40bf-949d-355ed987bb51", "order": 0, "panel": true},
{"page": "Main.WebHome", "label": "", "folder": "", "order": 0, "panel": false}
]
}A wiki export, with the same folders and bookmarks for each user:
{
"format": "advanced-bookmarks-wiki",
"formatVersion": 1,
"exportedAt": "2026-10-27T17:52:27.605775143Z",
"users": [
{"user": "XWiki.jdoe", "folders": [], "bookmarks": [{"page": "Main.WebHome", "label": "", "folder": "", "order": 0, "panel": false}]},
{"user": "xwiki:XWiki.asmith", "folders": [], "bookmarks": []}
]
}