Skip to main content
Read one property, or its tombstone
Preview. This operation is not served yet: it is part of the released contract (version 1.0.0). Build against a mock of the contract until the sandbox serves it; see Testing: mock and sandbox.

Autorizzazioni

Authorization
string
header
obbligatorio

A key starts with gbd_live_ (production) or gbd_test_ (sandbox) and ends in a CRC32 checksum of its secret part, so a mistyped or truncated key is refused before any lookup, as is a key of the other environment. The prefix is registered with public secret scanners (GitHub secret scanning, TruffleHog, GitGuardian): a key found in a public repository is revoked at once and your technical contact is told. Gridbeds stores only a hash of each key. One partner may hold two keys per environment during a rotation. Operations list the scopes they need; the scopes are OAuth 2.0 scope tokens, so short-lived access tokens from a client-credentials grant can be offered later beside keys, with the same scopes and no change to any operation.

Parametri del percorso

property_id
string
obbligatorio
Pattern: ^prp_[0-7][0-9a-hjkmnp-tv-z]{25}$
Esempio:

"prp_1qnykkykp69yv8d59hxk5410m9"

Risposta

The property or its tombstone.

id
string
obbligatorio
Pattern: ^prp_[0-7][0-9a-hjkmnp-tv-z]{25}$
Esempio:

"prp_1qnykkykp69yv8d59hxk5410m9"

status
enum<string>
obbligatorio

inactive while the property cannot be sold.

Opzioni disponibili:
active,
inactive
location_id
string
obbligatorio
Pattern: ^loc_[0-7][0-9a-hjkmnp-tv-z]{25}$
Esempio:

"loc_5ckd3q6vsn9qmt7xrj0689h226"

owner_id
string
obbligatorio
Pattern: ^own_[0-7][0-9a-hjkmnp-tv-z]{25}$
Esempio:

"own_63g5d4zsqj809bf5rwekga54a5"

type
enum<string>
obbligatorio
Opzioni disponibili:
apartment,
studio,
room,
house,
villa,
cabin,
guesthouse_room,
hotel_room,
other
units
integer
predefinito:1
obbligatorio

Identical units sold under this property.

Intervallo richiesto: x >= 1
name
object
obbligatorio

Plain text by language; the property's source language is always present (ro for a property in Romania, its own language elsewhere), except in a text Gridbeds generates (cancellation.text), which is in en where it does not ship the source language. No HTML, links, e-mail addresses or phone numbers.

description
object
obbligatorio

Plain text by language; the property's source language is always present (ro for a property in Romania, its own language elsewhere), except in a text Gridbeds generates (cancellation.text), which is in en where it does not ship the source language. No HTML, links, e-mail addresses or phone numbers.

capacity
object
obbligatorio
photos
object[]
obbligatorio
Minimum array length: 5
check_in
object
obbligatorio
check_out
object
obbligatorio
rate_plans
object[]
obbligatorio
Minimum array length: 1
fees
object[]
obbligatorio

v1 publishes cleaning and city_tax, each at most once; city_tax exactly when city_tax_status is levied.

Esempio:
city_tax_status
enum<string>
obbligatorio

Additive. Whether a tourist tax applies to a stay here, so a missing city_tax fee is never mistaken for "no tax". levied: fees carries exactly one city_tax, whose value may still be unknown (null). none: the property declares that no tourist tax applies; fees carries no city_tax. undeclared: the property has not said whether one applies; fees carries no city_tax, and you should say that a local tax may be payable at the property. A change is a property.updated with a higher version. Open enum: read a value you do not know as undeclared.

Opzioni disponibili:
levied,
none,
undeclared
Esempio:

"levied"

What the law of the property's jurisdiction asks a listing to show.

booking
object
obbligatorio
timezone
string
obbligatorio

IANA time zone.

Esempi:

"Europe/Bucharest"

"Europe/Rome"

version
integer<int64>
obbligatorio

Grows on every change visible to this channel; ignore a lower one. Not a counter — do not expect consecutive values.

Intervallo richiesto: x >= 1
updated_at
string<date-time>
obbligatorio
Pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$
Esempio:

"2026-10-16T09:30:00Z"

area_sqm
integer | null
floor
integer | null
elevator
boolean | null
amenities
string[]

Codes from /amenities.

house_rules
object
extensions
object

Only your own channel key appears.