Exporting account data
No single endpoint returns a full account dump. Use the dashboard export or script the API below.
For REST scripting, use the same Authorization: Bearer token for JSON routes and for member media URLs returned in responses. Fetch parents before children so foreign keys resolve when you import elsewhere.
- Account shell: Systems, Terminology, Appearance, Billing / Subscriptions
- Structure: Groups & folders (list + tree); per group, Group layout
- Members: Members list (repeat with
sideSystemId/subSystemIdwhen using side or sub-systems) - Per member: Custom fields; Member statuses assignments
- Notes (entries): Entries — at most 100 rows per list call. For large libraries, use
GET /api/v1/entries?memberId={uuid}&limit=100per member, or Search/catalogthenGET /api/v1/entries/{entryId} - Front: Front — current state, then paginate
GET /api/v1/front/historyuntilnextCursorisnull - Privacy & social: Privacy buckets, Friends, Social profile, then Guestbook & poll per widget
- Messaging: Messaging —
/bootstrap, then paginate channel messages withnextCursor - Operational extras: Activity, Import runs
- Trash (optional): Trash for soft-deleted items before purge
- Binary media:
GET /api/v1/members/{memberId}/media?kind=avatar|backgroundwith URLs andvfrom member JSON
API reference
Endpoint guides with request examples, response shapes, and scope requirements.
Members
List, create, update, delete, media.
Read guideGroups
Groups and folder tree.
Read guideEntries
Notes: list, create, trash, restore.
Read guideFront
Fronters, history, order, tier presence.
Read guideAppearance
Theme, colors, typography.
Read guideCustom fields
Definitions and per-member values.
Read guideTrash
Soft-deleted items and bulk purge.
Read guideSearch
Catalog and ILIKE search.
Read guideSubscriptions
Billing row (read).
Read guideBilling
Entitlements and plan usage.
Read guideImport
Migration run tracking.
Read guideActivity
Recent sessions and updates.
Read guideMember statuses
Definitions and assignments.
Read guideSystems
Side and sub systems.
Read guideMessaging
Channels and messages.
Read guidePrivacy buckets
Buckets and assignments.
Read guideTerminology
Global and scoped labels.
Read guideFriends
Requests and friend-visible data.
Read guideSocial
Links, widgets, theme.
Read guideGuestbook & poll
Widget messages and votes.
Read guideGroup layout
Folder order and separators.
Read guideResponse bodies
Success JSON is returned directly in the response body (no envelope wrapper). Reference pages document example JSON per endpoint. Shared errors: Errors.
