CASY API

Hotel Reservation & Management API

Overview Endpoints Data Format Error Codes Changelog
Notice: This API is for authorized users only. All usage is monitored and logged. Unauthorized access attempts will be investigated.

Your Credentials

Saved locally in your browser for endpoint testing.

API Endpoints

All API endpoints require authentication via bearer token unless otherwise noted.

Use the Test This Endpoint button in each endpoint card.

Health & Status

GET /health/hotels/{casyId} Auth
Hotel-specific health check (includes tenant DB status)

Token Introspection

GET /introspect Auth
View your token permissions, allowed hotels, and available endpoints
Response Includes
token - Token metadata (ID, expiration, days remaining)
allowed_hotels - List of hotel/CASY IDs you can access
rate_limit - Your rate limiting configuration (requests per window)
actions - All actions/permissions granted to this token with descriptions
available_endpoints - Complete list of endpoints you can call with this token

Reservations

GET /reservations/{casyId} Auth
Get reservations (basic filters, pagination)
Query Parameters
start_date (string) - Filter by arrival start date (YYYY-MM-DD)
end_date (string) - Filter by arrival end date (YYYY-MM-DD)
status (integer) - Reservation status code
person (string) - Search by guest name
hotel_ids (string) - Filter by specific hotel IDs (comma-separated)
limit (integer) - Results per page (default: 50)
page (integer) - Page number (default: 1)
sort_by (string) - Sort field (default: Arrival)
sort_order (string) - Sort direction: asc or desc (default: desc)
GET /reservations/{casyId}/all Auth
Get all reservations with comprehensive filtering (42 parameters)
Query Parameters
Date Filters
arrival_from (string) - Arrival date start (YYYY-MM-DD)
arrival_to (string) - Arrival date end (YYYY-MM-DD)
departure_from (string) - Departure date start (YYYY-MM-DD)
departure_to (string) - Departure date end (YYYY-MM-DD)
Status & Booking Filters
status (integer) - Reservation status code
notify_only (boolean) - Only notification/inquiry reservations
payed (boolean) - Payment status (0 or 1)
Guest Filters
person (string) - Guest name search
email (string) - Guest email search
country (string) - Guest country code (ISO)
remarks (string) - Search reservations having matching text in Remarks.Remarks (example: test)
GET /reservations/{casyId}/{reservationId} Auth
Get single reservation with optional nested data (accounts, companions, payments)

Addresses

GET /addresses/{casyId} Auth
Get addresses with filtering and pagination (sensitive fields automatically removed)
Query Parameters
first_name (string) - Filter by first name
last_name (string) - Filter by last name
email (string) - Filter by email address
address (string) - Filter by address text (partial match on Street1 or Street2, e.g. "Seven Town House")
remarks (string) - Filter addresses that have matching text in Remarks.Remarks (example: test)
city (string) - Filter by city name or numeric city ID
country (string) - Filter by country ID or ISO code
include_remarks (boolean) - Include remarks linked by Remarks.id_Address (use 1/true)
limit (integer) - Results per page (default: 50)
page (integer) - Page number (default: 1)
sort_by (string) - Sort field such as FirstName, LastName, Email, City, Country, PostalCode, or AddressId
sort_order (string) - Sort direction: asc or desc (default: asc)
example (request) - /v1/addresses/{casyId}?remarks=test&include_remarks=1&sort_by=AddressId&sort_order=asc
GET /addresses/{casyId}/{addressId} Auth
Get single address details (sensitive fields automatically removed)

Settings & Reference Data

GET /settings/hotels/{casyId}/reservation-statuses Auth
Get all reservation statuses with multilanguage translations
GET /settings/hotels/{casyId}/reservation-types Auth
Get all reservation types with multilanguage translations
GET /settings/hotels/{casyId}/meals Auth
Get meal reference data with multilingual labels
GET /settings/hotels/{casyId}/channels Auth
Get channel reference data ordered by ChannelOrder
GET /settings/hotels/{casyId}/countries Auth
Get countries reference data
GET /settings/hotels/{casyId}/room-types Auth
Get room types reference data

Hotels

GET /hotels Auth
List all accessible hotels
GET /hotels/{casyId} Admin
Get single hotel mapping and database connection info