API reference

Everything the Kancil web app does, it does through this API — so anything you can see on a page, you can fetch as JSON. The reference below is generated directly from the service's own OpenAPI description, which means it cannot drift from the running code.

Base URL

https://api.kancil.nl

The web app reaches the same service through a same-origin /api/* proxy, so paths you see in the browser's network tab carry an extra /api prefix that you do not include when calling the API directly.

The specification

The full OpenAPI 3.1 document is served as a static file, so you can point openapi-generator, Postman or your editor's REST client straight at it:

https://docs.kancil.nl/openapi.json

Download openapi.json

Start here

• Authentication — signing in, cookies and bearer tokens.
• Conventions — pagination, filtering, dates and errors.
• Then pick a tag from the sidebar for the endpoints themselves.

How this reference is organised

Endpoint pages are generated from the specification and grouped by its tags, which correspond closely to the routers in the service. Tags covering the platform's own machinery — admin and health — are grouped separately at the bottom of the sidebar.

Nothing is filtered out. One operation gets no page, GET /, because it carries no tag and so has no subject to file it under; it returns a service banner and is of no use to a client. Everything else in the specification has a page.