Start free →

API reference

Service and account

Check that the service is up, see which modules are production-grade, export the workspace’s data, and read or erase your own account.

All of the API reference

Route summaries and field names are written in English, here and in the file.

/api/health

GET /api/health

Health check, for uptime monitors

Authentication
None: public
Answers
200 · 429 · 503

/api/v1/system

GET /api/v1/system/modules

Which modules are production-grade, beta or experimental

Authentication
API key
Key scope
usage:read
Parameters
maturity

/api/v1/export

GET /api/v1/export

The workspace's data, for portability (GDPR art. 20)

Authentication
API key
Key scope
journal:read
Parameters
format · tables · offset · limit

/api/v1/me

GET /api/v1/me

Your personal data (GDPR art. 15) — signed in, never an API key

Authentication
Signed-in session (the dashboard)
Parameters
cursor

DELETE /api/v1/me

Erase your account (GDPR art. 17) — signed in, never an API key

Authentication
Signed-in session (the dashboard)