Appearance
API Guides
Start with Authentication, then read the guide for the thing your integration does. Every page is written against the published contract the rest of this portal is generated from.
| Guide | What it answers |
|---|---|
| Authentication | One key, minted by an admin, carrying an organisation and a reach. |
| Scopes | One row per resource, three states each, and the verb that decides read from write. |
| Pagination | offset and limit, the caps that refuse rather than truncate, and how to walk a table. |
| Idempotency | Send a write twice with the same Idempotency-Key and it happens once. |
| Errors | Every code a keyed refusal can carry, and what a client should do about each. |
| Rate limits | The per-key, per-minute quotas, and the headers to read them by. |
| Webhooks | Signed deliveries, retries, and a receiver that verifies its own payloads. |
| Versioning | Date trains, how a key pins to one, and the promise about breaking changes. |
| MCP | The same keys open an MCP door, with a read-only rule for a key that has one. |
Runnable code for every guide is on the Examples page, and every operation is listed in the Reference.