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.

Partenaires

Specification

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 (français) , it (italien) , de (allemand) , es (espagnol) , en (anglais) , nl (néerlandais) , zh (chinois) , ru (russe) , sv (suédois) , ar (arabe) , he (hébreu) , nb (norvégien bokmål) , pt (portugais)
  The Apimo API supports 3 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 or update a resources.
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 Get a list of real estate agencies
get /agencies/{agency_id}/users Get a list of users
get /agencies/{agency_id}/contacts Get a list of contacts
get /agencies/{agency_id}/leads Get a list of leads
post /agencies/{agency_id}/leads Create a new lead
get /agencies/{agency_id}/properties Get a list of properties
get /agencies/{agency_id}/residences Get a list of residences
get /agencies/{agency_id}/requests Get a list of requests
get /agencies/{agency_id}/contracts Get a list of contracts

Contact

Retrieve all details of a contact, best solution for customer extranet.

HTTP method Path Function
get /contact/{contact_id}/{contact_pwd} Get details of the contact