Summarize stay availability across a collection

GET /v1/developer/collections/{collection}/vacation-rentals/availability

Operation ID: getCollectionAvailability

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.

Contract status

Field	Value
Maturity	`beta`
Required capability	`rates.read`
Freshness class	`synced-commercial`
Quota cost	`1`

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

Request parameters

Name	In	Type	Required	Description
`checkIn`	query	string	yes
`checkOut`	query	string	yes
`guests`	query	integer	no
`group`	query	string	no	Optional published bookable-product group id or slug. Availability is evaluated only for live members of that group.
`collection`	path	string	yes

Request body

This operation has no JSON request body.

cURL

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

curl --request GET \
  "$KISMET_API_ORIGIN/v1/developer/collections/example-collection/vacation-rentals/availability?checkIn=2027-01-11&checkOut=2027-01-16" \
  --header "Authorization: Bearer $KISMET_DEVELOPER_API_KEY" \
  --header "Accept: application/json"

Responses

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

200 response example

{
  "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"
  }
}

200 response schema

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

View complete response schema

{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "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"
          ]
        }
      }
    }
  }
}