{ "openapi": "3.0.3", "info": { "title": "Kismet Developer API", "version": "0.7.0", "description": "Published, collection-scoped Kismet resources for external builders: SDKs, fixtures, and developer applications.\n\nEvery operation requires a Kismet developer Bearer credential and returns only published, non-transactional content within the credential’s positive grants. Indicative pricing from Kismet’s synchronized calendar plane (the nightly calendar and list/detail nightly-from summaries) is available behind the `rates.read` grant; the API still deliberately excludes quotes, totals, fees, taxes, booking URLs, checkout, draft state, exact private addresses, and vendor payloads.\n\nBase URL: the isolated evaluation deployment address is issued with your credential. Every operation is `maturity: beta` and may change with notice in the changelog.", "contact": { "name": "Kismet Developer Platform", "email": "engineering@makekismet.com" } }, "components": { "securitySchemes": { "kismetDeveloperKey": { "type": "http", "scheme": "bearer", "description": "Kismet developer credential. Publishable keys (`kismet_pk_…`) are browser-safe, origin-bound reads: requests must carry an Origin header exactly matching an allowed origin on the installation. Server keys (`kismet_sk_…`) are secret, server-side only, and never origin-bound. Credentials are installation-scoped: every request is authorized against the installation’s positive capability grants and collection/entity scope. Revocation is immediate." } }, "schemas": { "Problem": { "type": "object", "description": "RFC 9457 problem document. Every non-2xx developer response uses this envelope with media type application/problem+json.", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri", "description": "Stable problem-type URI under https://developers.kismet.travel/problems/" }, "title": { "type": "string", "description": "HTTP reason phrase" }, "status": { "type": "integer", "description": "HTTP status code" }, "detail": { "type": "string", "description": "Human-readable, non-sensitive explanation" }, "code": { "type": "string", "description": "Stable machine code (e.g. RESOURCE_NOT_GRANTED, RATE_LIMIT_EXCEEDED, VALIDATION_ERROR)" }, "requestId": { "type": "string", "description": "Echo of the request id for support correlation" }, "instance": { "type": "string", "description": "The request path that produced the problem" } } } } }, "paths": { "/v1/developer/collections/{collection}": { "get": { "operationId": "getVacationRentalManager", "summary": "Get a published vacation rental manager", "tags": [ "developer-published-resources" ], "description": "Returns published, non-transactional Kismet content within the authenticated application grant. No rates, availability, indicative pricing, booking URL, draft state, or vendor payload is returned.", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "collection", "required": true } ], "security": [ { "kismetDeveloperKey": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "resourceType", "type", "id", "slug", "name", "brand", "links", "propertyCount", "publication" ], "properties": { "resourceType": { "enum": [ "collection" ] }, "type": { "enum": [ "vacation_rental_manager" ] }, "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "brand": { "type": "object", "additionalProperties": false, "properties": { "logoUrl": { "type": "string", "format": "uri" }, "faviconUrl": { "type": "string", "format": "uri" }, "primaryColor": { "type": "string" }, "secondaryColor": { "type": "string" } } }, "links": { "type": "object", "additionalProperties": false, "required": [ "self", "vacationRentals" ], "properties": { "self": { "type": "string" }, "vacationRentals": { "type": "string" }, "website": { "type": "string", "format": "uri" } } }, "propertyCount": { "type": "integer", "minimum": 0 }, "publication": { "type": "object", "additionalProperties": false, "required": [ "updatedAt" ], "properties": { "updatedAt": { "type": "string", "format": "date-time" } } } } }, "example": { "resourceType": "collection", "type": "vacation_rental_manager", "id": "11111111-1111-4111-8111-111111111111", "slug": "sandbox-stays", "name": "Sandbox Stays", "description": "Evaluation collection used in developer sandbox examples.", "brand": { "logoUrl": "https://cdn.kismet.travel/sandbox/logo.png", "faviconUrl": "https://cdn.kismet.travel/sandbox/favicon.ico", "primaryColor": "#3b0014", "secondaryColor": "#677251" }, "links": { "self": "/v1/developer/collections/11111111-1111-4111-8111-111111111111", "vacationRentals": "/v1/developer/collections/11111111-1111-4111-8111-111111111111/vacation-rentals", "website": "https://sandbox-stays.example" }, "propertyCount": 2, "publication": { "updatedAt": "2026-07-01T00:00:00.000Z" } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "API + Developer Experience", "x-kismet-quota-cost": 1, "x-kismet-freshness": "published-content", "x-kismet-maturity": "beta", "x-kismet-required-capability": "collections.read" } }, "/v1/developer/collections/{collection}/vacation-rentals": { "get": { "operationId": "listVacationRentals", "summary": "List published vacation rentals for a manager", "tags": [ "developer-published-resources" ], "description": "Returns published Kismet content within the authenticated application grant. When the credential also holds collection-wide `rates.read`, each row may add `pricing.nightlyFrom`, derived from Kismet's cached calendar plane over the coming window. It is indicative display pricing, never a dated quote. No availability search, booking URL, draft state, or vendor payload is returned. List ordering is stable across pages of one listing pass but otherwise unspecified — do not depend on it; pin a specific rental by id or slug.", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "query", "name": "cursor", "required": false }, { "schema": { "type": "integer", "minimum": 1, "maximum": 50, "default": 20 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "collection", "required": true } ], "security": [ { "kismetDeveloperKey": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "data", "page" ], "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "resourceType", "type", "id", "slug", "name", "collection", "capacity", "media", "amenityHighlights", "links", "publication", "capabilities" ], "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, "properties": { "hero": { "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": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }, "capabilities": { "type": "array", "items": { "type": "string" } } } } }, "page": { "type": "object", "additionalProperties": false, "required": [ "limit", "nextCursor" ], "properties": { "limit": { "type": "integer" }, "nextCursor": { "type": [ "null", "string" ] } } } } }, "example": { "data": [ { "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" } }, "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" ] } ], "page": { "limit": 20, "nextCursor": null } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "API + Developer Experience", "x-kismet-quota-cost": 1, "x-kismet-freshness": "published-content", "x-kismet-maturity": "beta", "x-kismet-required-capability": "vacation_rentals.read" } }, "/v1/developer/vacation-rentals/{vacationRental}": { "get": { "operationId": "getVacationRental", "summary": "Get a published vacation rental", "tags": [ "developer-published-resources" ], "description": "Returns the bounded published detail projection within the authenticated application grant: description, gallery (max 12), spaces, nearby attractions, and effective pet policy. 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. No availability search, quotes, booking URLs, draft state, or vendor payloads.", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "vacationRental", "required": true } ], "security": [ { "kismetDeveloperKey": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "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": [ "gallery" ], "properties": { "hero": { "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": "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": 12, "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" } } }, "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" } } } }, "policies": { "type": "object", "additionalProperties": false, "required": [ "petsAllowed" ], "properties": { "petsAllowed": { "type": "boolean" } } } } }, "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" }, "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" }, "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" } ], "policies": { "petsAllowed": true }, "pricing": { "nightlyFrom": { "amountMinor": 24900, "currency": "USD", "horizonDays": 90 } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "API + Developer Experience", "x-kismet-quota-cost": 1, "x-kismet-freshness": "published-content", "x-kismet-maturity": "beta", "x-kismet-required-capability": "vacation_rentals.read" } }, "/v1/developer/vacation-rentals/{vacationRental}/reviews": { "get": { "operationId": "listVacationRentalReviews", "summary": "List published reviews for a vacation rental", "tags": [ "developer-published-resources" ], "description": "Returns published, non-transactional Kismet content within the authenticated application grant. No rates, availability, indicative pricing, booking URL, draft state, or vendor payload is returned.", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "query", "name": "cursor", "required": false }, { "schema": { "type": "integer", "minimum": 1, "maximum": 50, "default": 20 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "vacationRental", "required": true } ], "security": [ { "kismetDeveloperKey": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "data", "page", "meta" ], "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "id", "channel", "overallRating", "reviewText", "hostResponse", "reviewerDisplayName", "reviewDate", "categoryRatings", "personas", "features", "season" ], "properties": { "id": { "type": "string" }, "channel": { "type": "string" }, "overallRating": { "type": [ "null", "number" ] }, "reviewText": { "type": [ "null", "string" ] }, "hostResponse": { "type": [ "null", "string" ] }, "reviewerDisplayName": { "type": [ "null", "string" ] }, "reviewDate": { "type": [ "null", "string" ], "format": "date-time" }, "categoryRatings": { "type": "object", "additionalProperties": false, "required": [ "cleanliness", "accuracy", "checkin", "communication", "location", "value" ], "properties": { "cleanliness": { "type": [ "null", "number" ] }, "accuracy": { "type": [ "null", "number" ] }, "checkin": { "type": [ "null", "number" ] }, "communication": { "type": [ "null", "number" ] }, "location": { "type": [ "null", "number" ] }, "value": { "type": [ "null", "number" ] } } }, "personas": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "slug", "label", "confidence", "source" ], "properties": { "slug": { "type": "string" }, "label": { "type": "string" }, "confidence": { "type": [ "null", "number" ] }, "source": { "type": "string", "enum": [ "ai", "manual" ] } } } }, "features": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "slug", "label", "confidence", "source" ], "properties": { "slug": { "type": "string" }, "label": { "type": "string" }, "confidence": { "type": [ "null", "number" ] }, "source": { "type": "string", "enum": [ "ai", "manual" ] } } } }, "season": { "anyOf": [ { "type": "null" }, { "type": "object", "additionalProperties": false, "required": [ "season", "source" ], "properties": { "season": { "type": "string" }, "source": { "type": "string", "enum": [ "derived", "ai", "manual" ] } } } ] } } } }, "page": { "type": "object", "additionalProperties": false, "required": [ "limit", "nextCursor" ], "properties": { "limit": { "type": "integer" }, "nextCursor": { "type": [ "null", "string" ] } } }, "meta": { "type": "object", "additionalProperties": false, "required": [ "aggregate" ], "properties": { "aggregate": { "type": "object", "additionalProperties": false, "required": [ "overallRating", "reviewCount" ], "properties": { "overallRating": { "type": [ "null", "number" ] }, "reviewCount": { "type": "integer" } } } } } } }, "example": { "data": [ { "id": "44444444-4444-4444-8444-444444444444", "channel": "airbnb", "overallRating": 5, "reviewText": "Wonderful stay — spotless and quiet.", "hostResponse": "Thank you! Come back any time.", "reviewerDisplayName": "Jamie", "reviewDate": "2026-05-20T00:00:00.000Z", "categoryRatings": { "cleanliness": 5, "accuracy": 5, "checkin": 5, "communication": 5, "location": 4.5, "value": 5 }, "personas": [ { "slug": "family", "label": "Family", "confidence": 0.92, "source": "ai" } ], "features": [ { "slug": "amazing-host", "label": "Amazing host", "confidence": 0.88, "source": "ai" } ], "season": { "season": "spring", "source": "derived" } } ], "page": { "limit": 20, "nextCursor": null }, "meta": { "aggregate": { "overallRating": 4.9, "reviewCount": 24 } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "API + Developer Experience", "x-kismet-quota-cost": 1, "x-kismet-freshness": "published-content", "x-kismet-maturity": "beta", "x-kismet-required-capability": "reviews.read" } }, "/v1/developer/vacation-rentals/{vacationRental}/policies": { "get": { "operationId": "listVacationRentalPolicies", "summary": "List effective policies for a vacation rental", "tags": [ "developer-published-resources" ], "description": "Returns published, non-transactional Kismet content within the authenticated application grant. No rates, availability, indicative pricing, booking URL, draft state, or vendor payload is returned.", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "vacationRental", "required": true } ], "security": [ { "kismetDeveloperKey": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "data" ], "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "policyType", "scope", "title", "url" ], "properties": { "policyType": { "type": "string" }, "scope": { "type": "string", "enum": [ "VR", "VRM", "PMS" ] }, "policyId": { "type": [ "null", "string" ] }, "version": { "type": [ "null", "integer" ] }, "contentHash": { "type": [ "null", "string" ] }, "effectiveAt": { "type": [ "null", "string" ] }, "title": { "type": "string" }, "url": { "type": "string" } } } } } }, "example": { "data": [ { "policyType": "PET", "scope": "VR", "policyId": "55555555-5555-4555-8555-555555555555", "version": 2, "contentHash": "c0ffee00c0ffee00c0ffee00c0ffee00c0ffee00c0ffee00c0ffee00c0ffee00", "effectiveAt": "2026-04-01T00:00:00.000Z", "title": "Pet policy", "url": "https://sandbox-stays.example/policies/pet" } ] } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "API + Developer Experience", "x-kismet-quota-cost": 1, "x-kismet-freshness": "published-content", "x-kismet-maturity": "beta", "x-kismet-required-capability": "policies.read" } }, "/v1/developer/vacation-rentals/{vacationRental}/calendar": { "get": { "operationId": "getVacationRentalCalendar", "summary": "Get the synced nightly calendar for a vacation rental", "tags": [ "developer-published-resources" ], "description": "Per-night availability and indicative nightly rates from Kismet's synchronized calendar plane for a bounded date window (max 90 days, today onward). `meta.lastSyncedAt` communicates recency. This is never a bookable quote: totals, fees, taxes, and checkout are out of scope. `nightlyRate` is null when the connected source withholds the rate; a night is bookable only when `available` is true.", "parameters": [ { "schema": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "in": "query", "name": "start", "required": true }, { "schema": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "in": "query", "name": "end", "required": true }, { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "vacationRental", "required": true } ], "security": [ { "kismetDeveloperKey": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "data", "meta" ], "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "date", "available", "nightlyRate", "checkInAllowed", "checkOutAllowed" ], "properties": { "date": { "type": "string" }, "available": { "type": "boolean" }, "nightlyRate": { "anyOf": [ { "type": "null" }, { "type": "object", "additionalProperties": false, "required": [ "amountMinor", "currency" ], "properties": { "amountMinor": { "type": "integer" }, "currency": { "type": "string" } } } ] }, "minStay": { "type": "integer" }, "checkInAllowed": { "type": "boolean" }, "checkOutAllowed": { "type": "boolean" } } } }, "meta": { "type": "object", "additionalProperties": false, "required": [ "start", "end", "lastSyncedAt" ], "properties": { "start": { "type": "string" }, "end": { "type": "string" }, "lastSyncedAt": { "type": [ "null", "string" ] } } } } }, "example": { "data": [ { "date": "2026-08-01", "available": true, "nightlyRate": { "amountMinor": 18900, "currency": "USD" }, "minStay": 2, "checkInAllowed": true, "checkOutAllowed": true }, { "date": "2026-08-02", "available": false, "nightlyRate": null, "checkInAllowed": false, "checkOutAllowed": true } ], "meta": { "start": "2026-08-01", "end": "2026-08-02", "lastSyncedAt": "2026-07-01T00:00:00.000Z" } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "API + Booking Platform", "x-kismet-quota-cost": 1, "x-kismet-freshness": "synced-commercial", "x-kismet-maturity": "beta", "x-kismet-required-capability": "rates.read" } }, "/v1/developer/collections/{collection}/vacation-rentals/availability": { "get": { "operationId": "getCollectionAvailability", "summary": "Summarize stay availability across a collection", "tags": [ "developer-published-resources" ], "description": "One aggregate read answering which published rentals can host a stay, so results pages never download every unit's full calendar. Fit is computed server-side from Kismet's synchronized calendar plane with the same rules Kismet's own booking surfaces enforce: every occupied night open, check-in allowed on arrival, check-out allowed on the departure morning, and the arrival night's minimum stay satisfied. `available` is a tri-state: true (fits every synced rule), false (a synced rule rejects it), null (the synced calendar does not cover the stay — treat as unknown, never as closed; drill into `getVacationRentalCalendar`). Open rows may carry `display` — Kismet's display-pricing convention: required fees folded into the before-tax stay subtotal and divided across nights (\"$X / night + tax\"; taxes are revealed at checkout), computed by the same engine Kismet checkout uses with `guests` applied to per-guest fees. Absent `display` means \"price at the next step\", never zero. This is still not a bookable quote: taxes, payment, and checkout are out of scope.", "parameters": [ { "schema": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "in": "query", "name": "checkIn", "required": true }, { "schema": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "in": "query", "name": "checkOut", "required": true }, { "schema": { "type": "integer", "minimum": 1, "maximum": 16, "default": 2 }, "in": "query", "name": "guests", "required": false }, { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "collection", "required": true } ], "security": [ { "kismetDeveloperKey": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "data", "meta" ], "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "id", "slug", "available" ], "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "available": { "type": [ "null", "boolean" ] }, "display": { "type": "object", "additionalProperties": false, "required": [ "nightlyMinor", "totalBeforeTaxMinor", "currency" ], "properties": { "nightlyMinor": { "type": "integer" }, "totalBeforeTaxMinor": { "type": "integer" }, "currency": { "type": "string" } } } } } }, "meta": { "type": "object", "additionalProperties": false, "required": [ "checkIn", "checkOut", "nights", "guests", "propertiesChecked", "openCount", "lastSyncedAt" ], "properties": { "checkIn": { "type": "string" }, "checkOut": { "type": "string" }, "nights": { "type": "integer" }, "guests": { "type": "integer" }, "propertiesChecked": { "type": "integer" }, "openCount": { "type": "integer" }, "lastSyncedAt": { "type": [ "null", "string" ] } } } } }, "example": { "data": [ { "id": "22222222-2222-4222-8222-222222222222", "slug": "sandbox-chalet", "available": true, "display": { "nightlyMinor": 30000, "totalBeforeTaxMinor": 90000, "currency": "USD" } }, { "id": "33333333-3333-4333-8333-333333333333", "slug": "sandbox-bungalow", "available": false }, { "id": "44444444-4444-4444-8444-444444444444", "slug": "sandbox-cottage", "available": null } ], "meta": { "checkIn": "2026-08-01", "checkOut": "2026-08-04", "nights": 3, "guests": 2, "propertiesChecked": 3, "openCount": 1, "lastSyncedAt": "2026-07-01T00:00:00.000Z" } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "API + Booking Platform", "x-kismet-quota-cost": 1, "x-kismet-freshness": "synced-commercial", "x-kismet-maturity": "beta", "x-kismet-required-capability": "rates.read" } }, "/v1/developer/collections/{collection}/articles": { "get": { "operationId": "listCollectionArticles", "summary": "List published articles for a manager", "tags": [ "developer-articles" ], "description": "Returns published, Kismet-authored articles for the granted manager: editorial content with a bounded typed block body, author bylines, and a publisher-derived schema.org BlogPosting node builders re-point at their own pages. Draft content is never returned.", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "query", "name": "cursor", "required": false }, { "schema": { "type": "integer", "minimum": 1, "maximum": 50, "default": 20 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "collection", "required": true } ], "security": [ { "kismetDeveloperKey": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "data", "page" ], "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "resourceType", "type", "id", "slug", "title", "displayType", "categories", "publication", "links" ], "properties": { "resourceType": { "enum": [ "content" ] }, "type": { "enum": [ "article" ] }, "id": { "type": "string" }, "slug": { "type": "string" }, "title": { "type": "string" }, "excerpt": { "type": "string" }, "displayType": { "type": "string" }, "hero": { "type": "object", "additionalProperties": false, "required": [ "url" ], "properties": { "url": { "type": "string" }, "alt": { "type": "string" }, "caption": { "type": "string" } } }, "author": { "type": "object", "additionalProperties": false, "required": [ "name" ], "properties": { "name": { "type": "string" }, "title": { "type": "string" }, "avatarUrl": { "type": "string" } } }, "categories": { "type": "array", "items": { "type": "string" } }, "publication": { "type": "object", "additionalProperties": false, "required": [ "publishedAt", "updatedAt" ], "properties": { "publishedAt": { "type": "string" }, "updatedAt": { "type": "string" } } }, "links": { "type": "object", "additionalProperties": false, "required": [ "self" ], "properties": { "self": { "type": "string" } } } } } }, "page": { "type": "object", "additionalProperties": false, "required": [ "limit", "nextCursor" ], "properties": { "limit": { "type": "integer" }, "nextCursor": { "type": [ "null", "string" ] } } } } }, "example": { "data": [ { "resourceType": "content", "type": "article", "id": "33333333-3333-4333-8333-333333333333", "slug": "three-perfect-days-in-sandbox-cove", "title": "Three perfect days in Sandbox Cove", "excerpt": "A long-weekend itinerary built around the tide pools.", "displayType": "default", "hero": { "url": "https://cdn.kismet.travel/sandbox/cove-hero.jpg", "alt": "Tide pools at dusk" }, "author": { "name": "Jamie Sandbox", "title": "General Manager" }, "categories": [ "Travel guides" ], "publication": { "publishedAt": "2026-06-20T00:00:00.000Z", "updatedAt": "2026-07-01T00:00:00.000Z" }, "links": { "self": "/v1/developer/collections/11111111-1111-4111-8111-111111111111/articles/three-perfect-days-in-sandbox-cove" } } ], "page": { "limit": 20, "nextCursor": null } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "API + Developer Experience + Content", "x-kismet-quota-cost": 1, "x-kismet-freshness": "published-content", "x-kismet-maturity": "beta", "x-kismet-required-capability": "articles.read" } }, "/v1/developer/collections/{collection}/articles/{article}": { "get": { "operationId": "getCollectionArticle", "summary": "Get one published article", "tags": [ "developer-articles" ], "description": "Returns published, Kismet-authored articles for the granted manager: editorial content with a bounded typed block body, author bylines, and a publisher-derived schema.org BlogPosting node builders re-point at their own pages. Draft content is never returned.", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "collection", "required": true }, { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "article", "required": true } ], "security": [ { "kismetDeveloperKey": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "resourceType", "type", "id", "slug", "title", "displayType", "categories", "publication", "links", "bodyFormat", "body" ], "properties": { "resourceType": { "enum": [ "content" ] }, "type": { "enum": [ "article" ] }, "id": { "type": "string" }, "slug": { "type": "string" }, "title": { "type": "string" }, "excerpt": { "type": "string" }, "displayType": { "type": "string" }, "hero": { "type": "object", "additionalProperties": false, "required": [ "url" ], "properties": { "url": { "type": "string" }, "alt": { "type": "string" }, "caption": { "type": "string" } } }, "author": { "type": "object", "additionalProperties": false, "required": [ "name" ], "properties": { "name": { "type": "string" }, "title": { "type": "string" }, "avatarUrl": { "type": "string" } } }, "categories": { "type": "array", "items": { "type": "string" } }, "publication": { "type": "object", "additionalProperties": false, "required": [ "publishedAt", "updatedAt" ], "properties": { "publishedAt": { "type": "string" }, "updatedAt": { "type": "string" } } }, "links": { "type": "object", "additionalProperties": false, "required": [ "self" ], "properties": { "self": { "type": "string" } } }, "bodyFormat": { "enum": [ "kismet-blocks@1" ] }, "body": { "type": "array", "items": { "anyOf": [ { "type": "object", "additionalProperties": false, "required": [ "type", "html" ], "properties": { "type": { "enum": [ "prose" ] }, "html": { "type": "string" } } }, { "type": "object", "additionalProperties": false, "required": [ "type", "url" ], "properties": { "type": { "enum": [ "image" ] }, "url": { "type": "string" }, "alt": { "type": "string" }, "caption": { "type": "string" } } }, { "type": "object", "additionalProperties": false, "required": [ "type", "text" ], "properties": { "type": { "enum": [ "pullquote" ] }, "text": { "type": "string" }, "cite": { "type": "string" } } }, { "type": "object", "additionalProperties": false, "required": [ "type", "items" ], "properties": { "type": { "enum": [ "faq" ] }, "items": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "q", "a" ], "properties": { "q": { "type": "string" }, "a": { "type": "string" } } } } } }, { "type": "object", "additionalProperties": false, "required": [ "type", "vacationRentalId", "links" ], "properties": { "type": { "enum": [ "property" ] }, "vacationRentalId": { "type": "string" }, "links": { "type": "object", "additionalProperties": false, "required": [ "vacationRental" ], "properties": { "vacationRental": { "type": "string" } } } } }, { "type": "object", "additionalProperties": false, "required": [ "type", "originalType" ], "properties": { "type": { "enum": [ "redacted" ] }, "originalType": { "type": "string" } } } ] } }, "schemaOrg": { "type": "object", "additionalProperties": true } } }, "example": { "resourceType": "content", "type": "article", "id": "33333333-3333-4333-8333-333333333333", "slug": "three-perfect-days-in-sandbox-cove", "title": "Three perfect days in Sandbox Cove", "excerpt": "A long-weekend itinerary built around the tide pools.", "displayType": "default", "hero": { "url": "https://cdn.kismet.travel/sandbox/cove-hero.jpg", "alt": "Tide pools at dusk" }, "author": { "name": "Jamie Sandbox", "title": "General Manager" }, "categories": [ "Travel guides" ], "publication": { "publishedAt": "2026-06-20T00:00:00.000Z", "updatedAt": "2026-07-01T00:00:00.000Z" }, "links": { "self": "/v1/developer/collections/11111111-1111-4111-8111-111111111111/articles/three-perfect-days-in-sandbox-cove" }, "bodyFormat": "kismet-blocks@1", "body": [ { "type": "prose", "html": "

Start at the north jetty before the fog lifts…

" }, { "type": "image", "url": "https://cdn.kismet.travel/sandbox/cove-jetty.jpg", "alt": "North jetty at dawn" }, { "type": "property", "vacationRentalId": "22222222-2222-4222-8222-222222222222", "links": { "vacationRental": "/v1/developer/vacation-rentals/22222222-2222-4222-8222-222222222222" } }, { "type": "redacted", "originalType": "capture" } ], "schemaOrg": { "@context": "https://schema.org", "@type": "BlogPosting", "headline": "Three perfect days in Sandbox Cove", "datePublished": "2026-06-20T00:00:00.000Z" } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "API + Developer Experience + Content", "x-kismet-quota-cost": 1, "x-kismet-freshness": "published-content", "x-kismet-maturity": "beta", "x-kismet-required-capability": "articles.read" } }, "/v1/developer/fixtures": { "get": { "operationId": "listFixtures", "summary": "List fixture manifests", "tags": [ "developer-fixtures" ], "description": "Fixture manifests are global, versioned metadata describing what each fixture renders, the developer operations that satisfy its data requirements, its dashboard-editable settings, and its install targets. Coding agents can inspect fixtures here without reading React implementation files.", "parameters": [ { "schema": { "type": "string", "enum": [ "supported", "preview", "unsupported" ] }, "in": "query", "name": "status", "required": false } ], "security": [ { "kismetDeveloperKey": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "data", "meta" ], "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "manifestSchemaVersion", "id", "title", "description", "fixtureVersion", "status", "statusReason", "source", "installMethods", "renderTargets", "requires", "themeTokens", "data", "settings", "enablement" ], "properties": { "manifestSchemaVersion": { "enum": [ 1 ] }, "id": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "fixtureVersion": { "type": "string" }, "status": { "type": "string", "enum": [ "supported", "preview", "unsupported" ] }, "statusReason": { "type": "string" }, "source": { "type": "object", "additionalProperties": false, "required": [ "package", "contractPath", "propsExport" ], "properties": { "package": { "enum": [ "@kismet-tech/elements" ] }, "contractPath": { "type": "string" }, "propsExport": { "type": [ "null", "string" ] } } }, "installMethods": { "type": "array", "items": { "type": "string", "enum": [ "block", "shortcode", "embedjs", "npm", "iframe" ] } }, "renderTargets": { "type": "array", "items": { "enum": [ "dom" ] } }, "requires": { "type": "array", "items": { "type": "string" } }, "optional": { "type": "array", "items": { "type": "string" } }, "themeTokens": { "type": "array", "items": { "type": "string" } }, "data": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "need", "description", "required", "operationId", "capability", "coverage" ], "properties": { "need": { "type": "string" }, "description": { "type": "string" }, "required": { "type": "boolean" }, "operationId": { "type": [ "null", "string" ] }, "capability": { "type": [ "null", "string" ] }, "coverage": { "type": "string", "enum": [ "full", "partial", "missing" ] }, "gaps": { "type": "array", "items": { "type": "string" } }, "compatibilityEndpoint": { "type": "string" } } } }, "commercialActions": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "need", "description", "required", "operationId", "coverage" ], "properties": { "need": { "type": "string" }, "description": { "type": "string" }, "required": { "type": "boolean" }, "operationId": { "type": "null" }, "coverage": { "enum": [ "missing" ] } } } }, "settings": { "anyOf": [ { "type": "null" }, { "type": "object", "additionalProperties": false, "required": [ "elementType", "configSchemaVersion", "schema", "defaults", "dashboardEditable" ], "properties": { "elementType": { "type": "string", "enum": [ "results_page", "property_detail" ] }, "configSchemaVersion": { "enum": [ 1 ] }, "schema": { "type": "object", "additionalProperties": true }, "defaults": { "type": "object", "additionalProperties": true }, "dashboardEditable": { "enum": [ true ] } } } ] }, "enablement": { "anyOf": [ { "type": "null" }, { "type": "object", "additionalProperties": false, "required": [ "fixtureType", "defaultEnabled" ], "properties": { "fixtureType": { "type": "string" }, "defaultEnabled": { "type": "boolean" } } } ] }, "page": { "type": "object", "additionalProperties": false, "properties": { "pageType": { "type": "string" }, "singleRoute": { "type": "string" } } } } } }, "meta": { "type": "object", "additionalProperties": false, "required": [ "total", "registrySchemaVersion" ], "properties": { "total": { "type": "integer" }, "registrySchemaVersion": { "enum": [ 1 ] } } } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "Elements + Polymer + Developer Experience", "x-kismet-quota-cost": 1, "x-kismet-freshness": "registry-metadata", "x-kismet-maturity": "beta", "x-kismet-required-capability": "fixtures.read" } }, "/v1/developer/fixtures/{fixture}": { "get": { "operationId": "getFixture", "summary": "Get one fixture manifest", "tags": [ "developer-fixtures" ], "description": "Fixture manifests are global, versioned metadata describing what each fixture renders, the developer operations that satisfy its data requirements, its dashboard-editable settings, and its install targets. Coding agents can inspect fixtures here without reading React implementation files.", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "fixture", "required": true } ], "security": [ { "kismetDeveloperKey": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "manifestSchemaVersion", "id", "title", "description", "fixtureVersion", "status", "statusReason", "source", "installMethods", "renderTargets", "requires", "themeTokens", "data", "settings", "enablement" ], "properties": { "manifestSchemaVersion": { "enum": [ 1 ] }, "id": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "fixtureVersion": { "type": "string" }, "status": { "type": "string", "enum": [ "supported", "preview", "unsupported" ] }, "statusReason": { "type": "string" }, "source": { "type": "object", "additionalProperties": false, "required": [ "package", "contractPath", "propsExport" ], "properties": { "package": { "enum": [ "@kismet-tech/elements" ] }, "contractPath": { "type": "string" }, "propsExport": { "type": [ "null", "string" ] } } }, "installMethods": { "type": "array", "items": { "type": "string", "enum": [ "block", "shortcode", "embedjs", "npm", "iframe" ] } }, "renderTargets": { "type": "array", "items": { "enum": [ "dom" ] } }, "requires": { "type": "array", "items": { "type": "string" } }, "optional": { "type": "array", "items": { "type": "string" } }, "themeTokens": { "type": "array", "items": { "type": "string" } }, "data": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "need", "description", "required", "operationId", "capability", "coverage" ], "properties": { "need": { "type": "string" }, "description": { "type": "string" }, "required": { "type": "boolean" }, "operationId": { "type": [ "null", "string" ] }, "capability": { "type": [ "null", "string" ] }, "coverage": { "type": "string", "enum": [ "full", "partial", "missing" ] }, "gaps": { "type": "array", "items": { "type": "string" } }, "compatibilityEndpoint": { "type": "string" } } } }, "commercialActions": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "need", "description", "required", "operationId", "coverage" ], "properties": { "need": { "type": "string" }, "description": { "type": "string" }, "required": { "type": "boolean" }, "operationId": { "type": "null" }, "coverage": { "enum": [ "missing" ] } } } }, "settings": { "anyOf": [ { "type": "null" }, { "type": "object", "additionalProperties": false, "required": [ "elementType", "configSchemaVersion", "schema", "defaults", "dashboardEditable" ], "properties": { "elementType": { "type": "string", "enum": [ "results_page", "property_detail" ] }, "configSchemaVersion": { "enum": [ 1 ] }, "schema": { "type": "object", "additionalProperties": true }, "defaults": { "type": "object", "additionalProperties": true }, "dashboardEditable": { "enum": [ true ] } } } ] }, "enablement": { "anyOf": [ { "type": "null" }, { "type": "object", "additionalProperties": false, "required": [ "fixtureType", "defaultEnabled" ], "properties": { "fixtureType": { "type": "string" }, "defaultEnabled": { "type": "boolean" } } } ] }, "page": { "type": "object", "additionalProperties": false, "properties": { "pageType": { "type": "string" }, "singleRoute": { "type": "string" } } } } }, "example": { "manifestSchemaVersion": 1, "id": "action-bar", "title": "Action bar", "description": "Results-page control strip: grid/map view toggle, saved toggle, mobile filter-drawer trigger.", "fixtureVersion": "0.1.0", "status": "supported", "statusReason": "Props-only fixture with no backend data requirement.", "source": { "package": "@kismet-tech/elements", "contractPath": "packages/elements/src/elements/ActionBar.contract.ts", "propsExport": "ActionBarProps" }, "installMethods": [ "block", "shortcode", "embedjs" ], "renderTargets": [ "dom" ], "requires": [], "themeTokens": [ "accent", "surface", "text", "textMuted", "border" ], "data": [], "settings": null, "enablement": null } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "Elements + Polymer + Developer Experience", "x-kismet-quota-cost": 1, "x-kismet-freshness": "registry-metadata", "x-kismet-maturity": "beta", "x-kismet-required-capability": "fixtures.read" } }, "/v1/developer/vacation-rentals/{vacationRental}/booking-requests": { "post": { "operationId": "createVacationRentalBookingRequest", "summary": "Create a sandbox booking request for a vacation rental", "tags": [ "developer-bookings" ], "description": "Records a request-to-book for the granted vacation rental as a REAL Kismet reservation record — the guestbook, journey, and telemetry planes light up exactly as for a live booking — with the PMS mirror suppressed and no charge. Sandbox semantics are the meaning of a TEST-environment installation on this operation; a LIVE installation receives 409 SANDBOX_ONLY in this contract version (live transactional writes are the Kismet Pay lane). The Developer Bearer credential establishes installation authority. A host BFF may additionally send its server-only `X-Kismet-Guest-Token`, `X-Kismet-CSRF`, and the `kidSid` verified during sign-in; that token subject then establishes the human and `guest` contact becomes optional. Contact can enrich only the same principal and never selects another guest. Anonymous requests retain the required `guest` contact contract. Server-side authority: the stay is re-fitted against the synced calendar and re-quoted by the same engine checkout uses; a client price is never accepted. Replay-safe: the same installation + rental + stay + guest email resolves to the same request and confirmation code; send `Idempotency-Key` to create a deliberate second request for the same guest and stay. Never writes a revenue-attribution record and never fires an ad destination.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "checkIn", "checkOut", "guests" ], "properties": { "checkIn": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "checkOut": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "guests": { "type": "integer", "minimum": 1, "maximum": 99 }, "guest": { "type": "object", "additionalProperties": false, "required": [ "firstName", "lastName", "email" ], "properties": { "firstName": { "type": "string", "minLength": 1, "maxLength": 100 }, "lastName": { "type": "string", "minLength": 1, "maxLength": 100 }, "email": { "type": "string", "minLength": 3, "maxLength": 254 }, "phone": { "type": [ "string", "null" ], "maxLength": 40 } } }, "kidSid": { "type": [ "string", "null" ], "pattern": "^kid_[A-Za-z0-9]{6,40}$" } } } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "vacationRental", "required": true }, { "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "in": "header", "name": "idempotency-key", "required": false }, { "schema": { "type": "string" }, "in": "header", "name": "x-kismet-guest-token", "required": false, "description": "Optional server-only guest access token. When present, the token subject is the booking human and guest contact cannot select another identity." }, { "schema": { "type": "string" }, "in": "header", "name": "x-kismet-csrf", "required": false, "description": "Required with X-Kismet-Guest-Token. Same-origin proof validated by the host BFF." } ], "security": [ { "kismetDeveloperKey": [] } ], "responses": { "201": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "requestId", "confirmationCode", "status", "sandbox", "stay", "vacationRental" ], "properties": { "requestId": { "type": "string" }, "confirmationCode": { "type": "string" }, "status": { "type": "string", "enum": [ "received" ] }, "sandbox": { "type": "boolean", "enum": [ true ] }, "stay": { "type": "object", "additionalProperties": false, "required": [ "checkIn", "checkOut", "nights", "guests" ], "properties": { "checkIn": { "type": "string" }, "checkOut": { "type": "string" }, "nights": { "type": "integer" }, "guests": { "type": "integer" } } }, "vacationRental": { "type": "object", "additionalProperties": false, "required": [ "id", "slug" ], "properties": { "id": { "type": "string" }, "slug": { "type": "string" } } }, "display": { "type": "object", "additionalProperties": false, "required": [ "nightlyMinor", "totalBeforeTaxMinor", "currency" ], "properties": { "nightlyMinor": { "type": "integer" }, "totalBeforeTaxMinor": { "type": "integer" }, "currency": { "type": "string" } } } } }, "example": { "requestId": "55555555-5555-4555-8555-555555555555", "confirmationCode": "SBX-K7QM2H9", "status": "received", "sandbox": true, "stay": { "checkIn": "2026-08-01", "checkOut": "2026-08-04", "nights": 3, "guests": 2 }, "vacationRental": { "id": "22222222-2222-4222-8222-222222222222", "slug": "sandbox-chalet" }, "display": { "nightlyMinor": 30000, "totalBeforeTaxMinor": 90000, "currency": "USD" } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "API + Booking Platform", "x-kismet-quota-cost": 1, "x-kismet-freshness": "sandbox-write", "x-kismet-maturity": "beta", "x-kismet-required-capability": "bookings.write" } }, "/v1/developer/guest-auth/challenges": { "post": { "operationId": "challengeDeveloperGuestAuth", "summary": "Start branded email-code guest authentication", "tags": [ "developer-guest-auth" ], "description": "Creates an email OTP challenge bound to this installation, collection, exact Kismet identity anchor (`kidSid`), and a branded host authorized through Collection.authorizedDomains. Requires a server (`sk_`) credential and a same-origin BFF CSRF proof. The response includes child-brand auth presentation with missing fields inherited only from the nearest cycle-safe SUB_BRAND parent. TEST installations never send email: registered test recipients receive a deterministic verification code in this authenticated server response; all other addresses receive the same accepted response without a usable code.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "email", "kidSid" ], "properties": { "email": { "type": "string", "minLength": 3, "maxLength": 254 }, "kidSid": { "type": "string", "pattern": "^kid_[A-Za-z0-9]{8}$" } } } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "minLength": 16, "maxLength": 512 }, "in": "header", "name": "x-kismet-csrf", "required": true, "description": "Opaque CSRF proof validated by the same-origin host BFF before it calls Kismet. Never a Kismet credential." }, { "schema": { "type": "string" }, "in": "header", "name": "origin", "required": false, "description": "Original branded browser origin forwarded by the same-origin BFF. Must match Collection.authorizedDomains." }, { "schema": { "type": "string" }, "in": "header", "name": "x-forwarded-host", "required": false, "description": "Original branded host fallback for server route handlers that do not forward Origin. Must match Collection.authorizedDomains." } ], "security": [ { "kismetDeveloperKey": [] } ], "responses": { "202": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "accepted", "challengeId", "expiresAt", "branding" ], "properties": { "accepted": { "type": "boolean", "enum": [ true ] }, "challengeId": { "type": "string", "format": "uuid" }, "expiresAt": { "type": "string", "format": "date-time" }, "testVerificationCode": { "type": "string", "pattern": "^\\d{6}$", "description": "TEST only, and only for an address registered on this installation. Never returned in LIVE." }, "branding": { "type": "object", "additionalProperties": false, "required": [ "displayName", "logoUrl", "faviconUrl", "supportEmail", "policyLinks", "accountProvider" ], "properties": { "displayName": { "type": "string" }, "logoUrl": { "type": [ "null", "string" ] }, "faviconUrl": { "type": [ "null", "string" ] }, "supportEmail": { "type": [ "null", "string" ] }, "policyLinks": { "type": "object", "additionalProperties": false, "required": [ "termsUrl", "privacyUrl" ], "properties": { "termsUrl": { "type": [ "null", "string" ] }, "privacyUrl": { "type": [ "null", "string" ] } } }, "accountProvider": { "type": "string", "enum": [ "Kismet" ] } } } } }, "example": { "accepted": true, "challengeId": "66666666-6666-4666-8666-666666666666", "expiresAt": "2026-08-18T18:05:00.000Z", "testVerificationCode": "042817", "branding": { "displayName": "Sandbox Vacation Rentals", "logoUrl": "https://cdn.kismet.travel/sandbox/logo.svg", "faviconUrl": "https://cdn.kismet.travel/sandbox/favicon.ico", "supportEmail": "support@example.invalid", "policyLinks": { "termsUrl": "https://example.invalid/terms", "privacyUrl": "https://example.invalid/privacy" }, "accountProvider": "Kismet" } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "Identity + Developer Experience", "x-kismet-quota-cost": 1, "x-kismet-freshness": "sandbox-write", "x-kismet-maturity": "beta", "x-kismet-required-capability": "guest_auth.write" } }, "/v1/developer/guest-auth/challenges/{challengeId}/verify": { "post": { "operationId": "verifyDeveloperGuestAuth", "summary": "Verify a branded guest authentication challenge", "tags": [ "developer-guest-auth" ], "description": "Consumes a single-use challenge only from a branded host authorized through Collection.authorizedDomains, binds the proven Guest and canonical GuestProfile to the same `kidSid`, and returns guest session tokens to the host BFF. The BFF must set its own branded HttpOnly cookie; Kismet credentials and tokens must never enter browser JavaScript.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "code", "kidSid" ], "properties": { "code": { "type": "string", "pattern": "^\\d{6}$" }, "kidSid": { "type": "string", "pattern": "^kid_[A-Za-z0-9]{8}$" } } } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "challengeId", "required": true }, { "schema": { "type": "string", "minLength": 16, "maxLength": 512 }, "in": "header", "name": "x-kismet-csrf", "required": true, "description": "Opaque CSRF proof validated by the same-origin host BFF before it calls Kismet. Never a Kismet credential." }, { "schema": { "type": "string" }, "in": "header", "name": "origin", "required": false, "description": "Original branded browser origin forwarded by the same-origin BFF. Must match Collection.authorizedDomains." }, { "schema": { "type": "string" }, "in": "header", "name": "x-forwarded-host", "required": false, "description": "Original branded host fallback for server route handlers that do not forward Origin. Must match Collection.authorizedDomains." } ], "security": [ { "kismetDeveloperKey": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "kidSid", "guest", "session" ], "properties": { "kidSid": { "type": "string" }, "guest": { "type": "object", "additionalProperties": false, "required": [ "id", "email", "guestProfileId" ], "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "guestProfileId": { "type": "string" } } }, "session": { "type": "object", "additionalProperties": false, "required": [ "accessToken", "refreshToken", "expiresAt" ], "properties": { "accessToken": { "type": "string" }, "refreshToken": { "type": "string" }, "expiresAt": { "type": "string", "format": "date-time" } } } } }, "example": { "kidSid": "kid_AbCdEf12", "guest": { "id": "77777777-7777-4777-8777-777777777777", "email": "developer-test@example.com", "guestProfileId": "88888888-8888-4888-8888-888888888888" }, "session": { "accessToken": "", "refreshToken": "", "expiresAt": "2026-09-17T18:00:00.000Z" } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "410": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "Identity + Developer Experience", "x-kismet-quota-cost": 1, "x-kismet-freshness": "sandbox-write", "x-kismet-maturity": "beta", "x-kismet-required-capability": "guest_auth.write" } }, "/v1/developer/guest-auth/session/refresh": { "post": { "operationId": "refreshDeveloperGuestSession", "summary": "Refresh a branded guest session", "tags": [ "developer-guest-auth" ], "description": "Exchanges a BFF-held Kismet refresh token for a new short-lived guest access token after re-authorizing the Developer installation, same-origin CSRF proof, and branded host. The refresh token remains server-side and is not rotated in this contract version.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "refreshToken" ], "properties": { "refreshToken": { "type": "string", "minLength": 1, "maxLength": 4096 } } } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "minLength": 16, "maxLength": 512 }, "in": "header", "name": "x-kismet-csrf", "required": true, "description": "Opaque CSRF proof validated by the same-origin host BFF before it calls Kismet. Never a Kismet credential." }, { "schema": { "type": "string" }, "in": "header", "name": "origin", "required": false, "description": "Original branded browser origin forwarded by the same-origin BFF. Must match Collection.authorizedDomains." }, { "schema": { "type": "string" }, "in": "header", "name": "x-forwarded-host", "required": false, "description": "Original branded host fallback for server route handlers that do not forward Origin. Must match Collection.authorizedDomains." } ], "security": [ { "kismetDeveloperKey": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "session" ], "properties": { "session": { "type": "object", "additionalProperties": false, "required": [ "accessToken", "expiresAt" ], "properties": { "accessToken": { "type": "string" }, "expiresAt": { "type": "string", "format": "date-time" } } } } }, "example": { "session": { "accessToken": "", "expiresAt": "2026-08-18T18:15:00.000Z" } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "Identity + Developer Experience", "x-kismet-quota-cost": 1, "x-kismet-freshness": "authenticated-state", "x-kismet-maturity": "beta", "x-kismet-required-capability": "guest_auth.write" } }, "/v1/developer/guest-auth/session/logout": { "post": { "operationId": "logoutDeveloperGuestSession", "summary": "Log out a branded guest session", "tags": [ "developer-guest-auth" ], "description": "Idempotently revokes the BFF-held Kismet refresh token after re-authorizing the Developer installation, same-origin CSRF proof, and branded host. The public response is identical when the session is already absent, expired, or revoked so callers can always clear their sealed same-origin cookie.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "refreshToken" ], "properties": { "refreshToken": { "type": "string", "minLength": 1, "maxLength": 4096 } } } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "minLength": 16, "maxLength": 512 }, "in": "header", "name": "x-kismet-csrf", "required": true, "description": "Opaque CSRF proof validated by the same-origin host BFF before it calls Kismet. Never a Kismet credential." }, { "schema": { "type": "string" }, "in": "header", "name": "origin", "required": false, "description": "Original branded browser origin forwarded by the same-origin BFF. Must match Collection.authorizedDomains." }, { "schema": { "type": "string" }, "in": "header", "name": "x-forwarded-host", "required": false, "description": "Original branded host fallback for server route handlers that do not forward Origin. Must match Collection.authorizedDomains." } ], "security": [ { "kismetDeveloperKey": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "success" ], "properties": { "success": { "type": "boolean", "enum": [ true ] } } }, "example": { "success": true } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "Identity + Developer Experience", "x-kismet-quota-cost": 1, "x-kismet-freshness": "authenticated-state", "x-kismet-maturity": "beta", "x-kismet-required-capability": "guest_auth.write" } }, "/v1/developer/guest/me": { "get": { "operationId": "getDeveloperGuestSelf", "summary": "Read the signed-in guest account for this installation", "tags": [ "developer-guest-account" ], "description": "Returns self identity plus memberships, bookings, saves, and canonical payment-on-file state filtered to this installation collection. TEST returns sandbox bookings only; LIVE excludes all sandbox rows.", "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "bookingCursor", "required": false }, { "schema": { "type": "integer", "minimum": 1, "maximum": 50, "default": 20 }, "in": "query", "name": "bookingLimit", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "saveCursor", "required": false }, { "schema": { "type": "integer", "minimum": 1, "maximum": 50, "default": 20 }, "in": "query", "name": "saveLimit", "required": false }, { "schema": { "type": "string", "minLength": 20, "maxLength": 4096 }, "in": "header", "name": "x-kismet-guest-token", "required": true, "description": "Server-only Kismet guest access token held by the same-origin BFF. Never expose it to browser JavaScript." } ], "security": [ { "kismetDeveloperKey": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "identity", "memberships", "bookings", "saves", "hasPaymentOnFile" ], "properties": { "identity": { "type": "object", "additionalProperties": false, "required": [ "id", "guestProfileId", "email", "phone", "firstName", "lastName", "displayName", "avatarUrl", "emailVerified", "phoneVerified" ], "properties": { "id": { "type": "string" }, "guestProfileId": { "type": "string" }, "email": { "type": [ "null", "string" ] }, "phone": { "type": [ "null", "string" ] }, "firstName": { "type": [ "null", "string" ] }, "lastName": { "type": [ "null", "string" ] }, "displayName": { "type": [ "null", "string" ] }, "avatarUrl": { "type": [ "null", "string" ] }, "emailVerified": { "type": "boolean" }, "phoneVerified": { "type": "boolean" } } }, "memberships": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "collection", "status", "tier", "joinedAt" ], "properties": { "collection": { "type": "object", "additionalProperties": false, "required": [ "id", "slug", "name" ], "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" } } }, "status": { "type": "string", "enum": [ "ACTIVE", "CANCELED" ] }, "tier": { "type": [ "null", "string" ] }, "joinedAt": { "type": "string", "format": "date-time" } } } }, "bookings": { "type": "object", "additionalProperties": false, "required": [ "data", "page" ], "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "id", "confirmationCode", "status", "isSandbox", "checkIn", "checkOut", "nights", "guests", "currency", "totalPaidMinor", "balanceDueMinor", "vacationRental" ], "properties": { "id": { "type": "string" }, "confirmationCode": { "type": [ "null", "string" ] }, "status": { "type": "string" }, "isSandbox": { "type": "boolean" }, "checkIn": { "type": "string", "format": "date-time" }, "checkOut": { "type": "string", "format": "date-time" }, "nights": { "type": "integer" }, "guests": { "type": [ "null", "integer" ] }, "currency": { "type": "string" }, "totalPaidMinor": { "type": [ "null", "integer" ] }, "balanceDueMinor": { "type": [ "null", "integer" ] }, "vacationRental": { "type": "object", "additionalProperties": false, "required": [ "slug", "name" ], "properties": { "slug": { "type": "string" }, "name": { "type": "string" } } } } } }, "page": { "type": "object", "additionalProperties": false, "required": [ "limit", "nextCursor" ], "properties": { "limit": { "type": "integer" }, "nextCursor": { "type": [ "null", "string" ] } } } } }, "saves": { "type": "object", "additionalProperties": false, "required": [ "data", "page" ], "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "id", "savedAt", "checkIn", "checkOut", "vacationRental" ], "properties": { "id": { "type": "string" }, "savedAt": { "type": "string", "format": "date-time" }, "checkIn": { "type": [ "null", "string" ], "format": "date-time" }, "checkOut": { "type": [ "null", "string" ], "format": "date-time" }, "vacationRental": { "type": "object", "additionalProperties": false, "required": [ "slug", "name" ], "properties": { "slug": { "type": "string" }, "name": { "type": "string" } } } } } }, "page": { "type": "object", "additionalProperties": false, "required": [ "limit", "nextCursor" ], "properties": { "limit": { "type": "integer" }, "nextCursor": { "type": [ "null", "string" ] } } } } }, "hasPaymentOnFile": { "type": "boolean" } } }, "example": { "identity": { "id": "77777777-7777-4777-8777-777777777777", "guestProfileId": "88888888-8888-4888-8888-888888888888", "email": "developer-test@example.com", "phone": null, "firstName": "Taylor", "lastName": "Guest", "displayName": "Taylor Guest", "avatarUrl": null, "emailVerified": true, "phoneVerified": false }, "memberships": [], "bookings": { "data": [], "page": { "limit": 20, "nextCursor": null } }, "saves": { "data": [], "page": { "limit": 20, "nextCursor": null } }, "hasPaymentOnFile": false } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "Identity + Developer Experience", "x-kismet-quota-cost": 1, "x-kismet-freshness": "authenticated-state", "x-kismet-maturity": "beta", "x-kismet-required-capability": "guest_auth.write" } }, "/v1/developer/guest/me/saves": { "get": { "operationId": "listDeveloperGuestSaves", "summary": "List the signed-in guest saved vacation rentals", "tags": [ "developer-guest-account" ], "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "cursor", "required": false }, { "schema": { "type": "integer", "minimum": 1, "maximum": 50, "default": 20 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "string", "minLength": 20, "maxLength": 4096 }, "in": "header", "name": "x-kismet-guest-token", "required": true, "description": "Server-only Kismet guest access token held by the same-origin BFF. Never expose it to browser JavaScript." } ], "security": [ { "kismetDeveloperKey": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "data", "page" ], "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "id", "savedAt", "checkIn", "checkOut", "vacationRental" ], "properties": { "id": { "type": "string" }, "savedAt": { "type": "string", "format": "date-time" }, "checkIn": { "type": [ "null", "string" ], "format": "date-time" }, "checkOut": { "type": [ "null", "string" ], "format": "date-time" }, "vacationRental": { "type": "object", "additionalProperties": false, "required": [ "slug", "name" ], "properties": { "slug": { "type": "string" }, "name": { "type": "string" } } } } } }, "page": { "type": "object", "additionalProperties": false, "required": [ "limit", "nextCursor" ], "properties": { "limit": { "type": "integer" }, "nextCursor": { "type": [ "null", "string" ] } } } } }, "example": { "data": [], "page": { "limit": 20, "nextCursor": null } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "Identity + Developer Experience", "x-kismet-quota-cost": 1, "x-kismet-freshness": "authenticated-state", "x-kismet-maturity": "beta", "x-kismet-required-capability": "guest_auth.write" } }, "/v1/developer/guest/me/saves/{vacationRentalSlug}": { "put": { "operationId": "saveDeveloperGuestVacationRental", "summary": "Save a vacation rental for the signed-in guest", "tags": [ "developer-guest-account" ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 255 }, "in": "path", "name": "vacationRentalSlug", "required": true }, { "schema": { "type": "string", "minLength": 20, "maxLength": 4096 }, "in": "header", "name": "x-kismet-guest-token", "required": true, "description": "Server-only Kismet guest access token held by the same-origin BFF. Never expose it to browser JavaScript." }, { "schema": { "type": "string", "minLength": 16, "maxLength": 512 }, "in": "header", "name": "x-kismet-csrf", "required": true, "description": "Opaque CSRF proof validated by the same-origin host BFF before it calls Kismet." } ], "security": [ { "kismetDeveloperKey": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "saved", "vacationRentalSlug" ], "properties": { "saved": { "type": "boolean" }, "vacationRentalSlug": { "type": "string" } } }, "example": { "saved": true, "vacationRentalSlug": "sandbox-chalet" } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "Identity + Developer Experience", "x-kismet-quota-cost": 1, "x-kismet-freshness": "authenticated-state", "x-kismet-maturity": "beta", "x-kismet-required-capability": "guest_auth.write" }, "delete": { "operationId": "unsaveDeveloperGuestVacationRental", "summary": "Remove a vacation rental from the signed-in guest saves", "tags": [ "developer-guest-account" ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 255 }, "in": "path", "name": "vacationRentalSlug", "required": true }, { "schema": { "type": "string", "minLength": 20, "maxLength": 4096 }, "in": "header", "name": "x-kismet-guest-token", "required": true, "description": "Server-only Kismet guest access token held by the same-origin BFF. Never expose it to browser JavaScript." }, { "schema": { "type": "string", "minLength": 16, "maxLength": 512 }, "in": "header", "name": "x-kismet-csrf", "required": true, "description": "Opaque CSRF proof validated by the same-origin host BFF before it calls Kismet." } ], "security": [ { "kismetDeveloperKey": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "saved", "vacationRentalSlug" ], "properties": { "saved": { "type": "boolean" }, "vacationRentalSlug": { "type": "string" } } }, "example": { "saved": false, "vacationRentalSlug": "sandbox-chalet" } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "Identity + Developer Experience", "x-kismet-quota-cost": 1, "x-kismet-freshness": "authenticated-state", "x-kismet-maturity": "beta", "x-kismet-required-capability": "guest_auth.write" } } } }