Skip to main content
BrikSync PropOS has a programmatic API so you can connect your own tools, scripts, and AI assistants to your organisation’s data.
Programmatic API access — including creating API keys — is a Business plan feature, available to organisation Admins. If you’re on the trial or PRO, upgrade from Settings → Billing to unlock it, or contact us through the contact form with any questions.

​
The one rule that matters most

The API can read your data. It can suggest changes. It cannot change anything on its own. Every write — creating a property, updating a lease, editing a tenant record, anything — goes through a suggestion that a person at your organisation reviews and approves inside BrikSync. Nothing is applied until someone clicks approve. This is true for every integration, script, and AI assistant that uses the API, with no exceptions. See Suggesting Changes for how that works.

​
What you can do with it

Read your data

Pull properties, units, tenants, leases, payments, maintenance requests, and documents into your own tools and reports.

Suggest changes

Propose a new record or an update to one. A person approves it in BrikSync before anything changes.

Connect an AI assistant

Point Claude, ChatGPT, or any compatible assistant at your BrikSync data using the same read-and-suggest model.

Handle errors and limits

A consistent error format across every endpoint, plus rate limits and daily request allowances.

​
Creating an API key

  1. Go to API & Automation in the left sidebar (this page is only visible on the Business plan).
  2. If you’re an Admin, click New key in the API keys panel.
  3. Give the key a name that describes what it’s for — for example, “Claude assistant” or “nightly reporting job”.
  4. Choose an access level for the key (Admin, Property Manager, Landlord, Broker, or Tenant). This sets the ceiling on what the key can ever see — a key created at the Tenant access level can never read more than a tenant could.
  5. Choose which scopes the key needs — see Authentication for the full list.
  6. Click Create. Your key’s secret is shown once. Copy it somewhere safe — BrikSync stores only a fingerprint of it and cannot show it to you again.
Only Admins can create or revoke API keys. Any team member at the Property Manager level or above can review and approve the suggestions integrations make, from the same page.

​
Base path and versioning

Every endpoint in this API section lives under one base path:
The version is part of the path (v1), not a header. If a future version introduces a breaking change, it will arrive alongside v1 as a new version — v1 itself won’t change underneath you, and any retirement will be announced well in advance. The AI assistant connector described in Connect an AI Assistant is a separate endpoint outside this versioned path, since it speaks a different protocol.

​
The API contract

The full, always-current contract — every endpoint, every field, every parameter — is published as a machine-readable specification:
This is generated directly from what’s live, so it can never describe something that doesn’t actually exist. No API key is needed to read it — it describes the shape of the API, not your data. Use it to generate a client library, explore the API in a tool that understands OpenAPI, or simply double-check a field name.

​
Authenticating requests

Every request to /api/v1/* and to the AI assistant endpoint needs your API key sent as a bearer token:
Full details, including scopes and what each access level can see, are on the Authentication page.

​
Next steps

Authentication

Create a key, choose scopes, and understand access levels.

Reading Data

Collections, pagination, filtering, and example requests.
BrikSync is in private beta and not yet incorporated — we are working through that process and building a small founding team.
Last modified on August 26, 2026