VIP Condos Toronto logo
apirestintegrationscopeskeysdevelopers

Use the Red Bricks OS REST API

Make scoped requests from an approved script or integration.

Last updated

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

  1. Create a key for the integration with the minimum scopes.
  2. Use the current API documentation and account-specific base address shown.
  3. Start with a read operation.
  4. Handle errors, pagination, retries, and duplicate requests.
  5. 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?

Related Articles

Connect Zapier

Move supported events and actions between Red Bricks OS and other apps.

Integrations & AI

Configure an Outgoing Webhook

Send supported event data to an authorized endpoint.

Integrations & AI

Create and Manage CRM API Keys

Give an external tool only the access it needs.

Integrations & AI

Back to Integrations & AI