Skip to main content
Read one location, 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

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

"loc_5ckd3q6vsn9qmt7xrj0689h226"

Risposta

The location or its tombstone.

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

"loc_5ckd3q6vsn9qmt7xrj0689h226"

status
enum<string>
obbligatorio

inactive when every published property here is inactive.

Opzioni disponibili:
active,
inactive
category
enum<string>
obbligatorio

Additive. What kind of establishment this is, so you can decide how to show its properties: one listing of a hotel or guesthouse with its room types, or a listing per property. vacation_rental is a single whole unit (an apartment, a house) let on its own; apartment_building and villa_complex hold several such units. Open enum.

Opzioni disponibili:
hotel,
guesthouse,
hostel,
apartment_building,
villa_complex,
holiday_park,
vacation_rental,
other
address_visibility
enum<string>
obbligatorio

Additive. The host's choice for this location. exact: the address and geo are the property's. approximate: address.street, number, building and postal_code are null (a postal code can name a single street or building), geo is a displaced point within geo.precision_m metres, a radius the host also chooses, and geo.entrance is null. The exact address is never sent while approximate. Defaults to approximate when the owner is an individual and to exact for a company. When it turns approximate, replace what you hold and stop showing the exact address and point received before. Open enum.

Opzioni disponibili:
exact,
approximate
address
object
obbligatorio

A location's address. The members a host keeps private (address_visibility approximate) are null; city, county and country are always present.

geo
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"

name
string | null

The establishment's name (a hotel, a guesthouse), to title one listing of the room types under it.

owner_id
string | null

Set when every property here has the same owner.

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

"own_63g5d4zsqj809bf5rwekga54a5"

photos
object[]