Developer documentation
Immobinet API
REST API of ImmobiNet, the property management system (PMS) for holiday rentals and other accommodation businesses. It exposes the data of an agency's installation: properties and residences, availability and rates, reservations, guests, quotes, invoices, cash transactions, contacts and messages.
What you can do
- Read the catalog: properties and residences and the extra services sold with a stay.
- Check availability, search free properties with their price, and read rates and cleaning fees by rate plan.
- Follow the booking flow: quotes, reservations and the guests of each reservation.
- Read the accounting side: invoices and cash transactions; read and write revenue prices.
- Work with contacts and messages exchanged with guests (email, SMS, Airbnb), including replies as drafts.
The API is mostly read only. Writing is limited to revenue prices, the replies to messages (drafts, attachments and sending) and the attachments of the residences. It replaces the read operations of the ImmobiNet SOAP web service; the migration table is in the Auth page.
Authentication
Every request uses HTTP Basic authentication with the credentials of an API user of the installation (Authorization: Basic ...). Call GET /api/v1/token to see the expiry and the scopes of the key in use, and GET /api/v1/users/me to see the current user.
- A wrong key returns
401. - The user needs the
webserviceprivilege, otherwise the API answers403. Each resource adds its own privileges and visibility rules, described in its page. - A key can only call the operations covered by its scopes (
<resource>:<action>, e.g.reservations:read). - If the user has a webservice configuration, only the properties enabled for it are visible.
curl -u "<user>:<key>" -H "Accept: application/json" \ "https://<your-immobinet-host>/api/v1/token"
Base URL and conventions
All paths start with /api/v1. The specs do not declare a servers entry: use the host of your ImmobiNet installation.
- Date-times are RFC 3339 with an explicit offset, in the
Europe/Rometimezone (e.g.2026-06-26T14:30:00+02:00). - Amounts are decimal numbers in euro (e.g.
120.5), not cents. - Lists are paginated with a cursor: pass
_pagination.next_cursorasnext_cursoruntil it isnull. - To stay in sync, poll the lists (where available with
updated_since) or receive PUSH change notifications and then read the changed items; see the Polling and Change notifications sections of the Auth page.

