API Reference

MikroPlan API mode exposes a compact HTTP API for the browser app and lightweight automation.

The live OpenAPI document is served from:

/api/openapi.json

System

GET /api/health

Returns service health, timestamp, and whether auth is enabled.

GET /config.json

Returns browser runtime config:

• API base URL
• auth mode and enabled flag
• public auth route paths used by the browser app
• runtime mode

Auth

GET /api/auth/me

Returns the current auth state. When auth is enabled and no valid cookie is present, the endpoint returns authenticated: false rather than a 401.

POST /api/auth/magic-link

Requests a MikroAuth magic link.

{
  "email": "[email protected]"
}

When auth is disabled for local mode, this endpoint returns 202 with a local-mode message and does not send email.

POST /api/auth/verify

Verifies a magic-link token and returns access credentials.

{
  "email": "[email protected]",
  "token": "token-from-link"
}

The response sets an HttpOnly mikroplan_access_token cookie for browser collaboration streams.

POST /api/auth/logout

Clears the auth cookie.

Workspace

GET /api/workspace

Loads the current workspace.

The response includes:

• X-Workspace-Revision
• ETag

PUT /api/workspace

Replaces the workspace snapshot.

Send the latest revision with X-Workspace-Revision or If-Match. If the revision is stale, the API returns 409 with the current workspace.

Movement

POST /api/cards/:cardId/move

Moves a card to a target column and position.

POST /api/columns/:columnId/move

Moves a column to a target position.

Events

GET /api/events

Opens a Server-Sent Events stream.

The stream sends a connection event and workspace update events containing the latest revision and source client ID.