Documentation Index
Fetch the complete documentation index at: https://docs.briksync.com/llms.txt
Use this file to discover all available pages before exploring further.
API authentication
The BrikSync PropOS API supports a hybrid authentication model. External integrations use API keys, while the web application uses session tokens managed automatically by the browser.API keys (BUSINESS plan)
API keys are available on the BUSINESS plan. Generate and manage keys from Settings → API Access (Admin or Super Admin role required).Generating a key
- Navigate to Settings → API Access in the BrikSync dashboard.
- Click Generate API Key.
- Copy the key immediately — it is only shown once.
Using a key
Include your API key in theAuthorization header of every request:
IP allowlisting
You can optionally restrict API key usage to specific IP addresses or CIDR ranges. Configure allowlists from Settings → API Access.Session tokens
The BrikSync web application authenticates using session tokens managed automatically by the browser. You do not need to handle session tokens directly — they are set and refreshed as part of the normal sign-in flow.Plan requirements
| Authentication method | Required plan |
|---|---|
| Session tokens | All plans |
| API keys | BUSINESS |
API access was previously available on the PRO plan. As of July 2026, new API key generation
requires the BUSINESS plan. Existing PRO plan integrations continue during the transition period.
Error responses
| Scenario | HTTP status | Error code |
|---|---|---|
| Missing or expired credentials | 401 | UNAUTHORIZED |
| Insufficient role | 403 | FORBIDDEN |
| Plan does not include API access | 403 | PLAN_UPGRADE_REQUIRED |