Skip to main content
The nights changed after a given instant, grouped by active or inactive property
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 della query

updated_since
string<date-time>

Inclusive RFC 3339 instant (a fraction is accepted). Includes withdrawn and deleted resources.

from
string<date>
obbligatorio

First night, the property's local date.

to
string<date>
obbligatorio

Exclusive; at most 365 nights after from and no later than the property's horizon_end, which is at least 365 nights after its today.

limit
integer
predefinito:100

Above 500 is refused.

Intervallo richiesto: 1 <= x <= 500
cursor
string

next_cursor from the previous page; opaque and bound to the query that produced it.

Maximum string length: 256

Risposta

A page of per-property night sets.

data
object[]
obbligatorio
next_cursor
string | null
obbligatorio