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

Agencies

Available methods

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

get Retrieve the business units list /agencies

Path parameters

  • None

Request body parameters

  • limit  The number of records to return (max: 1000, default: 1000)
  • offset  The number of records to skip (default: 0)

Response body

  • total_items  The total number of item regardless of pagination
  • agencies  Array
    • id  Unique ID
    • active  true/false (boolean)
    • name  Name
    • company  Name of the company
    • brand  Member of a network/brand
    • address  Postal address
    • address_more  Postal address (more)
    • city  City object
    • country  Country code ISO 3166-1 alpha-2
    • region  Name of the region area
    • latitude  Latitude coordinates
    • longitude  Longitude coordinates
    • email  e-mail address
    • phone  Phone number
    • fax  Fax number
    • url  Website address (without http://)
    • logo  URL for logo
    • logo_svg  URL for logo in vector format (SVG)
    • picture  URL for picture
    • currency  Default currency ISO 4217
    • created_at  Date/time of the first creation
    • updated_at  Date/time of the last update

Response body private mode

  • agencies  Array
    • subscription  Subscription type

Example request

Console
PHP
curl --request GET \
--url 'https://api.apimo.pro/agencies' \
--user 'provider:token'
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.apimo.pro/agencies');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_USERPWD, 'provider:token');
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
$output = curl_exec($ch);
curl_close($ch);
$values = json_decode($output, true);
?>

Example response

HTTP/1.1 200 OK
Server: nginx
Date: Wed, 17 Apr 2024 17:50:43 +0200
Content-Type: application/json; charset=utf-8
Content-Length: 137
Connection: keep-alive
Vary: Accept-Encoding

{"agencies":[{"id":"14","active":true,"name":"SwissMedImmo","company":"WYLER IMMOBILIER","brand":null,"address":"22, rue Lepante","address_more":null,"city":{"id":"2123","name":"Nice","zipcode":"06000"},"country":"FR","region":"Alpes-Maritimes","latitude":"43.70522","longitude":"7.26951","email":"NO-SPAM@swissmedimmo.fr","phone":"+33497000462","fax":"+33497000464","url":"www.swissmedimmo.fr","logo":null,"logo_svg":null,"picture":"https:\/\/api.apimo.pro\/agency\/14\/photo_51750c7f4816a.jpg","currency":"EUR","created_at":"2007-03-27 17:15:43","updated_at":"2016-04-16 14:51:23"}],"total_items":1}

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