API overview
This is the API that QELM’s own web and phone apps use. There are no customer API keys or integration tokens, and no public endpoint reference yet, so it is not set up for building your own integrations. This page is an overview of how the API works: where it lives, how it is versioned, how the apps authenticate, and what the requests and responses look like.
Base URL
Section titled “Base URL”All API requests go to:
https://api.qelm.appThe API is a workspace-scoped JSON service: requests act within a single company’s workspace, and responses contain only that workspace’s data.
Versioning
Section titled “Versioning”The API is versioned in the path. The current version is v1:
https://api.qelm.app/api/v1/...New, incompatible behavior ships under a new version path rather than breaking the existing one.
Authentication
Section titled “Authentication”How you authenticate depends on which of QELM’s apps is calling the API:
- Web sessions — when you are signed in to your workspace in the browser, requests are authenticated with your session.
- Phone apps — the QELM phone apps sign you in with your email, then send the token
they receive in the
Authorizationheader. You cannot create tokens like this for your own tools.
Either way, every authenticated request is tied to a single workspace, and the API only ever returns data belonging to that workspace.
Request and response format
Section titled “Request and response format”Requests and responses are JSON. Send Content-Type: application/json on requests
that include a body. Successful responses return the relevant resource as JSON;
errors return a JSON body describing what went wrong, alongside the appropriate
HTTP status code.
Integrating with QELM
Section titled “Integrating with QELM”If you need to connect another tool to your workspace, get in touch through Support and tell us what you are trying to do.
Was this page helpful?