Documentation

Using the API

Keys, scopes, the response shape, and the one rule that matters.

/api/v1 is the only part of this service that is a public contract. Everything else — the dashboard's own endpoints, the admin console — may change without notice.

Authentication

Authorization: Bearer <your API key>

Keys are created in Settings → API keys, shown exactly once, and scoped. A key is locked to one organisation, so there is no organisation parameter anywhere in the API and no way to ask for another one.

GET /api/v1/meta

Unauthenticated, deliberately. It returns the scope catalogue, the real rate limits, the idempotency rules and the webhook events — which is exactly what you need before you have a key.

Every response has the same shape

{ "success": true, "data": {}, "error": null, "error_code": null }

Branch on error_code, never on error. The code is stable and published; the message is written for a person and may be reworded at any time without warning.

There is one NOT_FOUND, not a code per entity. A caller that needs to know what was missing reads the message; a caller that needs to branch reads the code.

The rule that matters

Anything that creates credentials from outside the dashboard issues them into review, never straight to published. Publishing is what bills and what emails.

This is a policy rather than an oversight, and it is why an integration cannot accidentally send two hundred emails. The product this one is measured against never settled the question: its meetings and MCP integrations respect the review gate while its form and LMS integrations publish immediately, so its users cannot reason about what any given integration will do.