Skip to main content
GET
/
api
/
v1
/
reservation
/
{id}
Get a reservation by ID
curl --request GET \
  --url https://api.example.com/api/v1/reservation/{id} \
  --header 'x-calry-api-key: <api-key>'
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "listingID": "123e4567-e89b-12d3-a456-426614174000",
  "integrationAccountID": "123e4567-e89b-12d3-a456-426614174000",
  "providerReservationID": "HMKYWB7BF8",
  "providerID": "3827197",
  "checkInDate": "2025-06-15",
  "checkOutDate": "2025-06-22",
  "guests": 2,
  "guest": {
    "id": "G12345",
    "name": "John Doe",
    "firstName": "John",
    "lastName": "Doe",
    "email": "[email protected]",
    "phone": "+1234567890"
  },
  "status": "CONFIRMED",
  "source": "website",
  "notes": "Guest requested early check-in if possible",
  "originalCurrency": "USD",
  "currency": "EUR",
  "totalPrice": 880,
  "components": {},
  "parentPropertyID": "PROP12345",
  "adults": 2,
  "children": 1,
  "infants": 0,
  "pets": 0,
  "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.

Path Parameters

​
id
string
required

ID of the reservation to retrieve

Example:

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

Query Parameters

​
displayCurrency
string

Currency to display prices in (ISO 4217)

Example:

"USD"

Response

Reservation retrieved successfully

​
id
string
required

Unique identifier for the reservation

Example:

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

​
listingID
string
required

ID of the listing being reserved

Example:

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

​
integrationAccountID
string
required

ID of the integration account

Example:

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

​
providerReservationID
string
required

Reservation ID in the provider system

Example:

"HMKYWB7BF8"

​
providerID
string
required

Provider identifier for listing

Example:

"3827197"

​
checkInDate
string
required

Check-in date (ISO format)

Example:

"2025-06-15"

​
checkOutDate
string
required

Check-out date (ISO format)

Example:

"2025-06-22"

​
guests
number
required

Total number of guests

Example:

2

​
guest
object
required

Guest information

​
status
enum<string>
required

Status of the reservation

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

"CONFIRMED"

​
source
string
required

Source of the reservation

Example:

"website"

​
notes
string
required

Additional notes for the reservation

Example:

"Guest requested early check-in if possible"

​
originalCurrency
string
required

Original currency of the reservation (ISO 4217)

Example:

"USD"

​
currency
string
required

Display currency of the reservation (ISO 4217)

Example:

"EUR"

​
totalPrice
number
required

Total price of the stay

Example:

880

​
components
object
required

Price components breakdown

​
parentPropertyID
object

Parent property ID, if applicable

Example:

"PROP12345"

​
adults
number

Number of adult guests

Example:

2

​
children
number

Number of children

Example:

1

​
infants
number

Number of infants

Example:

0

​
pets
number

Number of pets

Example:

0

​
createdAt
string

Creation date of the reservation (ISO format)

Example:

"2025-05-20T14:30:00.000Z"

​
updatedAt
string

Last update date of the reservation (ISO format)

Example:

"2025-05-21T10:15:00.000Z"

​
cancelledAt
string

Cancellation date of the reservation (ISO format, if cancelled)

Example:

"2025-05-25T09:45:00.000Z"

​
confirmedAt
string

Confirmation date of the reservation (ISO format)

Example:

"2025-05-20T15:00:00.000Z"