Maak een afspraak
apimo™

Webservice & API

Welkom bij onze API gewijd aan aanbieders van vastgoed, u vindt hier alle details van een makelaarskantoor met zijn producten, contacten en instellingen. Afhankelijk van uw rechten kunt u ook bepaalde informatie sturen zoals leads.

Partners

Contacteer ons

Agencies/contacts

Beschikbare methoden

HTTP-methode Pad Functie
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

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

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
  • contacts  Array

Voorbeeld verzoek

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

post Create a new contact /agencies/{agency_id}/contacts

Path parameters

  • agency_id  The unique id for the real estate agency

Request body parameters

Response body

  • id  Unique ID
  • created_at  Date/time of the first creation
  • updated_at  Date/time of the last update

Voorbeeld verzoek

Console
PHP
curl --request POST \
--url 'https://api.apimo.pro/agencies/{agency_id}/contacts' \
--user 'provider:token' \
--header 'content-type: application/json' \
--data '{ }' \
--include
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.apimo.pro/agencies/{agency_id}/contacts');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_USERPWD, 'provider:token');
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
curl_setopt($ch, CURLOPT_HTTPHEADER, array('Content-Type: application/json'));
curl_setopt($ch, CURLOPT_POSTFIELDS, '{ }');
$output = curl_exec($ch);
curl_close($ch);
$values = json_decode($output, true);
?>

Voorbeeld antwoord

HTTP/1.1 200 OK
Server: nginx
Date: Mon, 07 Oct 2024 15:46:13 +0200
Content-Type: application/json; charset=utf-8
Content-Length: 137
Connection: keep-alive
Vary: Accept-Encoding

{"id":"3021944"}

put Update a contact /agencies/{agency_id}/contacts/{contact_id}

Path parameters

  • agency_id  The unique id for the real estate agency
  • contact_id  The unique id for the contact to update

Request body parameters

Response body

  • id  Unique ID
  • created_at  Date/time of the first creation
  • updated_at  Date/time of the last update

Voorbeeld verzoek

Console
PHP
curl --request PUT \
--url 'https://api.apimo.pro/agencies/{agency_id}/contacts/{contact_id}' \
--user 'provider:token' \
--header 'content-type: application/json' \
--data '{ }' \
--include
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.apimo.pro/agencies/{agency_id}/contacts/{contact_id}');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_USERPWD, 'provider:token');
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
curl_setopt($ch, CURLOPT_HTTPHEADER, array('Content-Type: application/json'));
curl_setopt($ch, CURLOPT_POSTFIELDS, '{ }');
$output = curl_exec($ch);
curl_close($ch);
$values = json_decode($output, true);
?>

Voorbeeld antwoord

HTTP/1.1 200 OK
Server: nginx
Date: Mon, 07 Oct 2024 15:46:13 +0200
Content-Type: application/json; charset=utf-8
Content-Length: 137
Connection: keep-alive
Vary: Accept-Encoding

{"id":"3021944"}

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