Welcome to the Stonal Public API

What is the Stonal API for?

The API lets you connect Stonal to your information system and automate data exchange in both directions:

• 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.

A word on terminology

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
Documents	Upload documents, let the AI classify them and extract the key information, then search them and link them to your assets.	Guide
Users	Provision users and manage their access rights: which assets, applications and reports each one can see.	Guide
Contracts	Create and maintain contracts (leases, maintenance contracts…) linked to assets, equipment and stakeholders.	Guide
Stakeholders	Manage the contacts — individuals or companies — linked to your contracts.	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 characteristics (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. Centralize and leverage your documents

Upload your documents in bulk (leases, surveys, invoices, AGM minutes…) and let Stonal's AI do the filing: it categorizes each file, extracts the key information (dates, amounts, addresses, asset identifiers…) and automatically links it to the relevant assets.

You then retrieve these documents and their metadata through search, directly in your tools. For example, a batch of invoices uploaded at month-end is sorted, indexed and linked to the right buildings without any manual filing.

→ Documents API

3. Manage your contracts and stakeholders

Create contracts (leases, maintenance contracts, service agreements…) and link them to everything they involve: the assets and equipment they cover, as well as the stakeholders — 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 can be attached to the equipment concerned and to its provider, giving a consolidated view of who works on what, and until when.

→ Contracts and Stakeholders APIs

4. Manage your users' access

Automatically provision your users and their access rights from your company directory, then keep them synchronized. Rights can be granted through groups (a set of permissions applied to several people at once) or individually, to finely control who can access which assets, applications and reports.

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

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

1. Get a Stonal account — contact API support (by email or Slack).
2. Create credentials — define an API user and generate a personal access token (PAT).
3. Pick your use case — find the matching API in the table above, then hand the related technical guide to your IT department.