API overview

The KolleK API is a JSON API that mirrors the web application one to one. Every capability of the app (creating collections, adding items and copies, recording transactions, managing members) has a matching endpoint, enforced by exactly the same rules. If your role lets you do something in the browser, your token lets you do it over HTTP. If it does not, the API refuses in the same way the app would.

This page gives you the mental model. The complete, always current endpoint reference is generated from the code and served by your instance:

• /docs/api for the browsable reference.
• /docs/api.md for the whole reference as Markdown.
• /docs/api/{section}.md for a single section as Markdown, handy for feeding one topic to a tool.

Scoped to your account

The API is tenant scoped. A token belongs to a user, and a user belongs to exactly one account, so every request resolves through that account. You cannot reach another account's data, and you do not pass an account identifier anywhere. There is nothing to configure: authenticate, and you are inside your own workspace.

The same roles apply as in the app. A viewer's token can read but not write. An editor's token can manage catalogue content. Owner only actions (members, account settings) need an owner's token.

How the resources are shaped

Resources nest the way KolleK is organized:

• Your account holds account wide resources: members, collection types, custom fields, tags, locations, conditions.
• Collections hold items, along with categories and sets.
• Items hold photos and copies.
• Copies carry the history resources: transactions, valuations, insurance records, loans, maintenance records, provenance events, location history, documents, and the combined timeline.

Responses loosely follow the JSON:API shape: each resource comes back as type, id, attributes, and links. Lists are paginated with a standard envelope, covered in Rate limits and conventions.

What this section covers

These pages cover getting started and the concepts that the generated reference cannot teach: authentication, conventions, and the current state of webhooks. For any specific endpoint, its parameters, and worked request and response examples, go straight to /docs/api.

Where to next

• Make your first request in Authenticate with the API.
• Skim Rate limits and conventions before writing a client.
• Browse the generated reference at /docs/api on your instance.