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.

Parceiros

Request a free trial

Contacte-nos

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 (francês) , it (italiano) , de (alemão) , es (espanhol) , en (inglês) , nl (neerlandês) , zh (chinês) , ru (russo) , sv (sueco) , ar (árabe) , he (hebraico) , nb (norueguês bokmål) , pt (português) , fa (persa) , lb (luxemburguês) , km (khmer) , tr (turco) , lo (laosiano)
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

Retrieve all the words and translations of the API.

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

Agencies

All information about the agency with the: users, properties, some settings, ….

HTTP method Path Function
get /agencies Retrieve the business units list
get /agencies/{agency_id}/users Retrieve the users list of a specific business unit
get /agencies/{agency_id}/users/{user_id}/actions Retrieve the users list of a specific user from a business unit
post /agencies/{agency_id}/actions Create a new action inside a business unit
put /agencies/{agency_id}/actions/{action_id} Update an action inside a business unit
get /agencies/{agency_id}/contacts Retrieve the contacts list of a specific business unit
post /agencies/{agency_id}/contacts Create a new contact inside a business unit
put /agencies/{agency_id}/contacts/{contact_id} Update a contact inside a business unit
get /agencies/{agency_id}/leads Retrieve the leads list of a specific business unit
post /agencies/{agency_id}/leads Create a new lead inside a business unit
get /agencies/{agency_id}/properties Retrieve the properties list of a specific business unit
post /agencies/{agency_id}/properties/{property_id}/medias Create a new media content inside a property of a specific business unit
post /agencies/{agency_id}/properties/{property_id}/pictures Add a new picture inside a property of a specific business unit
delete /agencies/{agency_id}/properties/{property_id}/pictures/{picture_id} Delete a picture inside a property
get /agencies/{agency_id}/residences Retrieve the residences list of a specific business unit
get /agencies/{agency_id}/requests Retrieve the requests list of a specific business unit
get /agencies/{agency_id}/contracts Retrieve the contracts list of a specific business unit