API reference

A REST API for boards, categories, tags, todos and history. Base URL /api/v1. Authenticate with an API key or an OAuth access token. Machine readable spec: openapi.json.

Board-limited credentials. An API key or OAuth grant can be restricted to specific boards, each with its own scopes (for example read-only on one board, full access on another). Other boards behave as if they don't exist (404), a missing scope on an allowed board returns 403 insufficient_scope, and board-limited credentials can't create or reorder boards, import data or call account-wide endpoints. GET /boards and GET /export only include the permitted boards.

Authentication

Authorization: Bearer plk_… (key) or oat_… (OAuth)

Envelope

Responses are { data, meta? }. Errors are { error: { code, message } }.

Rate limits

X-RateLimit-* headers on every response; 429 includes Retry-After.

Account

Boards

Categories

Tags

Todos

History

Import & export

Errors

400bad_requestValidation failed – the message names the offending field
401unauthorizedMissing, invalid, expired or revoked credential
403forbidden / insufficient_scopeThe credential lacks the scope or the action is website-only
404not_foundThe resource does not exist (or belongs to another user)
409conflictState conflict, e.g. duplicate category name or moving a non-active todo
413payload_too_largeBody exceeds the size limit (256 KB, 4 MB for imports)
422limit_reachedA plan limit such as boards per user was reached
429rate_limitedToo many requests – see Retry-After
500internal_errorUnexpected error – include the X-Request-Id when reporting