Get the list of all the properties.
Endpoint:
| Status | ||||
|---|---|---|---|---|
|
...
Parameter
...
Type
...
Description
...
api_key
...
/analytics/listings/
Use this endpoint to retrieve all listings for a given property manager.
...
QUERY PARAMS
usr string required | API_key for your company, provided by Icnea. |
client_id |
integer required | Property Manager ID |
...
exclude_active boolean | Set to true to return only unlisted listings. Default is false. |
...
RESPONSES
| Status | ||||
|---|---|---|---|---|
|
| Code Block | ||
|---|---|---|
| ||
{
"servicesanalytics_get_propertieslistings_response": {
"propertieslistings": [
{
"listing_id": 12341001,
"nameactive": "Apartment Auri",
"address": "Sant Josep, 6",
"zip": "08042",
"city": "Manresa",
"country": "ES",
"latitude": 41.7394834834,
"longitude": 1.3472934234,
"checkin_start": "14:00",
"checkin_end": "16:00",
"checkout_start": "9:00",
true"
"checkout_end": "11:00",
"property_type": "apartment"
}, {
"listing_id": 12341002,
"nameactive": "Apartment Gaia",
"address": "Sant Josep, 6",
"zip": "08042",
"city": "Manresa",
"country": "ES",
"latitude": 41.7394834834,
"longitude": 1.3472934234,
"checkin_start": "14:00",
"checkin_end": "16:00",
"checkout_start": "9:00",
"checkout_end": "11:00",false"
"property_type": "apartment"
}
]
}
} |
ParameterField | Type | Description | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
listing_id | integer | Unique I ID of the property. 5-digits (in testing accounts) or 8-digits (in real accounts) number. | |||||||||||
nameactive | string | address | string | zip | string | city | string | country | string | latitude | decimal | longitude | decimal |
checkin_start | string | The default check_in start time, in 24h format. | |||||||||||
checkin_end | string | The default check_in end time, in 24h format. | |||||||||||
checkout_start | string | The default check_out start time, in 24h format. | |||||||||||
checkout_end | string | The default check_out end time, in 24h format. | |||||||||||
property_type | string | Options: apartment, house, studio, hotel, hostel, room, camping, boat, autocaravanboolean | True or false. |
| Status | ||||
|---|---|---|---|---|
|
| Code Block | ||
|---|---|---|
| ||
{
"analytics_listings_response": {
"error_code": "",
"error_message": ""
}
} |
Field | Type | Description |
|---|---|---|
error_code | string | Icnea internal error_id to help with debugging. |
error_message | string | Human readable description of error. |