Agencies/requests
Available methods
HTTP method | Path | Function |
---|---|---|
get | /agencies/{agency_id}/requests | Retrieve the requests list |
post | /agencies/{agency_id}/requests | Create a new request |
put | /agencies/{agency_id}/requests/{request_id} | Update a request |
get | /agencies/{agency_id}/requests/{request_id}/crossings | Crossing list (matched properties) for a specific request |
get Retrieve the requests list /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: 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 request
- active If the request is active (boolean)
- 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
-
emailing Array
- subscription Subscription to request emailing
- last_at Date of the last emailing action
- category Category of the property
- subcategory Subcategory of the property
- types Array of types
- subtype Subtype of the property
- referral Origin of the search
- subreferral Suborigin of the search
- country Country of the search
-
locations Array
- region Region of the search
- city City of the search
- district District of the search
- coordonates GPS coordinates
- sector Sector of the search (customized by each agency)
- rooms_operator 1: equal (=), 2: greater or equal (≥), 3: less or equal(≤)
- rooms Number of rooms (min.)
- bedrooms Number of bedrooms (min.)
- standing Standing of the property (High standard, luxury)
-
view Array
- type Type of view
- landscape Type of landscape
- min Area min.
- max Area max.
- unit ID of the area unit
- min Price min.
- max Price max.
- currency Currency ISO 4217
- operator 1: equal (=), 2: greater or equal (≥), 3: less or equal(≤)
- type Type of floor
Example request
curl --request GET \
--url 'https://api.apimo.pro/agencies/{agency_id}/requests' \
--user 'provider:token'
<?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);
$output = curl_exec($ch);
curl_close($ch);
$values = json_decode($output, true);
?>
Example response
HTTP/1.1 200 OK
Server: nginx
Date: Thu, 05 Dec 2024 12:04:46 +0100
Content-Type: application/json; charset=utf-8
Content-Length: 137
Connection: keep-alive
Vary: Accept-Encoding
{"requests":[{"id":156488,"active":false,"contact":"220351","user":"3896","ranking":null,"last_action":null,"auto":true,"validated":false,"emailing":{"subscription":"1","last_at":null},"category":"1","subcategory":null,"types":["1","2"],"subtype":null,"referral":null,"subreferral":null,"country":"FR","locations":[{"region":null,"city":{"id":"2039","name":"Antibes"},"district":null}],"coordinates":null,"sector":null,"zone":null,"rooms_operator":"2","rooms":null,"bedrooms":0,"standing":null,"view":{"type":null,"landscape":null},"condition":null,"availability":null,"margin":"10","area":{"min":"100","max":null,"unit":"1"},"price":{"min":null,"max":"400000","currency":"EUR"},"floor":{"operator":"1","type":null,"value":null},"areas":[{"type":18,"number":1,"area_min":null}],"proximities":[],"services":[],"activities":[],"tags":[],"tags_customized":[],"comment":"","free_criteria":"","created_at":"2010-10-08 15:12:02","created_by":"3896","updated_at":"2014-04-10 09:37:18","updated_by":"3896"}]}
post Create a new request /agencies/{agency_id}/requests
Path parameters
- agency_id The unique id for the real estate agency
Request body parameters
- active If the request is active (boolean)
- contact Reference (ID) of the contact (required)
- user Reference (ID) of the user (required)
- ranking Reference (ID) of the ranking
- last_action Date of the last action
- auto If the matching is automatic
-
emailing Array
- subscription Subscription to request emailing (only on creation)
- category Category of the property
- subcategory Subcategory of the property
- types Array of types
- subtype Subtype of the property
- referral Origin of the search
- subreferral Suborigin of the search
- country Country of the search (required)
- locations Array of locations or detailed locations: [{"city":"Cannes","district":"Centre"},{"city":"Cannes","district":"Croisette"},{"city":"Nice"},{"region":"Seine-et-Marne"}]
- sector Sector of the search (customized by each agency)
- rooms_operator 1: equal (=), 2: greater or equal (≥), 3: less or equal(≤)
- rooms Number of rooms (min.)
- bedrooms Number of bedrooms (min.)
- standing Standing of the property (High standard, luxury)
-
view Array
- type Type of view
- landscape Type of landscape
- condition Condition of the property
- availability Availability of the property
- margin Crossing margin in %
-
area Array
- min Area min.
- max Area max.
- unit ID of the area unit
-
price Array
- min Price min.
- max Price max.
- currency Currency ISO 4217
-
floor Array
- operator 1: equal (=), 2: greater or equal (≥), 3: less or equal(≤)
- type Type of floor
- value Value of the floor (0 for ground, 1 for first floor, …, last for last floor)
- areas Array of areas (bedroom, shower room, garden, parking, …)
- proximities Array of proxitimies
- services Array of services
- activities Array of activities
- tags Array of tags
- tags_customized Array of customized tags (different for each agency)
- comment Free text
- free_criteria Free text
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}/requests' \
--user 'provider:token'
\
--header 'content-type: application/json' \
--data '{ "active": "1", "contact": "5155262", "user": "3896", "ranking": "5", "last_action": "2020-05-27", "auto": "1", "category": "1", "subcategory": "", "types": "1,2", "subtype": "", "referral": "", "country": "FR", "locations": "Antibes, Nice, Paris 7ème", "rooms_operator": "2", "rooms": "4", "bedrooms": "2", "standing": "1", "condition": "1", "availability": "1", "margin": "10", "areas": "1,2,4", "proximities": "1,4", "services": "1,2,4", "activities": "1,5", "tags": "1,2,3", "comment": "Free text", "free_criteria": "More free text" }' \
--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, '{ "active": "1", "contact": "5155262", "user": "3896", "ranking": "5", "last_action": "2020-05-27", "auto": "1", "category": "1", "subcategory": "", "types": "1,2", "subtype": "", "referral": "", "country": "FR", "locations": "Antibes, Nice, Paris 7ème", "rooms_operator": "2", "rooms": "4", "bedrooms": "2", "standing": "1", "condition": "1", "availability": "1", "margin": "10", "areas": "1,2,4", "proximities": "1,4", "services": "1,2,4", "activities": "1,5", "tags": "1,2,3", "comment": "Free text", "free_criteria": "More free text" }');
$output = curl_exec($ch);
curl_close($ch);
$values = json_decode($output, true);
?>
Example response
HTTP/1.1 200 OK
Server: nginx
Date: Thu, 05 Dec 2024 12:04:46 +0100
Content-Type: application/json; charset=utf-8
Content-Length: 137
Connection: keep-alive
Vary: Accept-Encoding
{"id":1004656,"created_at":"2020-06-02 08:40:13","updated_at":"2020-06-02 08:40:13"}
put Update a request /agencies/{agency_id}/requests/{request_id}
Path parameters
- agency_id The unique id for the real estate agency
- request_id The unique id of the request
Request body parameters
- id Unique ID of the request
- active If the request is active (boolean)
- contact Reference (ID) of the contact (required)
- user Reference (ID) of the user (required)
- ranking Reference (ID) of the ranking
- last_action Date of the last action
- auto If the matching is automatic
- category Category of the property
- subcategory Subcategory of the property
- types Array of types
- subtype Subtype of the property
- referral Origin of the search
- subreferral Suborigin of the search
- country Country of the search (required)
- locations Array of locations or detailed locations: [{"city":"Cannes","district":"Centre"},{"city":"Cannes","district":"Croisette"},{"city":"Nice"},{"region":"Seine-et-Marne"}]
- sector Sector of the search (customized by each agency)
- rooms_operator 1: equal (=), 2: greater or equal (≥), 3: less or equal(≤)
- rooms Number of rooms (min.)
- bedrooms Number of bedrooms (min.)
- standing Standing of the property (High standard, luxury)
-
view Array
- type Type of view
- landscape Type of landscape
- condition Condition of the property
- availability Availability of the property
- margin Crossing margin in %
-
area Array
- min Area min.
- max Area max.
- unit ID of the area unit
-
price Array
- min Price min.
- max Price max.
- currency Currency ISO 4217
-
floor Array
- operator 1: equal (=), 2: greater or equal (≥), 3: less or equal(≤)
- type Type of floor
- value Value of the floor (0 for ground, 1 for first floor, …, last for last floor)
- areas Array of areas (bedroom, shower room, garden, parking, …)
- proximities Array of proxitimies
- services Array of services
- activities Array of activities
- tags Array of tags
- tags_customized Array of customized tags (different for each agency)
- comment Free text
- free_criteria Free text
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}/requests/{request_id}' \
--user 'provider:token'
\
--header 'content-type: application/json' \
--data '{ "id": "1004656", "active": "1", "contact": "5155262", "user": "3896", "ranking": "5", "last_action": "2020-05-27", "auto": "1", "category": "1", "subcategory": "", "types": "1,2", "subtype": "", "referral": "", "country": "FR", "locations": "Antibes, Nice, Paris 7ème", "rooms_operator": "2", "rooms": "4", "bedrooms": "2", "standing": "1", "condition": "1", "availability": "1", "margin": "10", "areas": "1,2,4", "proximities": "1,4", "services": "1,2,4", "activities": "1,5", "tags": "1,2,3", "comment": "Free text", "free_criteria": "More free text" }' \
--include
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.apimo.pro/agencies/{agency_id}/requests/{request_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, '{ "id": "1004656", "active": "1", "contact": "5155262", "user": "3896", "ranking": "5", "last_action": "2020-05-27", "auto": "1", "category": "1", "subcategory": "", "types": "1,2", "subtype": "", "referral": "", "country": "FR", "locations": "Antibes, Nice, Paris 7ème", "rooms_operator": "2", "rooms": "4", "bedrooms": "2", "standing": "1", "condition": "1", "availability": "1", "margin": "10", "areas": "1,2,4", "proximities": "1,4", "services": "1,2,4", "activities": "1,5", "tags": "1,2,3", "comment": "Free text", "free_criteria": "More free text" }');
$output = curl_exec($ch);
curl_close($ch);
$values = json_decode($output, true);
?>
Example response
HTTP/1.1 200 OK
Server: nginx
Date: Thu, 05 Dec 2024 12:04:46 +0100
Content-Type: application/json; charset=utf-8
Content-Length: 137
Connection: keep-alive
Vary: Accept-Encoding
{"id":1004656,"created_at":"2020-06-02 08:40:13","updated_at":"2020-06-02 08:40:13"}
get Crossing list (matched properties) for a specific request /agencies/{agency_id}/requests/{request_id}/crossings
Path parameters
- agency_id The unique id for the real estate agency
- request_id The unique id for the request
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
- property_id Unique ID of the property
- 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}/requests/{request_id}/crossings' \
--user 'provider:token'
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.apimo.pro/agencies/{agency_id}/requests/{request_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: Thu, 05 Dec 2024 12:04:46 +0100
Content-Type: application/json; charset=utf-8
Content-Length: 137
Connection: keep-alive
Vary: Accept-Encoding
{"total_items":1,"timestamp":1397115438,"crossings":[{"property_id":1234567,"step_id":1,"total":"100","created_at":"2010-10-08 15:12:02","updated_at":"2014-04-10 09:37:18"}]}