Get the Property Guide of a Property

GET/api/v1/properties/{id}/guide

Requires property_guide.read

The practical information a guest asks about: address and GPS coordinates, contact details, check-in and check-out times, Wi-Fi, bedrooms, beds and bathrooms, amenities, website texts, welcome booklet, the custom Shortcodes of the host that apply to the Property (with their value per language) and the active Knowledge of the account and of the Property.

An empty field is null, never omitted. A Property outside the Connection Scope answers not_found, exactly like a missing one.

Request

curl https://app.zenhost.com/api/v1/properties/7d1e4c09-2b5a-4e83-a6f0-91c8d3b2e4f7/guide \
  -H "Authorization: Bearer zh_at_..."

const response = await fetch('https://app.zenhost.com/api/v1/properties/7d1e4c09-2b5a-4e83-a6f0-91c8d3b2e4f7/guide', {
  headers: {
    Authorization: 'Bearer zh_at_...',
  },
});
const data = await response.json();

import requests

response = requests.get(
    "https://app.zenhost.com/api/v1/properties/7d1e4c09-2b5a-4e83-a6f0-91c8d3b2e4f7/guide",
    headers={"Authorization": "Bearer zh_at_..."},
)
data = response.json()

Response

{
  "property_id": "3f6c1a52-8d0e-4b7a-9f21-5c4e8b7d2a10",
  "name": "string",
  "address": {
    "street": "string",
    "postal_code": "string",
    "city": "string",
    "state": "string",
    "country": "string",
    "formatted": "string"
  },
  "coordinates": {
    "latitude": 1,
    "longitude": 1
  },
  "contact": {
    "phone": "+33612345678",
    "email": "camille@example.com",
    "website": "string"
  },
  "check_in_time": "string",
  "check_out_time": "string",
  "wifi": {
    "network_name": "string",
    "password": "string"
  },
  "rooms": {
    "bedrooms": 1,
    "beds": 1,
    "bathrooms": 1
  },
  "amenities": [
    {
      "id": "string",
      "name": "string"
    }
  ],
  "website_texts": [
    {
      "language": "string",
      "description": "string",
      "important_information": "string",
      "good_to_know": "string"
    }
  ],
  "welcome_booklet_url": "string",
  "shortcodes": [
    {
      "shortcode": "string",
      "name": "string",
      "description": "string",
      "values": [
        {
          "language": "string",
          "value": "string"
        }
      ]
    }
  ],
  "knowledge": [
    {
      "theme": "string",
      "kind": "fact",
      "content": "string"
    }
  ]
}

{
  "error": {
    "code": "unauthorized",
    "message": "A human-readable explanation",
    "details": {}
  }
}

{
  "error": {
    "code": "subscription_blocked",
    "message": "A human-readable explanation",
    "details": {}
  }
}

{
  "error": {
    "code": "app_suspended",
    "message": "A human-readable explanation",
    "details": {}
  }
}

{
  "error": {
    "code": "not_found",
    "message": "A human-readable explanation",
    "details": {}
  }
}

{
  "error": {
    "code": "rate_limited",
    "message": "A human-readable explanation",
    "details": {}
  }
}

{
  "error": {
    "code": "internal_error",
    "message": "A human-readable explanation",
    "details": {}
  }
}

Parameters

Path parameters

idstring (uuid)required
Property id.

Responses

200The Property Guide.

application/jsonPropertyGuide

property_idstring (uuid)required
namestringrequired
addressPropertyGuideAddressrequired
Address of the Property.
Show 6 child attributesHide child attributes
- streetstring | nullrequired
  Street address.
- postal_codestring | nullrequired
  Postal code.
- citystring | nullrequired
  City.
- statestring | nullrequired
  State or region.
- countrystring | nullrequired
  Country, as entered by the host (usually an ISO 3166-1 alpha-2 code).
- formattedstring | nullrequired
  The full address on one line.
coordinatesobjectrequired
GPS coordinates (WGS 84).
Show 2 child attributesHide child attributes
- latitudenumber | nullrequired
- longitudenumber | nullrequired
contactobjectrequired
Contact details of the Property.
Show 3 child attributesHide child attributes
- phonestring | nullrequired
  Phone number of the Property.
- emailstring | nullrequired
  Email address of the Property.
- websitestring | nullrequired
  Website of the Property.
check_in_timestring | nullrequired
Check-in time, HH:MM in the time zone of the Property.
check_out_timestring | nullrequired
Check-out time, HH:MM in the time zone of the Property.
wifiobjectrequired
Wi-Fi of the Property.
Show 2 child attributesHide child attributes
- network_namestring | nullrequired
  Wi-Fi network name.
- passwordstring | nullrequired
  Wi-Fi password.
roomsobjectrequired
Number of bedrooms, beds and bathrooms.
Show 3 child attributesHide child attributes
- bedroomsinteger | nullrequired
- bedsinteger | nullrequired
- bathroomsnumber | nullrequired
  May be fractional, e.g. 1.5.
amenitiesPropertyGuideAmenity[]required
Show 2 child attributesHide child attributes
- idstringrequired
  Stable amenity id.
- namestringrequired
  Amenity name, in English.
website_textsPropertyGuideWebsiteTexts[]required
Website texts of the Property, one entry per language.
Show 4 child attributesHide child attributes
- languagestring | nullrequired
  ISO 639-1 language of the texts; null for the texts of a Property without a translated website.
- descriptionstring | nullrequired
  Description of the Property.
- important_informationstring | nullrequired
  Important information for guests.
- good_to_knowstring | nullrequired
  Good to know.
welcome_booklet_urlstring | nullrequired
Link to the welcome booklet of the Property.
shortcodesPropertyGuideShortcode[]required
Show 4 child attributesHide child attributes
- shortcodestringrequired
  The Shortcode as the host writes it in messages, e.g. {{custom.parking}}.
- namestringrequired
- descriptionstring | nullrequired
- valuesobject[]required
  The value for this Property, per language.
  Show 2 child attributesHide child attributes
  languagestringrequired
  ISO 639-1 language.
  valuestringrequired
knowledgePropertyGuideKnowledge[]required
Account entries first, then the entries of this Property.
Show 3 child attributesHide child attributes
- themestringrequired
  One of arrival, departure, parking, amenities, rules, neighbourhood, housekeeping, services, other.
- kindstringrequired
  fact: something true about the stay. instruction: how the host wants guests to be answered.
  One of: fact instruction
- contentstringrequired

401Error code: unauthorized, connection_revoked.

Error codes

unauthorized The access token is missing, unknown, expired or revoked, or was issued before the account connected the App again. Refresh it; if refreshing fails, ask the owner to connect again.
connection_revoked The owner revoked the App Connection (or your App revoked its own refresh token). Stop calling for this account and drop its tokens.

402Error code: subscription_blocked.

Error codes

subscription_blocked The ZenHost subscription of the account is blocked (unpaid, cancelled…). The connection is kept: tell your customer, calls work again once the subscription is restored.

403Error code: app_suspended, forbidden_permission.

Error codes

app_suspended ZenHost suspended your App, or no longer allows it on this account. Stop calling and contact ZenHost.
forbidden_permission Your App was not granted the Permission this endpoint requires.

404Error code: not_found.

Error codes

not_found The resource does not exist or is outside the Connection Scope (both look the same), or the path is not an endpoint of /api/v1.

429Error code: rate_limited.

Header Retry-After — Seconds to wait before the next call is allowed. Limits per App Connection: 60 reads (GET), 10 writes (other POST) and 30 messages sent to guests per minute.

Error codes

rate_limited Too many calls on this App Connection. Wait for the number of seconds in Retry-After.

500Error code: internal_error.

Error codes

internal_error ZenHost failed to answer. Retry later with a back-off.

Every error code and what to do