Agencies/properties
Available methods
get Retrieve the properties list /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: 1000, default: 1000)
- offset The number of records to skip (default: 0)
- timestamp Return records created or updated since this UNIX/POSIX timestamp
- step Return records with specific step (in progress, pending, …)
- status Return records with specific status
- group Return records with specific group
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, …)
- status Status of the property (subcategory of step)
- group Group of the database (can be ignored)
- 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)
- altitude Altitude in meters
-
area Array
- unit ID of the area 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
- value Value of the price
- max Max value of the price
- fees Value of the rental fees
- unit ID of the area unit
- 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
- id Unique ID of the residence/building
- type Type of residence/building/property
- type Type of view
- method Array of construction method
- type Type of floor
- device Device of heating
- hot_device Type of boiler
- name Name of the style
- name Number of facades of the property
- comment Array of customized tags (different for each agency)
- 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
- type Type of media (video, html, …)
- value Content of the media
- language Language of comment
- title Main title
- subtitle Subtitle
- hook Hook
- comment Comment (can be full)
- comment_full Full comment (can be empty)
- type Type of floor
Response body private mode
- owner Owner reference linked to contact endpoint
-
visit Array
- contact Contact for visiting, reference linked to contact endpoint
- comment Visit instructions
-
price Array
- commission_owner Commission for the owner
- commission_customer Commission for the customer
- net_seller Net seller amount after deduction of commissions
- estimation Array
- negotiable Value of negotiable price
- 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
curl --request GET \
--url 'https://api.apimo.pro/agencies/{agency_id}/properties' \
--user 'provider:token'
<?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);
$output = curl_exec($ch);
curl_close($ch);
$values = json_decode($output, true);
?>
Example response
HTTP/1.1 200 OK
Server: nginx
Date: Sat, 21 Dec 2024 17:20:58 +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 property /agencies/{agency_id}/properties
Path parameters
- agency_id The unique id for the real estate agency
Request body parameters
- reference Your unique ID for this property (required)
- user Unique ID of the user (required)
- step Main step (in progress, pending, …)
- status Status of the property (subcategory of step)
- group Group of the database
- 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
- publish_address If you can publish the address details true/false
- address Address, street name
- address_more More details about address
- city Unique ID of the city - or - Name of the city
- zipcode Postal code of the property
- district Unique ID of the district - or - Name of the district
- country Country code ISO 3166-1 alpha-2
- longitude GPS longitude
- latitude GPS latitude
-
area Array
- unit ID of the area 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)
- sleeps Number of sleeps
-
price Array
- value Value of the price
- max Max value of the price
- fees Value of the rental fees
- 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_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
- negotiable Value of negotiable price
- owner Unique ID of the contact (owner)
-
view Array
- type Type of view
- landscape Array of landscape
-
construction Array
- method Array of construction method
- construction_year Year of the construction
- renovation_year Year of the renovation
-
floor Array
- type Type of floor
- levels Levels number of the property inside the building
- floors Floors number of the building
-
heating Array
- device Device of heating
- access Heating access
- type Type of heating
-
water Array
- hot_device Type of boiler
- hot_access Hot water access
- waste Type of waste water
- condition Condition of the property
- standing Standing of the property (High standard, luxury)
- facades Number of facades of 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)
- orientations Array of orientations
- services Array of services
- proximities Array of proxitimies
- activities Array of activities
- tags Array of tags
- tags_customized Array of customized tags (different for each agency)
-
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
- ceiling_height Ceiling height of this room/area
- floor
- orientations Array of orientations
-
comments Array
- language Language code ISO 639-1
- comment Comment of this room/area
-
regulations Array
- type Type of regulation, diagnostics or laws specifications
- value Value of this regulation
- date Date of the regulation
- url Dedicated website for the property
- filling_rate Filling rate
- private_comment Private description
Response body
- id Unique ID to store for any update (PUT method)
- created_at Date/time of the first creation
- updated_at Date/time of the last update
Example request
curl --request POST \
--url 'https://api.apimo.pro/agencies/{agency_id}/properties' \
--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}/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, '{ }');
$output = curl_exec($ch);
curl_close($ch);
$values = json_decode($output, true);
?>
Example response
HTTP/1.1 200 OK
Server: nginx
Date: Sat, 21 Dec 2024 17:20:58 +0100
Content-Type: application/json; charset=utf-8
Content-Length: 137
Connection: keep-alive
Vary: Accept-Encoding
{"id":"19344239","created_at":"2020-02-18 15:02:34","updated_at":"2020-02-18 15:52:26"}
put Update a property /agencies/{agency_id}/properties/{property_id}
Path parameters
- agency_id The unique id for the real estate agency
- property_id The unique id of the property to update
Request body parameters
- reference Your unique ID for this property (required)
- user Unique ID of the user
- step Main step (in progress, pending, …)
- status Status of the property (subcategory of step)
- group Group of the database
- 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
- publish_address If you can publish the address details true/false
- address Address, street name
- address_more More details about address
- city Unique ID of the city - or - Name of the city
- zipcode Postal code of the property
- district Unique ID of the district - or - Name of the district
- country Country code ISO 3166-1 alpha-2
- longitude GPS longitude
- latitude GPS latitude
-
area Array
- unit ID of the area 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)
- sleeps Number of sleeps
-
price Array
- value Value of the price
- max Max value of the price
- fees Value of the rental fees
- 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_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
- negotiable Value of negotiable price
- owner Unique ID of the contact (owner)
-
view Array
- type Type of view
- landscape Array of landscape
-
construction Array
- method Array of construction method
- construction_year Year of the construction
- renovation_year Year of the renovation
-
floor Array
- type Type of floor
- levels Levels number of the property inside the building
- floors Floors number of the building
-
heating Array
- device Device of heating
- access Heating access
- type Type of heating
-
water Array
- hot_device Type of boiler
- hot_access Hot water access
- waste Type of waste water
- condition Condition of the property
- standing Standing of the property (High standard, luxury)
- facades Number of facades of 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)
- orientations Array of orientations
- services Array of services
- proximities Array of proxitimies
- activities Array of activities
- tags Array of tags
- tags_customized Array of customized tags (different for each agency)
-
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
- ceiling_height Ceiling height of this room/area
- floor
- orientations Array of orientations
-
comments Array
- language Language code ISO 639-1
- comment Comment of this room/area
-
regulations Array
- type Type of regulation, diagnostics or laws specifications
- value Value of this regulation
- date Date of the regulation
- url Dedicated website for the property
- filling_rate Filling rate
- private_comment Private description
Response body
- id Unique ID to store for any update (PUT method)
- created_at Date/time of the first creation
- updated_at Date/time of the last update
Example request
curl --request PUT \
--url 'https://api.apimo.pro/agencies/{agency_id}/properties/{property_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}/properties/{property_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: Sat, 21 Dec 2024 17:20:58 +0100
Content-Type: application/json; charset=utf-8
Content-Length: 137
Connection: keep-alive
Vary: Accept-Encoding
{"id":"19344239","created_at":"2020-02-18 15:02:34","updated_at":"2020-02-18 15:52:26"}
post Add/embed a media (virtual tour, video …) /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 Type of media (1: Dailymotion, 2: Youtube, 9: HTML, 12: Matterport, 15: Vimeo, 19: Clap.video)
- content HTML content or HTTP link of the media
Response body
- None
Example request
curl --request POST \
--url 'https://api.apimo.pro/agencies/{agency_id}/properties/{property_id}/medias' \
--user 'provider:token'
\
--header 'content-type: application/json' \
--data '{ , "type": "2", "content": "https://youtu.be/JGowo0ARgPo" }' \
--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, '{ , "type": "2", "content": "https://youtu.be/JGowo0ARgPo" }');
$output = curl_exec($ch);
curl_close($ch);
$values = json_decode($output, true);
?>
Example response
HTTP/1.1 200 OK
Server: nginx
Date: Sat, 21 Dec 2024 17:20:58 +0100
Content-Type: application/json; charset=utf-8
Content-Length: 137
Connection: keep-alive
Vary: Accept-Encoding
{"id":123456}
delete Delete a media (virtual tour, video …) /agencies/{agency_id}/properties/{property_id}/medias/{media_id}
Path parameters
- agency_id The unique id for the real estate agency
- property_id The unique id for the real estate property
- media_id The unique id for the real estate media
Request body parameters
- None
Response body
- None
Example request
curl --request DELETE \
--url 'https://api.apimo.pro/agencies/{agency_id}/properties/{property_id}/medias/{media_id}' \
--user 'provider:token'
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.apimo.pro/agencies/{agency_id}/properties/{property_id}/medias/{media_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: Sat, 21 Dec 2024 17:20:58 +0100
Content-Type: application/json; charset=utf-8
Content-Length: 137
Connection: keep-alive
Vary: Accept-Encoding
{"success":true}
post Update a picture /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
- comments Array of comments ([ {"language":"fr","comment":"commentaire photo"}, {"language":"en","comment":"picture comment"} ])
Response body
- None
Example request
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": "6766eaeaa5f14", "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": "6766eaeaa5f14", "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: Sat, 21 Dec 2024 17:20:58 +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
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: Sat, 21 Dec 2024 17:20:58 +0100
Content-Type: application/json; charset=utf-8
Content-Length: 137
Connection: keep-alive
Vary: Accept-Encoding
{"success":true}
post Add a document /agencies/{agency_id}/properties/{property_id}/documents
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
- name Document file name
- type_id Document type
- content Base64 content of the real estate document
Response body
- None
Example request
curl --request POST \
--url 'https://api.apimo.pro/agencies/{agency_id}/properties/{property_id}/documents' \
--user 'provider:token'
\
--header 'content-type: application/json' \
--data '{ "name": "6766eaeaa5f1a", "content": "[base64 content … ]" }' \
--include
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.apimo.pro/agencies/{agency_id}/properties/{property_id}/documents');
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, '{ "name": "6766eaeaa5f1a", "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: Sat, 21 Dec 2024 17:20:58 +0100
Content-Type: application/json; charset=utf-8
Content-Length: 137
Connection: keep-alive
Vary: Accept-Encoding
{"id":5480610,"name":"Document.pdf","download_url":"...","url":"...","filesize":"1000","type_id":1,"internet":false,"extranet":false,"private":true,"created_at":"2023-01-01 10:00:00","updated_at":"2023-01-01 10:00:00"}
delete Delete a document inside a property /agencies/{agency_id}/properties/{property_id}/documents/{document_id}
Path parameters
- agency_id The unique id for the real estate agency
- property_id The unique id for the real estate property
- document_id The unique id for the real estate document
Request body parameters
- None
Response body
- None
Example request
curl --request DELETE \
--url 'https://api.apimo.pro/agencies/{agency_id}/properties/{property_id}/documents/{document_id}' \
--user 'provider:token'
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.apimo.pro/agencies/{agency_id}/properties/{property_id}/documents/{document_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: Sat, 21 Dec 2024 17:20:58 +0100
Content-Type: application/json; charset=utf-8
Content-Length: 137
Connection: keep-alive
Vary: Accept-Encoding
{"success":true}
post Add/Update a comment /agencies/{agency_id}/properties/{property_id}/comments
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
- language Language code ISO 639-1 of the comment
- title Title of the property
- subtitle Subtitle of the property
- hook Hook of the property
- comment Full description of the property
Response body
- None
Example request
curl --request POST \
--url 'https://api.apimo.pro/agencies/{agency_id}/properties/{property_id}/comments' \
--user 'provider:token'
\
--header 'content-type: application/json' \
--data '{ "language": "en", "title": "Property title", "subtitle": "Property subtitle", "hook": "Property hook", "comment": "Full property description" }' \
--include
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.apimo.pro/agencies/{agency_id}/properties/{property_id}/comments');
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, '{ "language": "en", "title": "Property title", "subtitle": "Property subtitle", "hook": "Property hook", "comment": "Full property description" }');
$output = curl_exec($ch);
curl_close($ch);
$values = json_decode($output, true);
?>
Example response
HTTP/1.1 200 OK
Server: nginx
Date: Sat, 21 Dec 2024 17:20:58 +0100
Content-Type: application/json; charset=utf-8
Content-Length: 137
Connection: keep-alive
Vary: Accept-Encoding
{"id":123456}
get Provider list for a specific property /agencies/{agency_id}/properties/{property_id}/providers
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
- provider Unique reference of the provider
- step 1: active, 2: not active
Response body
- None
Example request
curl --request GET \
--url 'https://api.apimo.pro/agencies/{agency_id}/properties/{property_id}/providers' \
--user 'provider:token'
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.apimo.pro/agencies/{agency_id}/properties/{property_id}/providers');
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: Sat, 21 Dec 2024 17:20:58 +0100
Content-Type: application/json; charset=utf-8
Content-Length: 137
Connection: keep-alive
Vary: Accept-Encoding
{"provider":100,"step":1}
post Grant property access to a provider /agencies/{agency_id}/properties/{property_id}/providers
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
- provider Unique reference of the provider
- step 1: active, 2: not active
Response body
- None
Example request
curl --request POST \
--url 'https://api.apimo.pro/agencies/{agency_id}/properties/{property_id}/providers' \
--user 'provider:token'
\
--header 'content-type: application/json' \
--data '{ , "step": "1" }' \
--include
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.apimo.pro/agencies/{agency_id}/properties/{property_id}/providers');
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, '{ , "step": "1" }');
$output = curl_exec($ch);
curl_close($ch);
$values = json_decode($output, true);
?>
Example response
HTTP/1.1 200 OK
Server: nginx
Date: Sat, 21 Dec 2024 17:20:58 +0100
Content-Type: application/json; charset=utf-8
Content-Length: 137
Connection: keep-alive
Vary: Accept-Encoding
{"providers":[{"provider":100,"step":1},{"provider":230,"step":4}]}
PUT Update information related to the publishing of the property /agencies/{agency_id}/properties/{property_id}/provider
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
- url URL of the property on the portal or website
- date Publication date of the property
Response body
- None
Example request
curl --request PUT \
--url 'https://api.apimo.pro/agencies/{agency_id}/properties/{property_id}/provider' \
--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}/properties/{property_id}/provider');
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: Sat, 21 Dec 2024 17:20:58 +0100
Content-Type: application/json; charset=utf-8
Content-Length: 137
Connection: keep-alive
Vary: Accept-Encoding
null
get Crossing list (matched requests) for a specific property /agencies/{agency_id}/properties/{property_id}/crossings
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
- 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
- step Return records with specific step
Response body
- total_items The total number of item regardless of pagination
- timestamp UNIX/POSIX timestamp of the most recent item inside this list
-
crossings Array
- request_id Unique ID of the request
- step_id 1: To suggest, 2: Already suggested, 3: Not suggested
- total Score from 0 to 100
- created_at Date/time of the first creation
- updated_at Date/time of the last update
Example request
curl --request GET \
--url 'https://api.apimo.pro/agencies/{agency_id}/properties/{property_id}/crossings' \
--user 'provider:token'
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.apimo.pro/agencies/{agency_id}/properties/{property_id}/crossings');
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: Sat, 21 Dec 2024 17:20:58 +0100
Content-Type: application/json; charset=utf-8
Content-Length: 137
Connection: keep-alive
Vary: Accept-Encoding
{"total_items":1,"timestamp":1397115438,"crossings":[{"request_id":1234567,"step_id":1,"total":"100","created_at":"2010-10-08 15:12:02","updated_at":"2014-04-10 09:37:18"}]}