Skip to main content
List the locations of the properties distributed to this channel
Not served yet. This operation is part of the final contract, version 1.0.0. The sandbox opens with the first test key; until then, build against a mock of the contract (Testing).

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.

Query Parameters

limit
integer
default:100

Above 500 is refused.

Required range: 1 <= x <= 500
cursor
string

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

Maximum string length: 256
updated_since
string<date-time>

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

status
enum<string>[]

Without updated_since only active and inactive resources exist to filter.

The status of every resource (location, owner, property, amenity, webhook endpoint), with one meaning everywhere. active: published and in effect. inactive: published, not in effect now (it may become active again). withdrawn: not published to you now; a tombstone that may come back under the same id with a higher version. deleted: final; a tombstone whose id is never used again. Open enum.

Available options:
active,
inactive,
withdrawn,
deleted

Response

A page of locations.

data
object[]
required
next_cursor
string | null
required