apimo™

Webservice & API

Willkommen in unserer API für Immobilienanbieter, hier finden Sie alle Details einer Immobilienagentur mit ihren Anzeigen, Kontaktiert und einigen ihrer Parameter. Je nach Ihren Rechten können Sie auch Informationen wie Leads versenden.

Partner

Request a free trial

Kontaktieren Sie uns

Agencies/contacts

verfügbare Methoden

HTTP Methode Pfad Funktion
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

Pfadparameter

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

Beispiel einer Anfrage

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

Pfadparameter

  • 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

Beispiel einer Anfrage

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);
?>

Beispiel einer Antwort

HTTP/1.1 200 OK
Server: nginx
Date: Fri, 29 May 2020 10:01:22 +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}

Pfadparameter

  • 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

Beispiel einer Anfrage

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);
?>

Beispiel einer Antwort

HTTP/1.1 200 OK
Server: nginx
Date: Fri, 29 May 2020 10:01:22 +0200
Content-Type: application/json; charset=utf-8
Content-Length: 137
Connection: keep-alive
Vary: Accept-Encoding

{"id":"3021944"}