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

All information about the agency with the: users, properties, some settings, ….

Available methods

HTTP method Path Function
get /agencies Retrieve the business units list
get /agencies/{agency_id}/users Retrieve the users list of a specific business unit
get /agencies/{agency_id}/users/{user_id}/actions Retrieve the users list of a specific user from a business unit
post /agencies/{agency_id}/actions Create a new action inside a business unit
put /agencies/{agency_id}/actions/{action_id} Update an action inside a business unit
get /agencies/{agency_id}/contacts Retrieve the contacts list of a specific business unit
post /agencies/{agency_id}/contacts Create a new contact inside a business unit
put /agencies/{agency_id}/contacts/{contact_id} Update a contact inside a business unit
get /agencies/{agency_id}/leads Retrieve the leads list of a specific business unit
post /agencies/{agency_id}/leads Create a new lead inside a business unit
get /agencies/{agency_id}/properties Retrieve the properties list of a specific business unit
post /agencies/{agency_id}/properties/{property_id}/medias Create a new media content inside a property of a specific business unit
post /agencies/{agency_id}/properties/{property_id}/pictures Add a new picture inside a property of a specific business unit
delete /agencies/{agency_id}/properties/{property_id}/pictures/{picture_id} Delete a picture inside a property
get /agencies/{agency_id}/residences Retrieve the residences list of a specific business unit
get /agencies/{agency_id}/requests Retrieve the requests list of a specific business unit
get /agencies/{agency_id}/contracts Retrieve the contracts list of a specific business unit

get Retrieve the business units list /agencies

Path parameters

  • None

Request body parameters

  • limit  The number of records to return (max: 200, default: 100)
  • 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' \
--header 'content-type: application/json' \
--data '{ "limit": "100" }' \
--include
<?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);
curl_setopt($ch, CURLOPT_HTTPHEADER, array('Content-Type: application/json'));
curl_setopt($ch, CURLOPT_POSTFIELDS, '{ "limit": "100" }');
$output = curl_exec($ch);
curl_close($ch);
$values = json_decode($output, true);
?>

Example response

HTTP/1.1 200 OK
Server: nginx
Date: Tue, 12 Nov 2019 09:31:47 +0100
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}

get Retrieve the users list of a specific business unit /agencies/{agency_id}/users

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)

Response body

  • id  Unique ID
  • agency  Unique ID of the agency (should be equal to {agency_id})
  • active  true/false (boolean)
  • created_at  Date of the first creation
  • updated_at  Date of the last update
  • firstname  Firstname
  • lastname  Lastname
  • username  Login
  • password  Password (encrypted)
  • group  Group (please report to user_group)
  • email  e-mail address
  • phone  Phone number
  • mobile  Mobile number
  • fax  Fax number
  • timezone  Timezone (timezone list)
  • picture  URL for picture

Response body private mode

  • birthday_at  Birthday date

Example request

Console
PHP
curl --request GET \
--url 'https://api.apimo.pro/agencies/{agency_id}/users' \
--user 'provider:token' \
--header 'content-type: application/json' \
--data '{ "limit": "100" }' \
--include
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.apimo.pro/agencies/{agency_id}/users');
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, '{ "limit": "100" }');
$output = curl_exec($ch);
curl_close($ch);
$values = json_decode($output, true);
?>

Example response

HTTP/1.1 200 OK
Server: nginx
Date: Tue, 12 Nov 2019 09:31:47 +0100
Content-Type: application/json; charset=utf-8
Content-Length: 137
Connection: keep-alive
Vary: Accept-Encoding

{"users":[{"id":"9","agency":"14","active":true,"created_at":"2008-02-05 17:53:03","updated_at":"2016-04-15 23:07:33","firstname":"Marc","lastname":"WYLER","username":"mylogin","password":"*********","group":"2","email":"NO-SPAM@swissmedimmo.com","phone":null,"mobile":"+33620000000","fax":null,"birthday_at":"1965-01-01","timezone":"Europe\/Paris","picture":"https:\/\/api.apimo.pro\/uploads\/user\/9\/picture_200.jpg"}],"total_items":1}

get Retrieve the users list of a specific user from a business unit /agencies/{agency_id}/users/{user_id}/actions

Path parameters

  • agency_id  The unique id for the real estate agency
  • user_id  The unique id for the user/agent

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

  • id  Unique ID
  • type  Type of the action
  • user  Unique ID of the user (should be equal to {user_id})
  • contact  Unique ID of the contact
  • date  Date of the action
  • time_start  Start time of the action
  • time_end  End time of the action
  • subject  Subject of the action (can be the subject of an e-mail)
  • content  Content of the action (can be the body of an e-mail)
  • properties  List of properties
  • referral  Referral of the action
  • subreferral  Sub-referral of the action
  • created_at  Date of the first creation
  • updated_at  Date of the last update

Example request

Console
PHP
curl --request GET \
--url 'https://api.apimo.pro/agencies/{agency_id}/users/{user_id}/actions' \
--user 'provider:token' \
--header 'content-type: application/json' \
--data '{ "limit": "1000" }' \
--include
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.apimo.pro/agencies/{agency_id}/users/{user_id}/actions');
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, '{ "limit": "1000" }');
$output = curl_exec($ch);
curl_close($ch);
$values = json_decode($output, true);
?>

Example response

HTTP/1.1 200 OK
Server: nginx
Date: Tue, 12 Nov 2019 09:31:47 +0100
Content-Type: application/json; charset=utf-8
Content-Length: 137
Connection: keep-alive
Vary: Accept-Encoding

{"actions":[{"id":"19344999","type":"2","user":"1234","contact":"8520201","date":"2018-09-11","time_start":"14:43:20","time_end":"15:43:00","subject":"More details on a new property","content":"Hello, \u2026","properties":{"id":"233030","report":null,"price":"2600000","currency":"EUR","rating":null,"assessment":null},"referral":null,"subreferral":null,"created_at":"2018-09-11 14:43:20","updated_at":"2018-09-11 14:43:20"}],"total_items":1}

post Create a new action inside a business unit /agencies/{agency_id}/actions

Path parameters

  • agency_id  The unique id for the real estate agency

Request body parameters

  • user  Unique ID of the user
  • type  Action type
  • method  Action method
  • date  Date of the action (format YYYY-MM-DD)
  • start_at  Start time (HH:MM)
  • end_at  End time (HH:MM)
  • contact  Unique ID of the contact
  • properties  Node of properties ID
  • subject  Subject content of the action
  • content  All content of the action
  • referral  Sub-origine of the action

Response body

  • id  Unique ID

Example request

Console
PHP
curl --request POST \
--url 'https://api.apimo.pro/agencies/{agency_id}/actions' \
--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}/actions');
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);
?>

Example response

HTTP/1.1 200 OK
Server: nginx
Date: Tue, 12 Nov 2019 09:31:47 +0100
Content-Type: application/json; charset=utf-8
Content-Length: 137
Connection: keep-alive
Vary: Accept-Encoding

{"id":"19344239"}

put Update an action inside a business unit /agencies/{agency_id}/actions/{action_id}

Path parameters

  • agency_id  The unique id of the action to update

Request body parameters

  • user  Unique ID of the user
  • type  Action type
  • method  Action method
  • date  Date of the action (format YYYY-MM-DD)
  • start_at  Start time (HH:MM)
  • end_at  End time (HH:MM)
  • contact  Unique ID of the contact
  • properties  Node of properties ID
  • subject  Subject content of the action
  • content  All content of the action
  • referral  Sub-origine of the action

Response body

  • id  Unique ID

Example request

Console
PHP
curl --request PUT \
--url 'https://api.apimo.pro/agencies/{agency_id}/actions/{action_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}/actions/{action_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);
?>

Example response

HTTP/1.1 200 OK
Server: nginx
Date: Tue, 12 Nov 2019 09:31:47 +0100
Content-Type: application/json; charset=utf-8
Content-Length: 137
Connection: keep-alive
Vary: Accept-Encoding

{"id":"19344239"}

get Retrieve the contacts list of a specific business unit /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: 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

Example request

Console
PHP
curl --request GET \
--url 'https://api.apimo.pro/agencies/{agency_id}/contacts' \
--user 'provider:token' \
--header 'content-type: application/json' \
--data '{ "limit": "100" }' \
--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, '{ "limit": "100" }');
$output = curl_exec($ch);
curl_close($ch);
$values = json_decode($output, true);
?>

post Create a new contact inside a business unit /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

Example request

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

Example response

HTTP/1.1 200 OK
Server: nginx
Date: Tue, 12 Nov 2019 09:31:47 +0100
Content-Type: application/json; charset=utf-8
Content-Length: 137
Connection: keep-alive
Vary: Accept-Encoding

{"id":"3021944"}

put Update a contact inside a business unit /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

Example request

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

Example response

HTTP/1.1 200 OK
Server: nginx
Date: Tue, 12 Nov 2019 09:31:47 +0100
Content-Type: application/json; charset=utf-8
Content-Length: 137
Connection: keep-alive
Vary: Accept-Encoding

{"id":"3021944"}

get Retrieve the leads list of a specific business unit /agencies/{agency_id}/leads

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
  • leads  Array
    • id  Unique ID
    • parent  Parent ID (for skip some duplicate leads)
    • provider  Unique ID of the provider
    • type  Type of lead
    • step  Step of the lead
    • date  Date of contact
    • reference  The reference sent by the provider
    • lastname  Lastname of the contact
    • firstname  Firstname of the contact
    • email  e-mail address
    • phone  Phone number
    • fax  Fax number
    • mobile  Mobile phone number
    • contact  Link to contact
    • request  Link to request
    • 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}/leads' \
--user 'provider:token' \
--header 'content-type: application/json' \
--data '{ "limit": "100" }' \
--include
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.apimo.pro/agencies/{agency_id}/leads');
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, '{ "limit": "100" }');
$output = curl_exec($ch);
curl_close($ch);
$values = json_decode($output, true);
?>

Example response

HTTP/1.1 200 OK
Server: nginx
Date: Tue, 12 Nov 2019 09:31:47 +0100
Content-Type: application/json; charset=utf-8
Content-Length: 137
Connection: keep-alive
Vary: Accept-Encoding

{"leads":[{"id":170384,"parent":null,"provider":9999,"type":"1","step":"1","date":"2016-01-10 15:49:00","reference":"XYZ0001","lastname":"FRIN","firstname":"Marc","email":"frin.mac@myemail.com","phone":"+1-555-9090909","fax":"","mobile":"","contact":"4942871","request":null,"created_at":"2016-03-10 15:49:50","updated_at":"2016-04-25 16:31:52"}],"total_items":63,"timestamp":1461594712}

post Create a new lead inside a business unit /agencies/{agency_id}/leads

Path parameters

  • agency_id  The unique id for the real estate agency

Request body parameters

  • reference  Your own unique reference
  • date  Date time of your request (Mysql Format: Y-m-d H:i:s)
  • step  Step of the lead (default: 1)
  • type  Type of the lead
  • language  Language code <a href="https://en.wikipedia.org/wiki/ISO_639-1" target="_blank">ISO 639-1</a> of the customer
  • country  Country code <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2" target="_blank">ISO 3166-1 alpha-2</a> of the customer
  • title  Title of the customer
  • lastname  Lastname of the customer
  • firstname  Firstname of the customer
  • email  e-mail address of the customer
  • phone  Phone number of the customer
  • fax  Fax number of the customer
  • mobile  Cellphone number of the customer
  • address  Postal address of the customer
  • address_more  More information about the postal address of the customer
  • zipcode  Postal code of the customer
  • city  City of the customer
  • message  Free text for the request
  • recipient_lastname  Lastname of the recipient (for send to a friend function)
  • recipient_firstname  Firstname of the recipient (for send to a friend function)
  • recipient_email  e-mail address of the recipient (for send to a friend function)
  • area_min  Minimum area criteria
  • area_max  Maximum area criteria
  • area_unit  ID of the area unit
  • room_min  Minimum rooms criteria
  • room_max  Maximum rooms criteria
  • bedroom_min  Minimum bedrooms criteria
  • bedroom_max  Maximum bedrooms criteria
  • price_min  Minimum price criteria
  • price_max  Maximum price criteria
  • currency  Currency <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO 4217</a> of the customer
  • start_at  Rental start at criteria (Mysql format)
  • end_at  Rental end at criteria (Mysql format)
  • property_reference  Reference of the property
  • property_address  Address of the property
  • property_address_more  More information of the address of the property
  • property_zipcode  Postal code of the property
  • property_city  City of the property
  • property_country  Country of the property
  • property_category  Category of the property
  • property_types  Types of the property (separe with a comma)
  • property_sybtype  Subtype of the property
  • property_view_landscape  View of the property
  • property_location  location of the property

Response body

  • None

Example request

Console
PHP
curl --request POST \
--url 'https://api.apimo.pro/agencies/{agency_id}/leads' \
--user 'provider:token' \
--header 'content-type: application/json' \
--data '{ "reference": "5dca6df37c604", "date": "2019-11-12 09:31:47", "step": "1", "type": "1", "language": "fr", "country": "FR", "title": "1", "lastname": "MARTIN", "firstname": "Jean", "email": "jean.martin@emailaddress.com", "phone": "+33106060600", "fax": "+33106060601", "mobile": "+33606060606", "address": "131 rue d Antibes", "address_more": "Second floor", "zipcode": "06400", "city": "Cannes", "message": "Hello, please can you call me back. Jean", "recipient_lastname": "DUPONT", "recipient_firstname": "Monique", "recipient_email": "monique.dupont@emailaddress.com", "area_min": "80", "area_max": "120", "area_unit": "1", "room_min": "1", "room_max": "4", "bedroom_min": "1", "bedroom_max": "3", "price_min": "400000", "price_max": "450000", "currency": "EUR", "start_at": "2016-08-01", "end_at": "2016-08-31", "property_reference": "123456", "property_address": "80 boulevard de la Croisette", "property_address_more": "Immeuble Azur", "property_zipcode": "06400", "property_city": "Cannes", "property_country": "FR", "property_category": "1", "property_types": "1,2,3", "property_sybtype": "3", "property_view_landscape": "1", "property_location": "6" }' \
--include
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.apimo.pro/agencies/{agency_id}/leads');
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, '{ "reference": "5dca6df37c604", "date": "2019-11-12 09:31:47", "step": "1", "type": "1", "language": "fr", "country": "FR", "title": "1", "lastname": "MARTIN", "firstname": "Jean", "email": "jean.martin@emailaddress.com", "phone": "+33106060600", "fax": "+33106060601", "mobile": "+33606060606", "address": "131 rue d Antibes", "address_more": "Second floor", "zipcode": "06400", "city": "Cannes", "message": "Hello, please can you call me back. Jean", "recipient_lastname": "DUPONT", "recipient_firstname": "Monique", "recipient_email": "monique.dupont@emailaddress.com", "area_min": "80", "area_max": "120", "area_unit": "1", "room_min": "1", "room_max": "4", "bedroom_min": "1", "bedroom_max": "3", "price_min": "400000", "price_max": "450000", "currency": "EUR", "start_at": "2016-08-01", "end_at": "2016-08-31", "property_reference": "123456", "property_address": "80 boulevard de la Croisette", "property_address_more": "Immeuble Azur", "property_zipcode": "06400", "property_city": "Cannes", "property_country": "FR", "property_category": "1", "property_types": "1,2,3", "property_sybtype": "3", "property_view_landscape": "1", "property_location": "6" }');
$output = curl_exec($ch);
curl_close($ch);
$values = json_decode($output, true);
?>

Example response

HTTP/1.1 200 OK
Server: nginx
Date: Tue, 12 Nov 2019 09:31:47 +0100
Content-Type: application/json; charset=utf-8
Content-Length: 137
Connection: keep-alive
Vary: Accept-Encoding

{"id":188699,"created_at":"2016-04-29 16:17:23","updated_at":"2016-04-29 16:17:23"}

get Retrieve the properties list of a specific business unit /agencies/{agency_id}/properties

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
  • properties  Array
    • id  Unique ID of the property
    • reference  Human readable reference
    • agency  Unique ID of the agency
    • user  Array
      • id  Unique ID of the user
      • agency  Unique ID of the agency (can be different from {agency_id})
      • active  User again active or not
      • created_at  Date/time of the first creation
      • updated_at  Date/time of the last update
      • firstname  Firstname of the user
      • lastname  Lastname of the user
      • language  Language code ISO 639-1 of the user
      • group  Group/profile of the user
      • email  e-mail address
      • phone  Phone number with country code
      • fax  Fax number with country code
      • mobile  Mobile number with country code
      • birthday_at  Birthday date
      • timezone  Local timezone of the user
      • picture  HTTP link to the picture
    • step  Main step (in progress, pending, …)
    • parent  Parent ID (example: link between an apartment inside a new construction)
    • ranking  Ranking of the property from 1 to 5
    • category  Category of the property (sale, rental, …)
    • subcategory  Subcategory of the property (bulk sale, holiday rental, …)
    • name  Name of the property
    • type  Type of the property (apartment, house, …)
    • subtype  Subtype of the property (studio, penthouse, villa, …)
    • agreement  Array
      • type  Type of agreement
      • reference  Human readable reference
      • start_at  Start date of agreement
      • end_at  End date of agreement
    • block_name  Building name/reference
    • lot_reference  Lot reference
    • cadastre_reference  Cadastral reference
    • stairs_reference  Stairs reference
    • address  Address of the property
    • address_more  More details about the address
    • publish_address  If you can publish the address details
    • country  Country code ISO 3166-1 alpha-2
    • region  Array
      • id  Unique ID of the region
      • name  Name of the region
    • city  Array
      • id  Unique ID of the city
      • name  Name of the city
      • zipcode  Postal code of the property
    • district  Array
      • id  Unique ID of the city
      • name  Name of the district
    • location  Array
      • comment  [DEPRECATED] Location of the property (center, seaside, …)
    • longitude  GPS longitude
    • latitude  GPS latitude
    • radius  Radius of GPS coordinates in meters (equal to 0 if publish_address is 1)
    • area  Array
      • unit  Unique ID of the unit
      • value  Decimal value of the area
      • total  Decimal value of the total area (should be greater than value)
      • weighted  Decimal value of the weighted area
    • rooms  Number of rooms (can be decimal for some countries)
    • bedrooms  Number of bedrooms
    • sleeps  Number of sleeps
    • price  Array
      • value  Value of the price
      • max  Max value of the price
      • fees  Fees included
      • unit  ID of the area unit
      • period  Rent frequency
      • hide  Hide the price (true/false)
      • inventory  Fees for inventory in case of rentals
      • deposit  Deposit for the customer
      • currency  Currency ISO 4217
      • commission  Commission for the customer
      • commission_owner  Commission for the owner
      • commission_customer  Commission for the customer
      • contribution  Value of the initial contribution (for life annuity)
      • pension  Value of the pension (for life annuity)
      • tenant  Value of the current rental
      • sold  The final price in case of sale
      • sold_at  The date of contract in case of sale
      • estimation  Array
        • min  Minimum estimated price
        • max  Maximum estimated price
    • rates  Array
      • step  1 for available / 2 for booked
      • start_at  Arrival day
      • end_at  Departure day
      • price  Price for the proposed period
      • days  Number of days
    • residence  Array
    • view  Array
    • construction  Array
    • floor  Array
      • type  Type of floor
      • value  Value of the floor (0 for ground, 1 for first floor, …, last for last floor)
      • levels  Levels number of the property inside the building
      • floors  Floors number of the building
    • heating  Array
    • water  Array
    • condition  Condition of the property
    • standing  Standing of the property (High standard, luxury)
    • style  Array
      • name  Name of the style
    • url  Dedicated website for the property
    • availability  Availability of the property
    • available_at  Date of availabilty (when the rental is free)
    • delivered_at  Date of delivery (for new construction)
    • activities  Array of activities
    • orientations  Array of orientations
    • services  Array of services
    • proximities  Array of proxitimies
    • tags  Array of tags
    • tags_customized  Array
      • comment  Array of customized tags (different for each agency)
    • pictures  Array
      • id  Unique ID of the picture
      • rank  Picture rank
      • url  Absolute link of the picture
      • width_max  Max width of the picture
      • height_max  Max height of the picture
      • comments  Array of comments
    • medias  Array
      • type  Type of media (video, html, …)
      • value  Content of the media
    • comments  Array
      • language  Language of comment
      • title  Main title
      • subtitle  Subtitle
      • hook  Hook
      • comment  Comment (can be full)
      • comment_full  Full comment (can be empty)
    • areas  Array
      • type  Type of area (bedroom, shower room, garden, parking, …)
      • number  Quantity of this room/area
      • area  Area of this room/area
      • flooring  Type of flooring
      • floor  Array
        • type  Type of floor
        • value  Value of the floor (0 for ground, 1 for first floor, …, last for last floor)
      • orientations  Array of orientations
      • comments  Array of comments
    • regulations  Array
    • financial  Array
    • created_at  Date/time of the first creation
    • updated_at  Date/time of the last update

Response body private mode

  • status  Status of the property (subcategory of step)
  • group  Group of the database (can be ignored)
  • agreement  Array
    • start_at  Agreement start at
    • end_at  Agreement end at
  • owner  Owner reference linked to contact endpoint
  • visit  Array
    • contact  Contact for visiting, reference linked to contact endpoint
    • comment  Visit instructions
  • exchanges  List of the portals to publish
  • filling_rate  Filling rate
  • private_comment  Private description
  • status_comment  Status description
  • logs  Array
    • field  Field updated
    • value  New value
    • date  Date of the update

Example request

Console
PHP
curl --request GET \
--url 'https://api.apimo.pro/agencies/{agency_id}/properties' \
--user 'provider:token' \
--header 'content-type: application/json' \
--data '{ "limit": "100" }' \
--include
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.apimo.pro/agencies/{agency_id}/properties');
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, '{ "limit": "100" }');
$output = curl_exec($ch);
curl_close($ch);
$values = json_decode($output, true);
?>

Example response

HTTP/1.1 200 OK
Server: nginx
Date: Tue, 12 Nov 2019 09:31:47 +0100
Content-Type: application/json; charset=utf-8
Content-Length: 137
Connection: keep-alive
Vary: Accept-Encoding

{"properties":[{"id":181297,"reference":"24367","user":10,"step":1,"status":1,"group":1,"parent":0,"category":2,"subcategory":21,"name":"","type":1,"subtype":5,"agreement":{"type":1,"reference":"1158","start_at":"2016-04-12","end_at":"2016-10-12"},"address":null,"address_more":null,"country":"FR","city":{"id":2123,"name":"Nice","zipcode":"06100"},"district":{"id":18,"name":"Gambetta"},"location":6,"longitude":7.25315,"latitude":43.69821,"area":{"unit":1,"value":52.12,"total":null},"rooms":"2.0","bedrooms":1,"sleeps":null,"price":{"value":750,"fees":70,"hide":false,"commission":null,"guarantee":750,"currency":"EUR","first_value":670},"residence":{"type":0,"fees":70,"lots":0},"view":{"type":3,"landscape":[]},"floor":{"type":5,"value":3},"heating":{"device":null,"access":1,"type":1},"water":{"hot_device":3,"hot_access":1,"waste":2},"condition":3,"standing":1,"style":{"name":"RECENT"},"activities":[],"orientations":[3],"services":[6,9,1,23],"proximities":[1,7,23,4,11,9,27,18,15,10],"tags":[],"pictures":[{"rank":1,"url":"https:\/\/s3-eu-west-1.amazonaws.com\/apimo\/pictures\/estate\/182\/181297\/1333698249570d11f3a8fe30.65435457_1024.jpg","width_max":1920,"height_max":1440,"comments":[]},{"rank":2,"url":"https:\/\/s3-eu-west-1.amazonaws.com\/apimo\/pictures\/estate\/182\/181297\/11754140635139d8635d6864.86036814_1024.jpg","width_max":1920,"height_max":1080,"comments":[]},{"rank":3,"url":"https:\/\/s3-eu-west-1.amazonaws.com\/apimo\/pictures\/estate\/182\/181297\/7580103925139d636a2a559.62635841_1024.jpg","width_max":1920,"height_max":1080,"comments":[]}],"medias":[],"comments":[{"language":"fr","title":"2P CENTRE NICE","subtitle":null,"hook":null,"comment":"GAMBETTA \/ CESSOLE, SPACIEUX 2P, de 52m\u00b2 expos\u00e9 \u2026","comment_full":null}],"areas":[{"type":"15","number":"1","area":null,"flooring":"2","floor":{"id":0,"value":null},"orientations":[],"comments":[]},{"type":"1","number":"1","area":12.88,"flooring":"1","floor":{"id":0,"value":null},"orientations":[3],"comments":[{"language":"fr","comment":"placard, BALCON 7.80m\u00b2"}]},{"type":"3","number":"1","area":null,"flooring":"2","floor":{"id":0,"value":null},"orientations":[3],"comments":[{"language":"fr","comment":"Am\u00e9ricaine \u00e9quip\u00e9e"}]},{"type":"20","number":"1","area":20.45,"flooring":"2","floor":{"id":0,"value":null},"orientations":[3],"comments":[{"language":"fr","comment":"balcon vue d\u00e9gag\u00e9e"}]},{"type":"41","number":"1","area":null,"flooring":"2","floor":{"id":0,"value":null},"orientations":[],"comments":[]},{"type":"6","number":"1","area":null,"flooring":null,"floor":{"id":0,"value":null},"orientations":[],"comments":[]}],"regulations":[{"type":4,"value":"1","date":"2013-03-08"},{"type":7,"value":"1","date":null}],"created_at":"2010-06-30 14:33:53","updated_at":"2016-04-12 22:30:45"}]}

post Create a new media content inside a property of a specific business unit /agencies/{agency_id}/properties/{property_id}/medias

Path parameters

  • agency_id  The unique id for the real estate agency
  • property_id  The unique id for the real estate property

Request body parameters

  • reference  Your own unique reference
  • type  Media type
  • content  URL or HTML content of the real estate media

Response body

  • None

Example request

Console
PHP
curl --request POST \
--url 'https://api.apimo.pro/agencies/{agency_id}/properties/{property_id}/medias' \
--user 'provider:token' \
--header 'content-type: application/json' \
--data '{ "reference": "5dca6df37c649", "type": "1" }' \
--include
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.apimo.pro/agencies/{agency_id}/properties/{property_id}/medias');
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, '{ "reference": "5dca6df37c649", "type": "1" }');
$output = curl_exec($ch);
curl_close($ch);
$values = json_decode($output, true);
?>

Example response

HTTP/1.1 200 OK
Server: nginx
Date: Tue, 12 Nov 2019 09:31:47 +0100
Content-Type: application/json; charset=utf-8
Content-Length: 137
Connection: keep-alive
Vary: Accept-Encoding

{"id":12345}

post Add a new picture inside a property of a specific business unit /agencies/{agency_id}/properties/{property_id}/pictures

Path parameters

  • agency_id  The unique id for the real estate agency
  • property_id  The unique id for the real estate property

Request body parameters

  • reference  Your own unique reference
  • content  Base64 content of the real estate picture

Response body

  • None

Example request

Console
PHP
curl --request POST \
--url 'https://api.apimo.pro/agencies/{agency_id}/properties/{property_id}/pictures' \
--user 'provider:token' \
--header 'content-type: application/json' \
--data '{ "reference": "5dca6df37c64b", "content": "[base64 content … ]" }' \
--include
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.apimo.pro/agencies/{agency_id}/properties/{property_id}/pictures');
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, '{ "reference": "5dca6df37c64b", "content": "[base64 content … ]" }');
$output = curl_exec($ch);
curl_close($ch);
$values = json_decode($output, true);
?>

Example response

HTTP/1.1 200 OK
Server: nginx
Date: Tue, 12 Nov 2019 09:31:47 +0100
Content-Type: application/json; charset=utf-8
Content-Length: 137
Connection: keep-alive
Vary: Accept-Encoding

{"id":66321497,"rank":1,"url":"https:\/\/d1qfj231ug7wdu.cloudfront.net\/pictures\/estate\/2612\/2611637\/17613436475c1bbd3b2f5720.93310060_1430.jpg","width_max":1430,"height_max":710}

delete Delete a picture inside a property /agencies/{agency_id}/properties/{property_id}/pictures/{picture_id}

Path parameters

  • agency_id  The unique id for the real estate agency
  • property_id  The unique id for the real estate property
  • picture_id  The unique id for the real estate picture

Request body parameters

  • None

Response body

  • None

Example request

Console
PHP
curl --request DELETE \
--url 'https://api.apimo.pro/agencies/{agency_id}/properties/{property_id}/pictures/{picture_id}' \
--user 'provider:token'
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.apimo.pro/agencies/{agency_id}/properties/{property_id}/pictures/{picture_id}');
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: Tue, 12 Nov 2019 09:31:47 +0100
Content-Type: application/json; charset=utf-8
Content-Length: 137
Connection: keep-alive
Vary: Accept-Encoding

{"success":true}

get Retrieve the residences list of a specific business unit /agencies/{agency_id}/residences

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 residence
    • user  Unique ID of the user
    • type  Type of residence/building/property
    • name  Name of the residence
    • reference  Reference of the residence
    • location_reference  Reference of the location
    • address  Address, street name
    • address_more  More details about address
    • city  Array
      • id  Unique ID of the city
      • name  Name of the city
      • zipcode  Postal code of the property
    • district  Array
      • id  Unique ID of the city
      • name  Name of the district
    • country  Country code ISO 3166-1 alpha-2
    • longitude  GPS longitude
    • latitude  GPS latitude
    • construction_year  Year of the construction
    • standing  Standing of the property (High standard, luxury)
    • floors  Floors number of the building
    • lots  Number of lots
    • total_shares  Total of shares
    • code  Entry code
    • code_at  Date of the last entry code
    • comment  Free comment
    • contacts  Array
      • comment  List of contacts
    • 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}/residences' \
--user 'provider:token' \
--header 'content-type: application/json' \
--data '{ "limit": "100" }' \
--include
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.apimo.pro/agencies/{agency_id}/residences');
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, '{ "limit": "100" }');
$output = curl_exec($ch);
curl_close($ch);
$values = json_decode($output, true);
?>

Example response

HTTP/1.1 200 OK
Server: nginx
Date: Tue, 12 Nov 2019 09:31:47 +0100
Content-Type: application/json; charset=utf-8
Content-Length: 137
Connection: keep-alive
Vary: Accept-Encoding

{"residences":[{"id":"35704","user":"8265","type":"2","name":"LES GLYCINES","reference":null,"location_reference":null,"address":"","address_more":"","city":{"id":"183085","name":"Aubonne","zipcode":"1170"},"district":null,"country":"CH","longitude":"6.39172","latitude":"46.49536","construction_year":null,"standing":null,"floors":"4","lots":"12","total_shares":null,"code":null,"code_at":null,"comment":null,"contacts":[],"created_at":"2015-11-17 14:13:44","updated_at":"2015-11-17 14:13:44"},{"id":"32265","user":"8266","type":"2","name":"LES INCAS","reference":null,"location_reference":null,"address":"7, route des Francs Tireurs","address_more":"","city":{"id":"182932","name":"Lausanne","zipcode":"1000"},"district":null,"country":"CH","longitude":"6.61116","latitude":"46.59880","construction_year":"2006","standing":"4","floors":"3","lots":"6","total_shares":null,"code":null,"code_at":null,"comment":null,"contacts":[{"contact":"4753321","type":"3","shares":"34.00","property":{"rooms":"3","bedrooms":"2","subtype":"63","area":"300.00","floor":{"type":23,"value":null}},"comment":"test"}],"created_at":"2015-07-22 13:39:46","updated_at":"2017-04-07 11:12:06"}],"total_items":2,"timestamp":1491556326}

get Retrieve the requests list of a specific business unit /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  Reference (ID) to the referral
    • subreferral  Reference (ID) to the sub referral (customized by each agency)
    • 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' \
--header 'content-type: application/json' \
--data '{ "limit": "100" }' \
--include
<?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);
curl_setopt($ch, CURLOPT_HTTPHEADER, array('Content-Type: application/json'));
curl_setopt($ch, CURLOPT_POSTFIELDS, '{ "limit": "100" }');
$output = curl_exec($ch);
curl_close($ch);
$values = json_decode($output, true);
?>

get Retrieve the contracts list of a specific business unit /agencies/{agency_id}/contracts

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 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' \
--header 'content-type: application/json' \
--data '{ "limit": "100" }' \
--include
<?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);
curl_setopt($ch, CURLOPT_HTTPHEADER, array('Content-Type: application/json'));
curl_setopt($ch, CURLOPT_POSTFIELDS, '{ "limit": "100" }');
$output = curl_exec($ch);
curl_close($ch);
$values = json_decode($output, true);
?>