GET
/
api
/
v1
/
reservation
[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "listingID": "123e4567-e89b-12d3-a456-426614174000",
    "integrationAccountID": "123e4567-e89b-12d3-a456-426614174000",
    "providerReservationID": "HMKYWB7BF8",
    "providerID": "3827197",
    "parentPropertyID": "PROP12345",
    "checkInDate": "2025-06-15",
    "checkOutDate": "2025-06-22",
    "guests": 2,
    "guest": {
      "id": "G12345",
      "name": "John Doe",
      "firstName": "John",
      "lastName": "Doe",
      "email": "john.doe@example.com",
      "phone": "+1234567890"
    },
    "adults": 2,
    "children": 1,
    "infants": 0,
    "pets": 0,
    "status": "CONFIRMED",
    "source": "website",
    "notes": "Guest requested early check-in if possible",
    "originalCurrency": "USD",
    "currency": "EUR",
    "totalPrice": 880,
    "components": {},
    "createdAt": "2025-05-20T14:30:00.000Z",
    "updatedAt": "2025-05-21T10:15:00.000Z",
    "cancelledAt": "2025-05-25T09:45:00.000Z",
    "confirmedAt": "2025-05-20T15:00:00.000Z"
  }
]

Authorizations

x-calry-api-key
string
header
required

Headers

x-calry-tenant-id
string

Optional tenant ID to specify which tenant to operate as. Controls which reservations are accessible. If not provided, the default tenant will be used.

Query Parameters

displayCurrency
string

Currency to display prices in (ISO 4217)

Example:

"USD"

integrationAccountID
string

Filter by integration account ID

Example:

"123e4567-e89b-12d3-a456-426614174000"

listingID
string

Filter by listing ID

Example:

"123e4567-e89b-12d3-a456-426614174000"

status
enum<string>

Filter by reservation status

Available options:
INQUIRY,
PENDING,
CONFIRMED,
MODIFIED,
MOVED,
CANCELLED,
EXPIRED,
NO_SHOW,
STAYING,
POST_STAY,
UNKNOWN,
BLOCKED
checkInStartDate
string

Filter by check-in date starting from

Example:

"2025-06-01T00:00:00.000Z"

checkInEndDate
string

Filter by check-in date up to

Example:

"2025-06-30T00:00:00.000Z"

checkOutStartDate
string

Filter by check-out date starting from

Example:

"2025-06-15T00:00:00.000Z"

checkOutEndDate
string

Filter by check-out date up to

Example:

"2025-07-15T00:00:00.000Z"

Response

200
application/json

Reservations retrieved successfully

The response is of type object[].