Skip to main content
Read back the listing report Gridbeds holds for a property (404 until you send one)
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.

Authorizations

Authorization
string
header
required

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.

Path Parameters

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

"prp_1qnykkykp69yv8d59hxk5410m9"

Response

The report Gridbeds holds.

status
enum<string>
required

Your listing's state. published: live on your channel. unpublished: not live, by your or the host's choice. pending_review: in your moderation. rejected: refused by your moderation (see rejection). Open enum.

Available options:
published,
unpublished,
pending_review,
rejected
public_url
string<uri> | null
required

The public page of the listing on your channel. Required with status published; null otherwise.

Maximum string length: 2048
Pattern: ^https://
Example:

"https://channel.example/listings/12345"

promoted
boolean
required

Whether the listing is promoted (featured or boosted) on your channel now.

updated_at
string<date-time>
required
Pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$
Example:

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

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

"prp_1qnykkykp69yv8d59hxk5410m9"

received_at
string<date-time>
required
Pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$
Example:

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

rejection
object | null

Required with status rejected; refused with any other status.

promoted_until
string<date-time> | null

When the promotion ends; null when it has no end or the listing is not promoted.

Pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$
Example:

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