---
title: "Check property availability"
method: POST
path: "/availability"
---

# Check property availability

`POST /availability`

## Request

- Base URL: `https://api.tellandgo.com/api/v1/agent`
- URL: `https://api.tellandgo.com/api/v1/agent/availability`
- Auth: API key in header `X-API-Key`

Check real-time availability and room rates for specific dates and guest configuration.

## Request body

- AvailabilityRequest: Provide either guests for a single-room/simple request or rooms for multi-room occupancy.
  - `property_id` string, required
  - `check_in` string, date, required
  - `check_out` string, date, required
  - `guests` object: Single-room/simple occupancy object. For multi-room requests, send rooms instead.
    - `adults` integer: Required only when rooms is omitted.
    - `children` integer[]: Array of child ages.
  - `rooms` object[]: Per-room occupancy for multi-room availability searches. Required when guests is omitted.
    - `adults` integer, required
    - `children` integer[]: Child ages for this room.

## Response `200`

Availability result

- AvailabilityResponse
  - `success` boolean
  - `available` boolean
  - `rooms` object[]
    - `id` string
    - `name` string
    - `description` string
    - `max_occupancy` integer
    - `rates` object[]
      - `rate_plan` string
      - `price_per_night` number
      - `total_price` number
      - `currency` string
      - `meal_plan` string
      - `cancellation_policy` string
      - `cancellation_policy_timezone` string: Timezone used for timestamps inside cancellation_policy.
      - `offer_id` string: Opaque live-rate offer ID. Pass as quote.room_id to quote this exact rate.
  - `hotel_policies` HotelPolicies: Supplier-neutral hotel policy metadata. Field names are stable across suppliers; raw supplier-specific policy keys are not exposed.
    - `extra_info` union: Optional free-text policy notes such as local taxes, fees, or other important hotel information.
      - string
      - object
    - `structured` object: Optional structured policy data normalized under supplier-neutral field names.
  - `booking_url` string, uri

## Other responses

- `400`: Invalid request
- `401`: Authentication required or invalid
- `404`: Resource not found

---

[API](https://skmtc.dev/tellandgo/apis/tell-go-travel-agent-api.md) · [All operations](https://skmtc.dev/tellandgo/apis/tell-go-travel-agent-api/llms.txt) · [OpenAPI document](https://skmtc.dev/tellandgo/apis/tell-go-travel-agent-api/revisions/3d84f816eb4f?raw)