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) | 
| Límite | 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 | 
| Idiomas | fr (francés) , it (italiano) , de (alemán) , es (español) , en (inglés) , nl (neerlandés) , zh (chino) , ru (ruso) , sv (sueco) , ar (árabe) , he (hebreo) , nb (noruego bokmal) , pt (portugués) , fa (persa) , lb (luxemburgués) , km (jemer) , tr (turco) , 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 | Make a PUT request to update a resource. | 
| DELETE | Make a DELETE request to remove a resource (be careful!). | 
Webservices
Catalogs
| HTTP method | Camino | Function | 
|---|---|---|
| get | /catalogs | Get a list of catalogs | 
| get | /catalogs/{catalogs_id} | Get a specific catalog | 
Agencies
| HTTP method | Camino | Function | 
|---|---|---|
| get | /agencies | Retrieve the business units list | 
Agencies/actions
| HTTP method | Camino | Function | 
|---|---|---|
| post | /agencies/{agency_id}/actions | Create a new action | 
| put | /agencies/{agency_id}/actions/{action_id} | Update an action | 
Agencies/contacts
| HTTP method | Camino | 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 | Camino | Function | 
|---|---|---|
| get | /agencies/{agency_id}/contracts | Retrieve the contracts list | 
Agencies/leads
| HTTP method | Camino | Function | 
|---|---|---|
| get | /agencies/{agency_id}/leads | Retrieve the leads list | 
| post | /agencies/{agency_id}/leads | Create a new lead | 
Agencies/properties
Agencies/requests
| HTTP method | Camino | 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 | Camino | Function | 
|---|---|---|
| get | /agencies/{agency_id}/residences | Retrieve the residences list | 
Agencies/users
| HTTP method | Camino | 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 |