Finding the API reference
Quiddly publishes a developer portal alongside this knowledge base. It covers authentication, webhooks, the rights catalogue and an interactive reference for every API endpoint.
Where to find it
Section titled “Where to find it”The portal is served from your own instance, at /developers on your API host.
If your Operations Portal is at acmeadmin.quiddly.com, the portal is at
acmeapi.quiddly.com/developers.
You can also reach the public copy at dev.quiddly.com, which redirects to the staging instance.
What it contains
Section titled “What it contains”| Section | Contents |
|---|---|
| Start here | Getting started, authentication, environments |
| Core concepts | Instance providers, clients and debtors, rights and roles, the rights catalogue, idempotency and errors |
| Workflows | Task-oriented guides for the common integration paths |
| Webhooks | Overview, the event catalogue, and how to verify signatures |
| API reference | The interactive reference, plus conventions and pagination |
| Tools | Developer Mode in the Operations Portal, and connecting an AI assistant over MCP |
| Releases | Release notes for the API |
The interactive reference
Section titled “The interactive reference”Every endpoint is browsable, grouped by domain, with the request and response shapes and a ready-made call in the client library of your choice.
Why it matches your version
Section titled “Why it matches your version”The reference is generated from the running API’s own specification at build time, and the bundle ships inside the same release as the API. There is no separate documentation deployment that can drift out of step, so the endpoints and fields you see are the ones your instance actually has.