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

Request a free trial

Contact us

Agencies/requests

Available methods

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

get Retrieve the requests list /agencies/{agency_id}/requests

Path parameters

  • agency_id  The unique id for the real estate agency

Request body parameters

  • limit  The number of records to return (max: 200, default: 100)
  • offset  The number of records to skip (default: 0)
  • timestamp  Return records created or updated since this UNIX/POSIX timestamp

Response body

  • total_items  The total number of item regardless of pagination
  • timestamp  UNIX/POSIX timestamp of the most recent item inside this list
  • requests  Array
    • id  Unique ID of the request
    • activee  If the request is active
    • contact  Reference (ID) of the contact
    • user  Reference (ID) of the user
    • ranking  Reference (ID) of the ranking
    • last_action  Date of the last action
    • auto  If the matching is automatic
    • validated  If the system validated the automatic matching
    • category  Category of the property
    • subcategory  Sub category of the property
    • types  Array of types
    • subtype  Sub type of the property
    • referral  Origin of the search
    • subreferral  Sub-origin of the search
    • country  Country of the search
    • sector  Sector of the search (customized by each agency)
    • zone  Zone of the search (customized by each agency)
    • rooms  Number of rooms (min.)
    • bedrooms  Number of bedrooms (min.)
    • area  Array
      • min  Area min.
      • max  Area max.
    • price  Array
      • min  Price min.
      • max  Price max.
    • comment  Free text
    • created_at  Date/time of the first creation
    • updated_at  Date/time of the last update

Example request

Console
PHP
curl --request GET \
--url 'https://api.apimo.pro/agencies/{agency_id}/requests' \
--user 'provider:token'
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.apimo.pro/agencies/{agency_id}/requests');
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);
?>