Webservice & API

Path parameters

• agency_id  The unique id for the real estate agency

Request body parameters

• limit  The number of records to return (max: 10000, default: 10000)
• 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 contract
  • step  Step the current contract
  • agency  Reference (ID) of the agency
  • property  Reference (ID) of the property
  • currency  Default currency ISO 4217
  • price  Final price of contract
  • price_net  Cash back to the owner
  • commission  Total commission of the deal
  • commission_agency  Commission of the agency
  • commission_owner  Commission for the owner
  • commission_customer  Commission for the customer
  • vat  Amount of VAT
  • vat_rate  Rate of the VAT
  • deposit  Amount of the deposit
  • project_at  Date of the project
  • offer_at  Date of offer
  • commitment_at  Date of commitment
  • condition_precedent_at  When the condition turn off
  • contract_scheduled_at  Scheduled of the contract
  • contract_at  Date of contract signed
  • collected_at  Date when you retrieved the cash $€
  • legal_notice_at  Date of legal notice
  • contacts  List of contacts
  • entries  List of entries
  • 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}/contracts' \
--user 'provider:token' <?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.apimo.pro/agencies/{agency_id}/contracts');
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);
?>