---
title: "List reservations"
method: GET
path: "/v1/reservations"
tags: ["Reservations"]
---

# List reservations

`GET /v1/reservations`

## Request

- Base URL: `https://api.frihet.io`
- URL: `https://api.frihet.io/v1/reservations`
- Auth: API key in header `X-API-Key`

Retrieve a paginated list of Stay reservations with optional filters.

## Query parameters

- `limit` integer
- `offset` integer
- `cursor` string
- `from` string, date
- `to` string, date
- `q` string
- `fields` string
- `status` 'Pending' | 'Confirmed' | 'Checked In' | 'Checked Out' | 'Cancelled'

## Response `200`

A paginated list of reservations

- object
  - `data` Reservation[]
    - `id` string
    - `guestName` string
    - `guestEmail` string, nullable
    - `propertyId` string
    - `checkIn` string, date-time
    - `checkOut` string, date-time
    - `status` 'Pending' | 'Confirmed' | 'Checked In' | 'Checked Out' | 'Cancelled'
    - `amount` number
    - `channel` string
    - `confirmationCode` string, nullable
    - `complianceStatus` string
    - `nights` integer
    - `notes` string, nullable
    - `createdAt` string, date-time
    - `updatedAt` string, date-time
  - `total` integer: Total number of items matching the query
  - `limit` integer: Number of items per page
  - `offset` integer: Current offset
  - `nextCursor` string: Cursor for fetching the next page of results. Only present when there are more results available. Pass this value as the `cursor` query parameter in the next request. Base64url-encoded.
  - `truncated` boolean: Only present (and `true`) when the underlying search query saturated the internal 500-document cap. `total` therefore reports the size of the first 500 matches, not the full match count. Narrow the search query (taxId / fiscal id, exact email) to ensure you see every result.

## Other responses

- `401`: Authentication required or invalid API key
- `429`: Rate limit exceeded (100 requests per minute)

---

[API](https://skmtc.dev/frihet/apis/frihet-api.md) · [All operations](https://skmtc.dev/frihet/apis/frihet-api/llms.txt) · [OpenAPI document](https://skmtc.dev/frihet/apis/frihet-api/revisions/3dd37f6a72d1?raw)