Resources
There is no public API reference yet, and we will not publish a fake one.
Here is exactly what exists for integration today, so your technical team can judge it rather than take our word for it.
What exists today
- Connection management with separate test and live environments.
- Field mapping between your fields and ours, with suggestions an administrator approves.
- Sync history with runs, records, failures and a retry queue.
- Read connectors built for point-of-sale sales data and supplier, spend and headcount data.
- One public endpoint that accepts a sales feed, secured and validated on our side.
What does not exist
- A documented public REST API with published endpoints and authentication guide.
- Webhooks you can subscribe to for BranchFlow events.
- Any connector that writes into your systems. Everything built reads only.
- Certified or partner-listed integrations with any vendor.
How an integration actually goes
- 1
Scope the data
Decide what must flow, in which direction, and how often.
- 2
You supply credentials
They are stored server-side and never displayed in the app.
- 3
Map and test
Map fields, run a sync in the test environment, read the history.
- 4
Go live deliberately
Only after a successful test in your own workspace does anything show as connected.
What we will not claim on this page
- Until your credentials are added and tested, connections display as not configured. We never show a connected state we have not achieved.
- Messaging and email are delivered through your own accounts, connected during onboarding.
Common questions
- Can we export our data?
- Yes. Every report exports as CSV, so your data is not locked in.
- When will there be a public API?
- We have not set a date, and we would rather say that than publish a roadmap we might miss.
How access and records are handled
Each organisation's records are separated in the database, and people only see the branches they are assigned to. Status changes, approvals, rejections and verifications are recorded with who did them and when. We do not claim any external certification or audit at this stage; if you need a formal security review, ask us and we will tell you exactly what exists today.