Skip to content
KismetKismetDevelopers
llms.txt

Get a published vacation rental

View .md

GET /v1/developer/vacation-rentals/{vacationRental}

Operation ID: getVacationRental

Returns the bounded published detail projection within the authenticated application grant: description, gallery (max 12), spaces (max 60, each with its public-safe photos and host-verified imagesVerified flag), nearby attractions, and effective pet policy. A nearby attraction resolved to a place additionally carries exact geo coordinates and its Google placeId for map pins; an unresolved one carries neither. goodFor lists up to 6 ranked labels from the fixed Kismet Good-for list (families, groups, couples, remote-work, pets, ski-trips, beach-days, lake-days, hot-tub-nights, accessible, events), each with the concrete listing evidence that earned it in reasons; a label never appears without evidence. When the credential also holds rates.read, the response additively carries pricing.nightlyFrom — an indicative synced floor over the coming window, never a bookable quote. TEST view=staging also reads only explicitly approved rooms under both active preview grants, with null publishedAt and explicit staging visibility/expiry. Pricing is withheld for staging-only rooms. No availability search, quotes, booking URLs, or vendor payloads. Build a TEST catalog preview: setup, SDK and REST examples, independent approval expiry, and room-preview boundaries. Published remains the default.

Contract status

Section titled “Contract status”
Field Value
Maturity beta
Required capability vacation_rentals.read
Freshness class published-content
Quota cost 1

All operations require a Kismet Developer Bearer credential. Collection and resource authority is resolved from the credential’s installation grants; identifiers in the URL never grant access.

Request parameters

Section titled “Request parameters”
Name In Type Required Description
view query published | staging no TEST-only opt-in to explicitly approved, unexpired staging catalog and room reads. Omit for published inventory. Does not authorize pricing, booking, or publication.
vacationRental path string yes

Request body

Section titled “Request body”

This operation has no JSON request body.

cURL

Section titled “cURL”

Set KISMET_API_ORIGIN=https://api.ksmt.app and configure KISMET_DEVELOPER_API_KEY in your environment. Run server-credential requests from your backend, not browser code.

Terminal window
curl --request GET \
  "$KISMET_API_ORIGIN/v1/developer/vacation-rentals/sand-sea-110" \
  --header "Authorization: Bearer $KISMET_DEVELOPER_API_KEY" \
  --header "Accept: application/json"

Responses

Section titled “Responses”
Status Meaning
200 Success.
400 Invalid request parameters or body.
401 Missing, invalid, expired, or inappropriate credential/session.
403 Credential lacks the required grant/capability, or an origin/CSRF check failed.
429 Rate limit or quota exceeded; inspect response metadata before retrying.
503 A required Kismet dependency is temporarily unavailable.

200 response example

Section titled “200 response example”
{
  "resourceType": "bookable_product",
  "type": "vacation_rental",
  "id": "22222222-2222-4222-8222-222222222222",
  "slug": "sandbox-chalet",
  "name": "Sandbox Chalet",
  "tagline": "A cozy evaluation chalet",
  "collection": {
    "id": "11111111-1111-4111-8111-111111111111",
    "slug": "sandbox-stays",
    "name": "Sandbox Stays"
  },
  "capacity": {
    "bedrooms": 3,
    "bathrooms": 2,
    "maxGuests": 8
  },
  "location": {
    "locality": "Dover",
    "region": "VT",
    "postalCode": "05356",
    "country": "US",
    "geo": {
      "latitude": 42.94,
      "longitude": -72.87,
      "precision": "approximate"
    }
  },
  "media": {
    "hero": {
      "url": "https://cdn.kismet.travel/sandbox/chalet-hero.jpg",
      "alt": "Chalet exterior"
    },
    "cardImages": [
      {
        "url": "https://cdn.kismet.travel/sandbox/chalet-hero.jpg",
        "alt": "Chalet exterior"
      },
      {
        "url": "https://cdn.kismet.travel/sandbox/chalet-living.jpg"
      }
    ],
    "gallery": [
      {
        "url": "https://cdn.kismet.travel/sandbox/chalet-living.jpg",
        "alt": "Living room"
      },
      {
        "url": "https://cdn.kismet.travel/sandbox/chalet-deck.jpg"
      }
    ]
  },
  "amenityHighlights": [
    "Hot tub",
    "EV charger"
  ],
  "links": {
    "self": "/v1/developer/vacation-rentals/22222222-2222-4222-8222-222222222222"
  },
  "publication": {
    "publishedAt": "2026-06-15T00:00:00.000Z",
    "updatedAt": "2026-07-01T00:00:00.000Z"
  },
  "capabilities": [
    "vacation_rentals.read"
  ],
  "description": {
    "short": "A quiet three-bedroom chalet near the trails.",
    "long": "A longer published description of the chalet and its surroundings.",
    "neighborhood": "Ten minutes from the village center."
  },
  "spaces": [
    {
      "name": "Primary bedroom",
      "spaceType": "bedroom",
      "description": "King bed",
      "cover": {
        "url": "https://cdn.kismet.travel/sandbox/chalet-bedroom.jpg",
        "alt": "Primary bedroom"
      },
      "images": [
        {
          "url": "https://cdn.kismet.travel/sandbox/chalet-bedroom.jpg",
          "alt": "Primary bedroom"
        }
      ],
      "imagesVerified": true,
      "beds": [
        {
          "type": "King",
          "count": 1
        }
      ],
      "bedSummary": "King"
    },
    {
      "name": "Bunk room",
      "spaceType": "bedroom",
      "beds": [
        {
          "type": "Bunk (Twin/Twin)",
          "count": 1
        },
        {
          "type": "Twin",
          "count": 2
        }
      ],
      "bedSummary": "Bunk (Twin/Twin) · 2x Twin"
    }
  ],
  "nearbyAttractions": [
    {
      "name": "River Trail",
      "type": "trail",
      "distance": "0.5 mi",
      "geo": {
        "latitude": 45.3311,
        "longitude": -121.7113
      },
      "placeId": "ChIJ-example-river-trail"
    },
    {
      "name": "Old Mill Bakery",
      "type": "restaurant",
      "distance": "1.2 mi"
    }
  ],
  "policies": {
    "petsAllowed": true
  },
  "goodFor": [
    {
      "key": "hot-tub-nights",
      "label": "Hot tub nights",
      "reasons": [
        "hot tub",
        "fire pit",
        "mountain views"
      ]
    },
    {
      "key": "pets",
      "label": "Pets",
      "reasons": [
        "pets allowed",
        "fenced yard"
      ]
    },
    {
      "key": "remote-work",
      "label": "Remote work",
      "reasons": [
        "desk",
        "Wi-Fi"
      ]
    }
  ],
  "enrichment": [
    {
      "slug": "local-favorites",
      "version": 1,
      "name": "Local favorites",
      "defaultLocale": "en",
      "values": [
        {
          "key": "story",
          "labels": {
            "en": "The story"
          },
          "value": "Built by hand in 1971 and restored by the current hosts.",
          "curated": false,
          "publishedAt": "2026-08-20T00:00:00.000Z",
          "relationship": "OWNER"
        }
      ]
    }
  ],
  "pricing": {
    "nightlyFrom": {
      "amountMinor": 24900,
      "currency": "USD",
      "horizonDays": 90
    }
  }
}

200 response schema

Section titled “200 response schema”

Content type: application/json. Required fields, nullable values, and nested structures are defined below.

View complete response schema 
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "resourceType",
    "type",
    "id",
    "slug",
    "name",
    "collection",
    "capacity",
    "media",
    "amenityHighlights",
    "links",
    "publication",
    "capabilities",
    "description",
    "spaces",
    "nearbyAttractions",
    "policies"
  ],
  "properties": {
    "resourceType": {
      "enum": [
        "bookable_product"
      ]
    },
    "type": {
      "enum": [
        "vacation_rental"
      ]
    },
    "id": {
      "type": "string"
    },
    "slug": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "tagline": {
      "type": "string"
    },
    "shortSummary": {
      "type": "string"
    },
    "propertyType": {
      "type": "string"
    },
    "collection": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "id",
        "slug",
        "name"
      ],
      "properties": {
        "id": {
          "type": "string"
        },
        "slug": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "capacity": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "bedrooms",
        "bathrooms",
        "maxGuests"
      ],
      "properties": {
        "bedrooms": {
          "type": [
            "null",
            "integer"
          ]
        },
        "bathrooms": {
          "type": [
            "null",
            "number"
          ]
        },
        "maxGuests": {
          "type": [
            "null",
            "integer"
          ]
        }
      }
    },
    "location": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "locality",
        "region",
        "postalCode",
        "country",
        "geo"
      ],
      "properties": {
        "locality": {
          "type": [
            "null",
            "string"
          ]
        },
        "region": {
          "type": [
            "null",
            "string"
          ]
        },
        "postalCode": {
          "type": [
            "null",
            "string"
          ]
        },
        "country": {
          "type": [
            "null",
            "string"
          ]
        },
        "geo": {
          "anyOf": [
            {
              "type": "null"
            },
            {
              "type": "object",
              "additionalProperties": false,
              "required": [
                "latitude",
                "longitude",
                "precision"
              ],
              "properties": {
                "latitude": {
                  "type": "number"
                },
                "longitude": {
                  "type": "number"
                },
                "precision": {
                  "enum": [
                    "approximate"
                  ]
                }
              }
            }
          ]
        }
      }
    },
    "media": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "cardImages",
        "gallery"
      ],
      "properties": {
        "hero": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "url"
          ],
          "properties": {
            "url": {
              "type": "string",
              "format": "uri"
            },
            "alt": {
              "type": "string"
            },
            "caption": {
              "type": "string"
            }
          }
        },
        "cardImages": {
          "type": "array",
          "maxItems": 5,
          "items": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "url"
            ],
            "properties": {
              "url": {
                "type": "string",
                "format": "uri"
              },
              "alt": {
                "type": "string"
              },
              "caption": {
                "type": "string"
              }
            }
          }
        },
        "gallery": {
          "type": "array",
          "maxItems": 12,
          "items": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "url"
            ],
            "properties": {
              "url": {
                "type": "string",
                "format": "uri"
              },
              "alt": {
                "type": "string"
              },
              "caption": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "amenityHighlights": {
      "type": "array",
      "maxItems": 12,
      "items": {
        "type": "string"
      }
    },
    "pricing": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "nightlyFrom"
      ],
      "properties": {
        "nightlyFrom": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "amountMinor",
            "currency",
            "horizonDays"
          ],
          "properties": {
            "amountMinor": {
              "type": "integer"
            },
            "currency": {
              "type": "string"
            },
            "horizonDays": {
              "type": "integer"
            }
          }
        }
      }
    },
    "links": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "self"
      ],
      "properties": {
        "self": {
          "type": "string"
        }
      }
    },
    "publication": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "publishedAt",
        "updatedAt"
      ],
      "properties": {
        "publishedAt": {
          "type": [
            "null",
            "string"
          ],
          "format": "date-time"
        },
        "visibility": {
          "type": "string",
          "enum": [
            "published",
            "staging"
          ]
        },
        "stagingExpiresAt": {
          "type": "string",
          "format": "date-time"
        },
        "updatedAt": {
          "type": "string",
          "format": "date-time"
        }
      }
    },
    "capabilities": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "description": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "short": {
          "type": "string"
        },
        "long": {
          "type": "string"
        },
        "hostNotes": {
          "type": "string"
        },
        "neighborhood": {
          "type": "string"
        }
      }
    },
    "spaces": {
      "type": "array",
      "maxItems": 60,
      "items": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "name"
        ],
        "properties": {
          "id": {
            "type": "string"
          },
          "slug": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "spaceType": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "cover": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "url"
            ],
            "properties": {
              "url": {
                "type": "string",
                "format": "uri"
              },
              "alt": {
                "type": "string"
              },
              "caption": {
                "type": "string"
              }
            }
          },
          "images": {
            "type": "array",
            "maxItems": 30,
            "items": {
              "type": "object",
              "additionalProperties": false,
              "required": [
                "url"
              ],
              "properties": {
                "url": {
                  "type": "string",
                  "format": "uri"
                },
                "alt": {
                  "type": "string"
                },
                "caption": {
                  "type": "string"
                }
              }
            }
          },
          "imagesVerified": {
            "type": "boolean"
          },
          "beds": {
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": false,
              "required": [
                "type",
                "count"
              ],
              "properties": {
                "type": {
                  "type": "string"
                },
                "count": {
                  "type": "integer",
                  "minimum": 1
                }
              }
            }
          },
          "bedSummary": {
            "type": "string"
          }
        }
      }
    },
    "nearbyAttractions": {
      "type": "array",
      "maxItems": 12,
      "items": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "name"
        ],
        "properties": {
          "name": {
            "type": "string"
          },
          "type": {
            "type": "string"
          },
          "distance": {
            "type": "string"
          },
          "geo": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "latitude",
              "longitude"
            ],
            "properties": {
              "latitude": {
                "type": "number"
              },
              "longitude": {
                "type": "number"
              }
            }
          },
          "placeId": {
            "type": "string"
          }
        }
      }
    },
    "policies": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "petsAllowed"
      ],
      "properties": {
        "petsAllowed": {
          "type": "boolean"
        }
      }
    },
    "goodFor": {
      "type": "array",
      "maxItems": 6,
      "items": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "key",
          "label",
          "reasons"
        ],
        "properties": {
          "key": {
            "type": "string",
            "enum": [
              "families",
              "groups",
              "couples",
              "remote-work",
              "pets",
              "ski-trips",
              "beach-days",
              "lake-days",
              "hot-tub-nights",
              "accessible",
              "events"
            ]
          },
          "label": {
            "type": "string"
          },
          "reasons": {
            "type": "array",
            "minItems": 1,
            "maxItems": 4,
            "items": {
              "type": "string"
            }
          }
        }
      }
    },
    "enrichment": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "slug",
          "version",
          "name",
          "defaultLocale",
          "values"
        ],
        "properties": {
          "slug": {
            "type": "string"
          },
          "version": {
            "type": "integer"
          },
          "name": {
            "type": "string"
          },
          "defaultLocale": {
            "type": "string"
          },
          "values": {
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": false,
              "required": [
                "key",
                "labels",
                "value",
                "curated"
              ],
              "properties": {
                "key": {
                  "type": "string"
                },
                "labels": {
                  "type": "object",
                  "additionalProperties": {
                    "type": "string"
                  }
                },
                "value": {},
                "locale": {
                  "type": "string"
                },
                "curated": {
                  "type": "boolean"
                },
                "publishedAt": {
                  "type": "string"
                },
                "relationship": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}

Machine-readable sources

Section titled “Machine-readable sources”