Sign in
import-export

Create Export

Create a new export job.

The export will be processed asynchronously. Use the job ID to check status and download the file when completed.

Export Types:

  • full: Export all user data (journals, entries, media, settings)
  • journal: Export specific journals (requires journal_ids)
post/api/v1/export/

Request

  • The document declares no server URL.
  • Auth: OAuth 2 (password, token URL /api/v1/auth/token)

Cookies

access_tokenstring nullable

Request body

export_type'full' | 'journal' required

Types of exports.

journal_idsstring[] nullable

Specific journal IDs for selective export

include_mediaboolean

Whether to include media files

Response

Export job created and queued

idstring required

Job ID (UUID)

status'pending' | 'running' | 'completed' | 'partial' | 'failed' | 'cancelled' required

Status for import/export jobs.

progressinteger required

Progress percentage 0-100

total_itemsinteger required

Total number of items to process

processed_itemsinteger required

Number of items processed so far

created_atstring date-time required

When job was created (UTC)

completed_atstring date-time nullable

When job completed or failed (UTC)

result_dataobject nullable

Result statistics (JSON)

errorsstring[] nullable

Error messages (JSON array)

warningsstring[] nullable

Warning messages (JSON array)

export_type'full' | 'journal' required

Types of exports.

include_mediaboolean required

Whether media is included

file_pathstring nullable

Path to export file (internal use)

file_sizeinteger nullable

Export file size in bytes

download_urlstring nullable

URL to download export file

Changes

No recorded changes to this operation across all 9 revisions of this API.