Welcome to the Stonal API
What is the Stonal API for?
Connect Stonal to your tools so your real-estate data stays up to date without re-keying: your buildings, documents and contracts sync automatically, both ways.
In practice, the API lets you:
- feed Stonal from your own tools (ERP, management software, company directory…);
- retrieve the data enriched by Stonal in your tools (classified documents, extracted information…);
- be notified automatically whenever data changes.
In Stonal, an asset is any element of your real-estate portfolio: a building, a unit, a piece of equipment… This is the term used throughout the Stonal interfaces.
Available APIs
| API | What it does | Learn more |
|---|---|---|
| Assets | Import, synchronize and link your assets (buildings, units, equipment), manage their hierarchy and search across your portfolio. | Guide |
| Users | Provision users and manage their access rights: which portfolio, applications and reports each one can see. | Guide |
| Documents | Upload your documents in bulk (surveys, deeds of sale, leases, insurance certificates…) and let the AI classify them, extract the key information and link them automatically to your portfolio. | Guide |
| Stakeholders | Add and keep your contacts up to date in the Stonal platform (building caretakers, maintenance operators…). | Guide |
| Contracts | Add and keep contracts up to date (leases, maintenance contracts…), specifying the scope of work, the equipment type involved and the linked contact. | Guide |
| Webhooks | Be notified in real time of changes (document creation, update, deletion). | Guide |
Use-case examples
Here are a few concrete scenarios. They are often combined within a single integration project.
1. Automatically synchronize your portfolio
Keep an up-to-date repository of your assets (buildings, units, equipment) in Stonal by importing and synchronizing them from your IS (ERP, management software), rather than through manual double entry. Whenever something changes on the IS side, the assets and their properties (area, address, internal identifiers…) are updated in Stonal, ensuring a single, reliable source of truth.
You can also create links between assets to reconstruct their hierarchy: a piece of equipment attached to a unit, itself attached to a building. For example, when a new building enters your portfolio, your IS triggers its creation in Stonal together with its full tree, with no manual work.
→ Assets API
2. Manage your users' access
Automatically provision your users from your company directory, then keep them synchronized. For each user, define what they can access: the portfolio concerned, the features allowed and the applications opened. To save time, bundle users who share the same rights into groups.
For example, when an employee joins, their account and access are created automatically; when they leave, these are revoked — with no manual steps and no risk of oversight.
→ Users API
3. Centralize and leverage your documents
Upload your documents in bulk (surveys, electrical-compliance certificates, deeds of sale, leases, tenant insurance certificates…) and let Stonal's AI do the filing: it categorizes each file to file it automatically in the right folder, extracts the key information (dates, key survey details, buyer…) and automatically links it to the relevant assets (for example, a unit-level survey is attached to the matching unit). You can also specify, right at import, the document type (its class), the folder to file it in and the unit or building it refers to — if you already know the information, we recommend filling it in.
You then retrieve these documents and their metadata through search, directly in your tools. For example, a DAPP is categorized as such, filed in the right folder of the documentary tree and linked to the right building.
→ Documents API
4. Record your contacts and contracts
Create contracts (leases, maintenance contracts, service agreements…) and link them to everything they involve: the scope of work (the buildings covered), the equipment type involved (e.g. elevators — the precise equipment is then derived from the scope + the type), as well as the contacts — tenants, owners or service providers, whether individuals or companies. You then keep these contracts up to date throughout their lifecycle (renewal, amendment, termination).
For example, an elevator maintenance contract covers a scope of several buildings and the "elevator" equipment type; it is linked to its provider, giving a consolidated view of who works on which scope, and until when.
→ Stakeholders and Contracts APIs
5. React to changes in real time
Rather than polling the API constantly to spot what's new, let Stonal notify you: every time a document is created, updated or deleted in your organization — including during automated processing (OCR, AI classification…) — a webhook calls your system with the details of the event.
You can then trigger an action on your side in real time. For example, as soon as a new lease is classified by the AI, your business tool is notified and can start the corresponding validation workflow.
→ Webhooks
Getting started
- Create credentials — define an API user and generate a personal access token (PAT). No account yet? Reach out to an administrator in your organization or your Stonal account manager — it's required to create API credentials.
- Pick your use case — find the matching API in the table above, then hand the related technical guide to your IT department.