Skip to content

Fetch a single form by id.

GET
/v1/forms/{id}

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

id
required
string format: uuid

The form id (UUID).

The form.

The public projection of a guest-registration form. A curated, additive-only subset.

object
id
required

The form’s unique id.

string format: uuid
listingId
required

The id of the listing this form belongs to.

string format: uuid
publicId

The form’s public slug.

string
nullable
status
required

The public form status. Additive-only — new values may appear over time. Always handle UNKNOWN as a forward-compatible catch-all for any status this API version does not enumerate.

string
Allowed values: SENT COMPLETED ACCEPTED REJECTED VALIDATED INVALIDATED CHECKED_OUT UNKNOWN
checkInDate
string format: date-time
nullable
checkOutDate
string format: date-time
nullable
numberOfGuests
integer format: int32
nullable
numberOfVehicles
integer format: int32
nullable
numberOfPets
integer format: int32
nullable
createdAt
required

When the form 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).