Schedule an appointment
apimo™

Webservice & API

Welcome to our API dedicated to Real Estate providers, you will find all the details of a real estate agency with its products, contacts and settings. Depending on your rights you can also send some information such as leads.

Partners

Contact us

Specifications

Welcome to our API dedicated to Real Estate providers, you will find all the details of a real estate agency with its products, contacts and settings. Depending on your rights you can also send some information such as leads.

The Apimo API only supports JSON
Protocol We give a valid, signed certificate for all API methods. Make sure your connection library supports HTTPS.
Token To use this API you need a numeric ID and a token. (request a token)
Limit Daily free quota of 1,000 requests and 10 requests/seconds (quotas are refreshed daily at midnight CET/CEST time).
Charset UTF-8
Content application/json
Languages fr (French) , it (Italian) , de (German) , es (Spanish) , en (English) , nl (Dutch) , zh (Chinese) , ru (Russian) , sv (Swedish) , ar (Arabic) , he (Hebrew) , nb (Norwegian Bokmål) , pt (Portuguese) , fa (Persian) , lb (Luxembourgish) , km (Khmer) , tr (Turkish) , lo (Lao)
The Apimo API supports 4 HTTP methods for interacting with resources
GET Make a GET request to retrieve data. GET requests will never cause an update or change to your data.
POST Use a POST request to create a resource.
PUT Use a PUT request to update a resource.
DELETE Make a DELETE request to remove a resource (be careful!).

Webservices

Catalogs

HTTP method Path Function
get /catalogs Get a list of catalogs
get /catalogs/{catalogs_id} Get a specific catalog

Agencies

HTTP method Path Function
get /agencies Retrieve the business units list

Agencies/actions

HTTP method Path Function
post /agencies/{agency_id}/actions Create a new action
put /agencies/{agency_id}/actions/{action_id} Update an action

Agencies/contacts

HTTP method Path Function
get /agencies/{agency_id}/contacts Retrieve the contacts list
post /agencies/{agency_id}/contacts Create a new contact
put /agencies/{agency_id}/contacts/{contact_id} Update a contact

Agencies/contracts

HTTP method Path Function
get /agencies/{agency_id}/contracts Retrieve the contracts list

Agencies/leads

HTTP method Path Function
get /agencies/{agency_id}/leads Retrieve the leads list
post /agencies/{agency_id}/leads Create a new lead

Agencies/properties

HTTP method Path Function
get /agencies/{agency_id}/properties Retrieve the properties list
post /agencies/{agency_id}/properties Create a new property
put /agencies/{agency_id}/properties/{property_id} Update a property
post /agencies/{agency_id}/properties/{property_id}/medias Add/embed a media (virtual tour, video …)
delete /agencies/{agency_id}/properties/{property_id}/medias/{media_id} Delete a media (virtual tour, video …)
post /agencies/{agency_id}/properties/{property_id}/pictures Update a picture
delete /agencies/{agency_id}/properties/{property_id}/pictures/{picture_id} Delete a picture inside a property
post /agencies/{agency_id}/properties/{property_id}/documents Add a document
delete /agencies/{agency_id}/properties/{property_id}/documents/{document_id} Delete a document inside a property
post /agencies/{agency_id}/properties/{property_id}/comments Add/Update a comment
get /agencies/{agency_id}/properties/{property_id}/providers Provider list for a specific property
post /agencies/{agency_id}/properties/{property_id}/providers Grant property access to a provider
PUT /agencies/{agency_id}/properties/{property_id}/provider Update information related to the publishing of the property
get /agencies/{agency_id}/properties/{property_id}/crossings Crossing list (matched requests) for a specific property

Agencies/requests

HTTP method Path Function
get /agencies/{agency_id}/requests Retrieve the requests list
post /agencies/{agency_id}/requests Create a new request
put /agencies/{agency_id}/requests/{request_id} Update a request
get /agencies/{agency_id}/requests/{request_id}/crossings Crossing list (matched properties) for a specific request

Agencies/residences

HTTP method Path Function
get /agencies/{agency_id}/residences Retrieve the residences list

Agencies/users

HTTP method Path Function
get /agencies/{agency_id}/users Retrieve the users list
get /agencies/{agency_id}/users/{user_id}/actions Retrieve actions list of a specific user

This site is protected by reCAPTCHA and the Google Privacy Policy and Terms of Service apply.