Skip to content
Test environment - these docs describe the GuardianCheckin sandbox API. For production, see docs.guardiancheckin.com.

Fetch a single listing by id.

GET
/v1/listings/{id}

Returns a single in-scope listing. An out-of-scope or non-existent id returns 404 with a single non-disclosing message (an out-of-scope listing is indistinguishable from a missing one).

id
required
string format: uuid

The listing id (UUID).

The listing.

The public projection of a listing. A curated, additive-only subset of internal fields.

object
id
required

The listing’s unique id.

string format: uuid
publicId
required

The listing’s public slug.

string
title
required
string
address
required
string
city
required
string
country
required
string
zipCode
required
string
district
string
nullable
timezone
required

IANA timezone identifier.

string
active
required
boolean
maxPeopleInListing
integer format: int32
nullable
maxVehicles
integer format: int32
nullable
allowPets
boolean
nullable
createdAt
required

When the listing was created (ISO-8601, UTC). The cursor ordering key.

string format: date-time

The API key is missing, malformed, revoked, or expired (UNAUTHENTICATED).

The single error envelope for every public-surface error response.

object
code
required

A stable, enumerated error code. Branch on this, never on message.

string
Allowed values: UNAUTHENTICATED FORBIDDEN RESOURCE_NOT_FOUND INVALID_CURSOR VALIDATION_ERROR PAYLOAD_TOO_LARGE RATE_LIMITED IDEMPOTENCY_KEY_REUSED
message
required

A human-readable description. May change without a contract break.

string
correlationId
required

A per-response id for support correlation.

string format: uuid
errors

Present only for VALIDATION_ERROR — the field-level validation failures.

Array<object>

One field-level validation failure.

object
field
required

The rejected field or query parameter name.

string
issue
required

What was wrong with it.

string

The resource does not exist, or the key has no access to it (RESOURCE_NOT_FOUND). The two cases are indistinguishable — no existence disclosure.

The single error envelope for every public-surface error response.

object
code
required

A stable, enumerated error code. Branch on this, never on message.

string
Allowed values: UNAUTHENTICATED FORBIDDEN RESOURCE_NOT_FOUND INVALID_CURSOR VALIDATION_ERROR PAYLOAD_TOO_LARGE RATE_LIMITED IDEMPOTENCY_KEY_REUSED
message
required

A human-readable description. May change without a contract break.

string
correlationId
required

A per-response id for support correlation.

string format: uuid
errors

Present only for VALIDATION_ERROR — the field-level validation failures.

Array<object>

One field-level validation failure.

object
field
required

The rejected field or query parameter name.

string
issue
required

What was wrong with it.

string

The per-key rate limit was exceeded (RATE_LIMITED). Retry after the interval in Retry-After.

The single error envelope for every public-surface error response.

object
code
required

A stable, enumerated error code. Branch on this, never on message.

string
Allowed values: UNAUTHENTICATED FORBIDDEN RESOURCE_NOT_FOUND INVALID_CURSOR VALIDATION_ERROR PAYLOAD_TOO_LARGE RATE_LIMITED IDEMPOTENCY_KEY_REUSED
message
required

A human-readable description. May change without a contract break.

string
correlationId
required

A per-response id for support correlation.

string format: uuid
errors

Present only for VALIDATION_ERROR — the field-level validation failures.

Array<object>

One field-level validation failure.

object
field
required

The rejected field or query parameter name.

string
issue
required

What was wrong with it.

string
Retry-After
integer format: int32

Integer seconds to wait before retrying (RFC 7231 delta-seconds form, always >= 1).