Use the Red Bricks OS REST API
The public API exposes supported Red Bricks OS operations to authorized integrations using a scoped personal key.
Where to find it: Admin → Settings → CRM & API Keys
What to do
- Create a key for the integration with the minimum scopes.
- Use the current API documentation and account-specific base address shown.
- Start with a read operation.
- Handle errors, pagination, retries, and duplicate requests.
- Revoke the key when the integration is retired.
Good to know
- Do not put a secret key in browser-side code or a public repository.
- Account and role boundaries still apply to API requests.
Was this article helpful?