Skip to main content
List the owners of the properties distributed to this channel
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.

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 owners.

data
object[]
required
next_cursor
string | null
required