Listings
Listing details
GET /listings/{id}
Get details object for a given listing.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | Autohost listing ID |
| pms | query | QueryParamPMS | false | PMS integration name. If supplied, the API will perform a lookup using the PMS listing ID or the identifier supplied in my_id |
| x-api-key | header | string | false | API Authentication Key |
Enumerated Values
| Parameter | Value |
|---|---|
| pms | api |
| pms | apaleo |
| pms | beds24 |
| pms | booking |
| pms | cloudbeds |
| pms | guesty |
| pms | hostaway |
| pms | hostfully |
| pms | inforhms |
| pms | impala |
| pms | lavanda |
| pms | myvr |
| pms | opera |
| pms | smartbnb |
| pms | stayntouch |
| pms | streamline |
| pms | trackhs |
Example responses
200 Response
{
"id": "string",
"my_id": "string",
"user_id": "string",
"status": "string",
"name": "string",
"nickname": "string",
"property_type": "string",
"accommodates": 0,
"bedrooms": 0,
"bathrooms": 0,
"beds": 0,
"check_in_time": 0,
"check_out_time": 0,
"location": {
"street": "string",
"city": "string",
"state": "string",
"country": "string",
"time_zone_name": "string",
"building": "string"
},
"created_at": "string",
"updated_at": "string"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A listing object | ListingDetailsResponse |
| 400 | Bad Request | An error message | ErrorResponse |
Code samples
"""
Python Code Snippet
"""
import requests
headers = {
'Accept': 'application/json',
'x-api-key': 'string'
}
r = requests.get('https://data.autohost.ai/v1/listings/{id}', headers=headers)
print(r.json())
/*
TypeScript Code Snippet
*/
import fetch from 'node-fetch';
const headers = {
'Accept':'application/json',
'x-api-key':'string'
};
const response = await fetch('https://data.autohost.ai/v1/listings/{id}', {
method: 'get',
headers,
});
const responseJson = await response.json();
console.log(responseJson);
Listing update
PUT /listings/{id}
Update a given listing in your account.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | Autohost listing ID |
| callback | query | QueryParamCallback | false | Webhook URL to POST the list object. |
| x-api-key | header | string | false | API Authentication Key |
| body | body | ListingCreateRequest | false | JSON object with listing details |
Body parameter
{
"my_id": "UNIT100",
"status": "ACTIVE",
"name": "Beautiful Downtown View for Two",
"location": {
"street": "100 King West",
"city": "Toronto",
"country": "Canada",
"state": "ON",
"zipcode": "M5K 2A1",
"geo": {
"lat": 43.6486,
"lon": -79.3826
}
}
}
Example responses
200 Response
{
"id": "string",
"my_id": "string",
"user_id": "string",
"status": "string",
"name": "string",
"nickname": "string",
"property_type": "string",
"accommodates": 0,
"bedrooms": 0,
"bathrooms": 0,
"beds": 0,
"check_in_time": 0,
"check_out_time": 0,
"location": {
"street": "string",
"city": "string",
"state": "string",
"country": "string",
"time_zone_name": "string",
"building": "string"
},
"created_at": "string",
"updated_at": "string"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A listing object | ListingDetailsResponse |
| 400 | Bad Request | An error message | ErrorResponse |
Code samples
"""
Python Code Snippet
"""
import requests
input_body = {
"my_id": "UNIT100",
"status": "ACTIVE",
"name": "Beautiful Downtown View for Two",
"location": {
"street": "100 King West",
"city": "Toronto",
"country": "Canada",
"state": "ON",
"zipcode": "M5K 2A1",
"geo": {
"lat": 43.6486,
"lon": -79.3826
}
}
}
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'x-api-key': 'string'
}
r = requests.put('https://data.autohost.ai/v1/listings/{id}', json=input_body, headers=headers)
print(r.json())
/*
TypeScript Code Snippet
*/
import fetch from 'node-fetch';
const inputBody = {
"my_id": "UNIT100",
"status": "ACTIVE",
"name": "Beautiful Downtown View for Two",
"location": {
"street": "100 King West",
"city": "Toronto",
"country": "Canada",
"state": "ON",
"zipcode": "M5K 2A1",
"geo": {
"lat": 43.6486,
"lon": -79.3826
}
}
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'x-api-key':'string'
};
const response = await fetch('https://data.autohost.ai/v1/listings/{id}', {
method: 'put',
body: JSON.stringify(inputBody),
headers,
});
const responseJson = await response.json();
console.log(responseJson);
Listing search
GET /listings
Return paginated list of listings matching the search criteria.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| status | query | QueryParamListingStatus | false | Listing status |
| search | query | string | false | String search |
| building | query | string | false | Building name |
| x-api-key | header | string | false | API Authentication Key |
Enumerated Values
| Parameter | Value |
|---|---|
| status | ACTIVE |
| status | INACTIVE |
Example responses
200 Response
{
"total": 0,
"from": 0,
"size": 0,
"count": 0,
"items": [
{
"id": "string",
"status": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A list of listing objects | ListingSearchResponse |
| 400 | Bad Request | An error message | ErrorResponse |
Code samples
"""
Python Code Snippet
"""
import requests
headers = {
'Accept': 'application/json',
'x-api-key': 'string'
}
r = requests.get('https://data.autohost.ai/v1/listings', headers=headers)
print(r.json())
/*
TypeScript Code Snippet
*/
import fetch from 'node-fetch';
const headers = {
'Accept':'application/json',
'x-api-key':'string'
};
const response = await fetch('https://data.autohost.ai/v1/listings', {
method: 'get',
headers,
});
const responseJson = await response.json();
console.log(responseJson);
Listing create
POST /listings
Create a new listing in your account.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| callback | query | QueryParamCallback | false | Webhook URL to POST the list object. |
| x-api-key | header | string | false | API Authentication Key |
| body | body | ListingCreateRequest | false | JSON object with listing details |
Body parameter
{
"my_id": "UNIT100",
"status": "ACTIVE",
"name": "Beautiful Downtown View for Two",
"location": {
"street": "100 King West",
"city": "Toronto",
"country": "Canada",
"state": "ON",
"zipcode": "M5K 2A1",
"geo": {
"lat": 43.6486,
"lon": -79.3826
}
}
}
Example responses
200 Response
{
"id": "string",
"my_id": "string",
"user_id": "string",
"status": "string",
"name": "string",
"nickname": "string",
"property_type": "string",
"accommodates": 0,
"bedrooms": 0,
"bathrooms": 0,
"beds": 0,
"check_in_time": 0,
"check_out_time": 0,
"location": {
"street": "string",
"city": "string",
"state": "string",
"country": "string",
"time_zone_name": "string",
"building": "string"
},
"created_at": "string",
"updated_at": "string"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A listing object | ListingDetailsResponse |
| 400 | Bad Request | An error message | ErrorResponse |
Code samples
"""
Python Code Snippet
"""
import requests
input_body = {
"my_id": "UNIT100",
"status": "ACTIVE",
"name": "Beautiful Downtown View for Two",
"location": {
"street": "100 King West",
"city": "Toronto",
"country": "Canada",
"state": "ON",
"zipcode": "M5K 2A1",
"geo": {
"lat": 43.6486,
"lon": -79.3826
}
}
}
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'x-api-key': 'string'
}
r = requests.post('https://data.autohost.ai/v1/listings', json=input_body, headers=headers)
print(r.json())
/*
TypeScript Code Snippet
*/
import fetch from 'node-fetch';
const inputBody = {
"my_id": "UNIT100",
"status": "ACTIVE",
"name": "Beautiful Downtown View for Two",
"location": {
"street": "100 King West",
"city": "Toronto",
"country": "Canada",
"state": "ON",
"zipcode": "M5K 2A1",
"geo": {
"lat": 43.6486,
"lon": -79.3826
}
}
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'x-api-key':'string'
};
const response = await fetch('https://data.autohost.ai/v1/listings', {
method: 'post',
body: JSON.stringify(inputBody),
headers,
});
const responseJson = await response.json();
console.log(responseJson);
Listing property types
GET /listings/propertyTypes
Return a static list of supported property types. This list is used to populate the property_type field when creating a new listing object.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| x-api-key | header | string | false | API Authentication Key |
Example responses
A list of listing objects
[
"Apartment",
"Cottage",
"Condominium",
"House",
"Hotel",
"Boat",
"Camper/RV",
"Other"
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A list of listing objects | ListingPropertyTypesResponse |
Code samples
"""
Python Code Snippet
"""
import requests
headers = {
'Accept': 'application/json',
'x-api-key': 'string'
}
r = requests.get('https://data.autohost.ai/v1/listings/propertyTypes', headers=headers)
print(r.json())
/*
TypeScript Code Snippet
*/
import fetch from 'node-fetch';
const headers = {
'Accept':'application/json',
'x-api-key':'string'
};
const response = await fetch('https://data.autohost.ai/v1/listings/propertyTypes', {
method: 'get',
headers,
});
const responseJson = await response.json();
console.log(responseJson);
Listing manage SuperHog connection
POST /listings/{id}/superhog
Connect or disconnect your listings from SuperHog.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | Autohost listing ID |
| x-api-key | header | string | false | API Authentication Key |
| body | body | ListingSuperhogRequest | false | JSON object with listing details |
Body parameter
{
"action": "connect"
}
Example responses
Listing SuperHog connect or disconnect response
{
"autohost_id": "xyxyxyxyxyxyx",
"superhog_id": "abcd1234"
}
{
"autohost_id": "xyxyxyxyxyxyx",
"superhog_id": null
}
400 Response
{
"error": "string"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Listing SuperHog connect or disconnect response | ListingSuperhogResponse |
| 400 | Bad Request | An error message | ErrorResponse |
Code samples
"""
Python Code Snippet
"""
import requests
input_body = {
"action": "connect"
}
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'x-api-key': 'string'
}
r = requests.post('https://data.autohost.ai/v1/listings/{id}/superhog', json=input_body, headers=headers)
print(r.json())
/*
TypeScript Code Snippet
*/
import fetch from 'node-fetch';
const inputBody = {
"action": "connect"
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'x-api-key':'string'
};
const response = await fetch('https://data.autohost.ai/v1/listings/{id}/superhog', {
method: 'post',
body: JSON.stringify(inputBody),
headers,
});
const responseJson = await response.json();
console.log(responseJson);
Schemas
QueryParamPMS
"api"
QueryParamPMS
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| QueryParamPMS | string | false | none | PMS integration name. If supplied, the API will assume the path parameter id is a confirmation code. |
Enumerated Values
| Property | Value |
|---|---|
| QueryParamPMS | api |
| QueryParamPMS | apaleo |
| QueryParamPMS | beds24 |
| QueryParamPMS | booking |
| QueryParamPMS | cloudbeds |
| QueryParamPMS | guesty |
| QueryParamPMS | hostaway |
| QueryParamPMS | hostfully |
| QueryParamPMS | inforhms |
| QueryParamPMS | impala |
| QueryParamPMS | lavanda |
| QueryParamPMS | myvr |
| QueryParamPMS | opera |
| QueryParamPMS | smartbnb |
| QueryParamPMS | stayntouch |
| QueryParamPMS | streamline |
| QueryParamPMS | trackhs |
ListingDetailsResponse
{
"id": "string",
"my_id": "string",
"user_id": "string",
"status": "string",
"name": "string",
"nickname": "string",
"property_type": "string",
"accommodates": 0,
"bedrooms": 0,
"bathrooms": 0,
"beds": 0,
"check_in_time": 0,
"check_out_time": 0,
"location": {
"street": "string",
"city": "string",
"state": "string",
"country": "string",
"time_zone_name": "string",
"building": "string"
},
"created_at": "string",
"updated_at": "string"
}
ListingDetailsResponse
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string | false | none | none |
| my_id | string | false | none | none |
| user_id | string | false | none | none |
| status | string | false | none | none |
| name | string | false | none | none |
| nickname | string | false | none | none |
| property_type | string | false | none | none |
| accommodates | number | false | none | none |
| bedrooms | number | false | none | none |
| bathrooms | number | false | none | none |
| beds | number | false | none | none |
| check_in_time | number | false | none | none |
| check_out_time | number | false | none | none |
| location | object | false | none | none |
| » street | string | false | none | none |
| » city | string | false | none | none |
| » state | string | false | none | none |
| » country | string | false | none | none |
| » time_zone_name | string | false | none | none |
| » building | string | false | none | none |
| created_at | string | false | none | none |
| updated_at | string | false | none | none |
ErrorResponse
{
"error": "string"
}
ErrorResponse
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| error | string | false | none | none |
ListingCreateRequest
{
"id": "string",
"my_id": "string",
"status": "ACTIVE",
"name": "string",
"nickname": "string",
"property_type": "Apartment",
"accommodates": 0,
"bedrooms": 0,
"bathrooms": 0,
"beds": 0,
"check_in_time": 0,
"check_out_time": 0,
"location": {
"street": "string",
"city": "string",
"country": "string",
"country_code": "string",
"state": "string",
"zipcode": "string",
"timezone": "string",
"building": "string",
"address": "string",
"floor": "string",
"apartment": "string",
"geo": {
"lat": 0,
"lon": 0
}
},
"pictures": {
"large_url": "string",
"regular_url": "string",
"thumbnail_url": "string"
}
}
ListingCreateRequest
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string | false | none | Autohost listing ID. Used for updating an existing listing. |
| my_id | string | true | none | Your unique identifier for this listing. Alphanumeric characters only, no spaces or special characters. |
| status | string | true | none | Listing status. Must be ACTIVE or INACTIVE. |
| name | string | true | none | Public-facing name for the listing. |
| nickname | string | false | none | Internal nickname for the listing. Defaults to the value of name if not provided. |
| property_type | string | false | none | Type of property for risk assessment. |
| accommodates | number | false | none | Maximum number of guests. Defaults to 2. |
| bedrooms | number | false | none | Number of bedrooms. Defaults to 1. |
| bathrooms | number | false | none | Number of bathrooms. Defaults to 1. |
| beds | number | false | none | Number of beds. Defaults to 1. |
| check_in_time | number | false | none | Check-in hour (0-24). Defaults to 16. |
| check_out_time | number | false | none | Check-out hour (0-24). Defaults to 11. |
| location | object | true | none | Listing location. Required fields: street, city, country, state, zipcode. Timezone is derived automatically if not provided (from geo coordinates first, then via address geocoding as a deprecated fallback). Providing timezone or geo coordinates directly is recommended. |
| » street | string | true | none | Street address. |
| » city | string | true | none | City name. |
| » country | CountryName | true | none | Common English country name accepted by the Autohost API. These are everyday English names, not formal ISO 3166-1 names (e.g. use 'United States' not 'United States of America', 'Russia' not 'Russian Federation'). Alternatively, pass a 2-letter ISO 3166-1 alpha-2 code in the country field and it will be resolved automatically. |
| » country_code | string | false | none | ISO 3166-1 alpha-2 country code (e.g. 'US', 'CA', 'GB'). Optional — derived automatically from country if not provided. |
| » state | string | false | none | State or province code (e.g. ON, CA, NY). |
| » zipcode | string | true | none | Postal or ZIP code. |
| » timezone | string | true | none | IANA timezone identifier (e.g. America/Toronto, Europe/London). Optional — if not provided, derived from geo coordinates (preferred) or via address geocoding (deprecated fallback). Recommended to provide explicitly or via geo coordinates. |
| » building | string | false | none | Building identifier for grouping listings. Alphanumeric only, no spaces or special characters. |
| » address | string | false | none | Full formatted address string. |
| » floor | string | false | none | Floor number. |
| » apartment | string | false | none | Apartment or unit number. |
| » geo | object | false | none | Geographic coordinates. |
| »» lat | number | false | none | Latitude. |
| »» lon | number | false | none | Longitude. |
| pictures | object | false | none | Listing images. If not provided on creation, default images are used. |
| » large_url | string | false | none | URL for the large listing image. |
| » regular_url | string | false | none | URL for the regular listing image. |
| » thumbnail_url | string | false | none | URL for the thumbnail listing image. |
Enumerated Values
| Property | Value |
|---|---|
| status | ACTIVE |
| status | INACTIVE |
| property_type | Apartment |
| property_type | House |
| property_type | Loft |
| property_type | Boat |
| property_type | Camper/RV |
| property_type | Condominium |
| property_type | Serviced Apartment |
| property_type | Cottage |
| property_type | Chalet |
| property_type | Bed&Breakfast |
| property_type | Villa |
| property_type | Tent |
| property_type | Other |
| property_type | Cabin |
| property_type | Townhouse |
| property_type | Bungalow |
| property_type | Hut |
| property_type | Dorm |
| property_type | Parking Space |
| property_type | Plane |
| property_type | Treehouse |
| property_type | Yurt |
| property_type | Tipi |
| property_type | Igloo |
| property_type | Earth House |
| property_type | Island |
| property_type | Cave |
| property_type | Castle |
| property_type | Studio |
| property_type | Hotel |
CountryName
"Afghanistan"
CountryName
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| CountryName | string | false | none | Common English country name accepted by the Autohost API. These are everyday English names, not formal ISO 3166-1 names (e.g. use 'United States' not 'United States of America', 'Russia' not 'Russian Federation'). Alternatively, pass a 2-letter ISO 3166-1 alpha-2 code in the country field and it will be resolved automatically. |
Enumerated Values
| Property | Value |
|---|---|
| CountryName | Afghanistan |
| CountryName | Albania |
| CountryName | Algeria |
| CountryName | American Samoa |
| CountryName | Andorra |
| CountryName | Angola |
| CountryName | Anguilla |
| CountryName | Antarctica |
| CountryName | Antigua and Barbuda |
| CountryName | Argentina |
| CountryName | Armenia |
| CountryName | Aruba |
| CountryName | Australia |
| CountryName | Austria |
| CountryName | Azerbaijan |
| CountryName | Bahamas |
| CountryName | Bahrain |
| CountryName | Bangladesh |
| CountryName | Barbados |
| CountryName | Belarus |
| CountryName | Belgium |
| CountryName | Belize |
| CountryName | Benin |
| CountryName | Bermuda |
| CountryName | Bhutan |
| CountryName | Bolivia |
| CountryName | Bosnia and Herzegovina |
| CountryName | Botswana |
| CountryName | Brazil |
| CountryName | British Indian Ocean Territory |
| CountryName | British Virgin Islands |
| CountryName | Brunei |
| CountryName | Bulgaria |
| CountryName | Burkina Faso |
| CountryName | Burundi |
| CountryName | Cambodia |
| CountryName | Cameroon |
| CountryName | Canada |
| CountryName | Cape Verde |
| CountryName | Cayman Islands |
| CountryName | Central African Republic |
| CountryName | Chad |
| CountryName | Chile |
| CountryName | China |
| CountryName | Christmas Island |
| CountryName | Cocos Islands |
| CountryName | Colombia |
| CountryName | Comoros |
| CountryName | Cook Islands |
| CountryName | Costa Rica |
| CountryName | Croatia |
| CountryName | Cuba |
| CountryName | Curacao |
| CountryName | Cyprus |
| CountryName | Czech Republic |
| CountryName | Democratic Republic of the Congo |
| CountryName | Denmark |
| CountryName | Djibouti |
| CountryName | Dominica |
| CountryName | Dominican Republic |
| CountryName | East Timor |
| CountryName | Ecuador |
| CountryName | Egypt |
| CountryName | El Salvador |
| CountryName | Equatorial Guinea |
| CountryName | Eritrea |
| CountryName | Estonia |
| CountryName | Ethiopia |
| CountryName | Falkland Islands |
| CountryName | Faroe Islands |
| CountryName | Fiji |
| CountryName | Finland |
| CountryName | France |
| CountryName | French Polynesia |
| CountryName | Gabon |
| CountryName | Gambia |
| CountryName | Georgia |
| CountryName | Germany |
| CountryName | Ghana |
| CountryName | Gibraltar |
| CountryName | Greece |
| CountryName | Greenland |
| CountryName | Grenada |
| CountryName | Guam |
| CountryName | Guatemala |
| CountryName | Guernsey |
| CountryName | Guinea |
| CountryName | Guinea-Bissau |
| CountryName | Guyana |
| CountryName | Haiti |
| CountryName | Honduras |
| CountryName | Hong Kong |
| CountryName | Hungary |
| CountryName | Iceland |
| CountryName | India |
| CountryName | Indonesia |
| CountryName | Iran |
| CountryName | Iraq |
| CountryName | Ireland |
| CountryName | Isle of Man |
| CountryName | Israel |
| CountryName | Italy |
| CountryName | Ivory Coast |
| CountryName | Jamaica |
| CountryName | Japan |
| CountryName | Jersey |
| CountryName | Jordan |
| CountryName | Kazakhstan |
| CountryName | Kenya |
| CountryName | Kiribati |
| CountryName | Kosovo |
| CountryName | Kuwait |
| CountryName | Kyrgyzstan |
| CountryName | Laos |
| CountryName | Latvia |
| CountryName | Lebanon |
| CountryName | Lesotho |
| CountryName | Liberia |
| CountryName | Libya |
| CountryName | Liechtenstein |
| CountryName | Lithuania |
| CountryName | Luxembourg |
| CountryName | Macau |
| CountryName | Macedonia |
| CountryName | Madagascar |
| CountryName | Malawi |
| CountryName | Malaysia |
| CountryName | Maldives |
| CountryName | Mali |
| CountryName | Malta |
| CountryName | Marshall Islands |
| CountryName | Mauritania |
| CountryName | Mauritius |
| CountryName | Mayotte |
| CountryName | Mexico |
| CountryName | Micronesia |
| CountryName | Moldova |
| CountryName | Monaco |
| CountryName | Mongolia |
| CountryName | Montenegro |
| CountryName | Montserrat |
| CountryName | Morocco |
| CountryName | Mozambique |
| CountryName | Myanmar |
| CountryName | Namibia |
| CountryName | Nauru |
| CountryName | Nepal |
| CountryName | Netherlands |
| CountryName | Netherlands Antilles |
| CountryName | New Caledonia |
| CountryName | New Zealand |
| CountryName | Nicaragua |
| CountryName | Niger |
| CountryName | Nigeria |
| CountryName | Niue |
| CountryName | North Korea |
| CountryName | Northern Mariana Islands |
| CountryName | Norway |
| CountryName | Oman |
| CountryName | Pakistan |
| CountryName | Palau |
| CountryName | Palestine |
| CountryName | Panama |
| CountryName | Papua New Guinea |
| CountryName | Paraguay |
| CountryName | Peru |
| CountryName | Philippines |
| CountryName | Pitcairn |
| CountryName | Poland |
| CountryName | Portugal |
| CountryName | Puerto Rico |
| CountryName | Qatar |
| CountryName | Republic of the Congo |
| CountryName | Reunion |
| CountryName | Romania |
| CountryName | Russia |
| CountryName | Rwanda |
| CountryName | Saint Barthelemy |
| CountryName | Saint Helena |
| CountryName | Saint Kitts and Nevis |
| CountryName | Saint Lucia |
| CountryName | Saint Martin |
| CountryName | Saint Pierre and Miquelon |
| CountryName | Saint Vincent and the Grenadines |
| CountryName | Samoa |
| CountryName | San Marino |
| CountryName | Sao Tome and Principe |
| CountryName | Saudi Arabia |
| CountryName | Senegal |
| CountryName | Serbia |
| CountryName | Seychelles |
| CountryName | Sierra Leone |
| CountryName | Singapore |
| CountryName | Sint Maarten |
| CountryName | Slovakia |
| CountryName | Slovenia |
| CountryName | Solomon Islands |
| CountryName | Somalia |
| CountryName | South Africa |
| CountryName | South Korea |
| CountryName | South Sudan |
| CountryName | Spain |
| CountryName | Sri Lanka |
| CountryName | Sudan |
| CountryName | Suriname |
| CountryName | Svalbard and Jan Mayen |
| CountryName | Swaziland |
| CountryName | Sweden |
| CountryName | Switzerland |
| CountryName | Syria |
| CountryName | Taiwan |
| CountryName | Tajikistan |
| CountryName | Tanzania |
| CountryName | Thailand |
| CountryName | Togo |
| CountryName | Tokelau |
| CountryName | Tonga |
| CountryName | Trinidad and Tobago |
| CountryName | Tunisia |
| CountryName | Turkey |
| CountryName | Turkmenistan |
| CountryName | Turks and Caicos Islands |
| CountryName | Tuvalu |
| CountryName | U.S. Virgin Islands |
| CountryName | Uganda |
| CountryName | Ukraine |
| CountryName | United Arab Emirates |
| CountryName | United Kingdom |
| CountryName | United States |
| CountryName | Uruguay |
| CountryName | Uzbekistan |
| CountryName | Vanuatu |
| CountryName | Vatican |
| CountryName | Venezuela |
| CountryName | Vietnam |
| CountryName | Wallis and Futuna |
| CountryName | Western Sahara |
| CountryName | Yemen |
| CountryName | Zambia |
| CountryName | Zimbabwe |
QueryParamCallback
"string"
QueryParamCallback
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| QueryParamCallback | string | false | none | none |
QueryParamListingStatus
"ACTIVE"
QueryParamListingStatus
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| QueryParamListingStatus | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| QueryParamListingStatus | ACTIVE |
| QueryParamListingStatus | INACTIVE |
ListingSearchResponse
{
"total": 0,
"from": 0,
"size": 0,
"count": 0,
"items": [
{
"id": "string",
"status": "string"
}
]
}
ListingSearchResponse
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| total | number | false | none | none |
| from | number | false | none | none |
| size | number | false | none | none |
| count | number | false | none | none |
| items | [object] | false | none | none |
| » id | string | false | none | none |
| » status | string | false | none | none |
ListingPropertyTypesResponse
[
"string"
]
ListingPropertyTypesResponse
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| ListingPropertyTypesResponse | [string] | false | none | Listing property types |
ListingSuperhogRequest
{
"action": "connect"
}
ListingSuperhogRequest
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| action | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| action | connect |
| action | disconnect |
ListingSuperhogResponse
{
"autohost_id": "string",
"superhog_id": "string"
}
ListingSuperhogResponse
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| autohost_id | string | false | none | none |
| superhog_id | string | false | none | none |