Get a reservation
Read the current state of a reservation you created.
GET/api/v1/reservation/{id}
Returns one reservation that you created with your API key. Use it to follow a booking's status and to read its cancellation terms or charge.
Path parameters
| Parameter | Type | Description |
|---|---|---|
id | UUID | OnSeason reservation ID, not providerReservationID. |
Query parameters
| Parameter | Type | Description |
|---|---|---|
displayCurrency | string | ISO 4217 currency for the amounts in the response. |
Example
curl --get \
"https://zepl-staging.calry.app/api/v1/reservation/9fa05abc-daf0-4ee4-a9e6-f959c2e8a421" \
--header "x-calry-api-key: <API_KEY>" \
--data-urlencode "displayCurrency=EUR"Response
Status codes
| Status | Meaning |
|---|---|
200 | Reservation returned. |
400 | The ID is not a valid UUID. |
401 | The API key is missing or invalid. |
403 | The API key is not allowed to read reservations. |
404 | No reservation with this ID was created with your API key. |