Endpoint
/api/v1 path, since it speaks the MCP protocol rather than plain REST.
Authenticating
Use the same API key described in Authentication, sent the same way — as a bearer token:- Server URL:
https://briksync.com/api/mcp - Authentication: Bearer token, using your BrikSync API key
What the assistant can do
An assistant connected this way gets access to a set of tools, generated from the same collections described in Reading Data. Which tools it actually sees depends on the scopes your key holds — a key withoutpayments:read, for instance, won’t offer a payments tool at all.
Read tools — one pair per collection:
Suggestion tools:
These map directly onto Reading Data and Suggesting Changes — the same pagination, filtering, and approval model applies whether you’re calling the REST API yourself or an assistant is calling it on your behalf through these tools.
What happens when the assistant suggests something
When your assistant callspropose_changes, BrikSync records the suggestion exactly as it would from a direct API call — nothing is applied. The assistant is told plainly that the change is only a suggestion awaiting approval, and a well-behaved assistant will tell you the same thing. The suggestion then shows up in API & Automation in BrikSync for a person to review, alongside suggestions from any other integration.
Data your assistant sees
An assistant only ever sees records belonging to your own organisation, filtered further by the access level and scopes on the key it’s using — the same boundaries described in Authentication and Reading Data. Tenant contact records are limited to name, email, phone, and status; document contents are not accessible; and there is no tool anywhere in this API that scores, ranks, or screens a person.Next steps
Reading Data
See exactly what each collection returns.
Errors & Limits
What happens when a request fails or a limit is hit.