Status badges and public data
Embed a live status badge, and read portal data without an API key.
3 min read
Everything published on your portal is readable without a key. That is intentional — it is public data, and requiring a credential to read it would just mean every embed needed a secret.
The badge
An SVG that reflects live status. It is an image, so it works in a README, a docs site, a wiki, or an email — anywhere an <img> works.
Per-component badges live alongside it, so a component page can carry its own indicator rather than the whole-system roll-up.
Public read endpoints
| Path | Returns |
|---|---|
/api/public/{workspace} | Portal metadata — name, branding, enabled modules. |
/api/public/{workspace}/boards | Published boards. |
/api/public/{workspace}/boards/{board}/posts | Posts with vote counts. |
/api/public/{workspace}/roadmap | The public roadmap. |
/api/public/{workspace}/changelog | Published release notes. |
/api/public/{workspace}/status | Component health and incidents. |
Only what you published
These endpoints serve exactly what a visitor to your portal can already see. A private board is not readable here — publishing is the switch, and it is the same switch either way.
Something unclear or wrong? Tell us — or post it on our board.