JSON export format

A Shipworth export is a portable, implementation-neutral archive of one feedback board. It is designed to be useful if you move your data elsewhere, without exposing Shipworth account, database, authentication, or infrastructure details.

Versioning

Consumers must check format and version. Additive fields may appear in a version; incompatible changes receive a new version.

Overview

Exports are UTF-8 JSON files. All timestamps are RFC 3339 timestamps in UTC. IDs are scoped to the export and are only intended to connect records within that file.

{
  "format": "feedback-board-export",
  "version": 1,
  "exported_at": "2026-08-12T14:30:00Z",
  "board": { ... },
  "participants": [ ... ],
  "feedback": [ ... ]
}

Board

The board object contains the display name, public heading and description, and its current state. States are active, read_only, or offline.

Participants

Each participant has an export-local ID, and may include a name, email address, and avatar URL where the board holds that information. Feedback, votes, comments, and subscriptions refer to these IDs.

Personal data

Exports can contain names and email addresses supplied by your board participants. Handle the file as confidential customer data.

Feedback

Each feedback item includes its title, description, state, submitter, timestamps, and its associated votes, comments, and subscriptions. Team replies use author_role: "team"; no Shipworth staff identity is exported.

{
  "id": "feedback_001",
  "title": "CSV export",
  "description": "Make reporting easier.",
  "state": "planned",
  "submitted_by": "person_001",
  "submitted_at": "2026-08-01T09:15:00Z",
  "updated_at": "2026-08-04T12:00:00Z",
  "votes": [{ "participant_id": "person_002", "recorded_at": "2026-08-01T10:00:00Z" }],
  "comments": [{ "id": "comment_001", "author_id": "person_001", "body": "…", "created_at": "2026-08-02T09:00:00Z" }],
  "subscriptions": []
}

What is not included

Exports do not contain account or billing data, internal or provider IDs, identity-provider identifiers, credentials, signing secrets, sessions, domain or DNS configuration, or operational logs.