Get one Property of the Connection Scope

GET/api/v1/properties/{id}

Requires properties.read

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 \
  -H "Authorization: Bearer zh_at_..."

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

Response

{
  "id": "3f6c1a52-8d0e-4b7a-9f21-5c4e8b7d2a10",
  "name": "Sea view apartment",
  "currency": "EUR",
  "timezone": "Europe/Paris",
  "pricing_modifiers": [
    {
      "sales_channel": "ABB",
      "name": "Airbnb",
      "percent": 15
    }
  ]
}

{
  "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.

application/jsonProperty

idstring (uuid)required
namestringrequired
currencystringrequired
ISO 4217 code of every amount of the property.
timezonestringrequired
IANA time zone of the property dates.
pricing_modifiersPricingModifier[]required
Show 3 child attributesHide child attributes
- sales_channelstringrequired
  website for the direct website, else the Sales Channel shortcode (e.g. ABB for Airbnb, BDC for Booking.com).
- namestringrequired
  Channel Display Name.
- percentnumberrequired
  Applied on top of the base rate on this Sales Channel, e.g. 15 for +15 %. Channels without a modifier are omitted.

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