API Reference

Kompass provides a REST API so you can read and update your data programmatically, build integrations, and connect Kompass to your own tools and reporting.

Open the API reference

The full, interactive reference is published here:

https://support.kompassbms.com/api/

It lists every endpoint with its parameters, request and response formats, and example payloads. The page is a read-only reference: it documents the API but does not make live calls against your account.

What you can do with the API

• Read clients, projects, quote items, tasks, and diary entries.
• Create and update records from your own systems.
• Export data for reporting or to feed a data warehouse.

Authentication

Requests are authenticated with a personal access token sent as a Bearer token in the Authorization  header. The reference describes the authentication scheme in full. Treat your token like a password: keep it secret, and revoke it if it is ever exposed.

Need help?

If you are planning an integration or have a question about a particular endpoint, get in touch with our support team and we will point you in the right direction.