Haip · Public docs

Haip API docs

Public API reference from the Haip README. Interactive Swagger UI ships with a running Haip API at /docs — we don't host a live Swagger instance on telivity.app.

Haip READMEGitHub
Haip PMS Revenue Intelligence — pending decisions with confidence bars and Approve/Reject
Revenue Intelligence — native AI approve queue with confidence scoring, built into the PMS.
GET/api/v1/reservations
POST/api/v1/reservations
GET/api/v1/folios
POST/api/v1/rates
POST/api/v1/night-audit
GET/api/v1/rooms
Core PMS API surface — REST, multi-tenant, Apache 2.0.

API Reference

All endpoints are prefixed with /api/v1/ and documented via OpenAPI 3.0. Run the API and visit http://localhost:3000/docs for the interactive Swagger UI.

Integrator shape notes (propertyId locations, cancel field aliases, response envelopes, pagination, externalConfirmation): docs/api-conventions.md.

Core Endpoints (~167 total)

AI Agents — 16 endpoints 
GET    /api/v1/agents/:propertyId                              # List all agents with status
GET    /api/v1/agents/:propertyId/graph                        # Dependency graph (nodes + edges + status)
GET    /api/v1/agents/:propertyId/orchestration-performance    # All-agent metrics + RManager summary
GET    /api/v1/agents/:propertyId/:agentType/config            # Get agent configuration
PUT    /api/v1/agents/:propertyId/:agentType/config            # Update config (mode, enabled, threshold)
POST   /api/v1/agents/:propertyId/:agentType/run               # Run agent (?triggeredBy=manual|schedule)
POST   /api/v1/agents/:propertyId/:agentType/train             # Train one agent (writes modelState)
POST   /api/v1/agents/:propertyId/train-all                    # Train every enabled agent
GET    /api/v1/agents/:propertyId/:agentType/decisions         # Decision history
POST   /api/v1/agents/:propertyId/decisions/:id/approve        # Approve recommendation
POST   /api/v1/agents/:propertyId/decisions/:id/reject         # Reject recommendation
POST   /api/v1/agents/:propertyId/decisions/:id/explain        # HAIP AI grounded explanation
GET    /api/v1/agents/:propertyId/:agentType/performance       # Performance metrics
POST   /api/v1/agents/:propertyId/reviews                      # Submit guest review
GET    /api/v1/agents/:propertyId/reviews                      # List reviews (filter by status/source)
PATCH  /api/v1/agents/:propertyId/reviews/:id                  # Update review response
Reservations — 21 endpoints 
POST   /api/v1/reservations/search-availability   # Real-time availability check
POST   /api/v1/reservations/group-check-in         # Batch check-in
POST   /api/v1/reservations/bulk-action            # Bulk check-in/out/cancel
GET    /api/v1/reservations/unassigned             # Find unassigned reservations
POST   /api/v1/reservations/import                 # Batch import reservations
POST   /api/v1/reservations                        # Create reservation
GET    /api/v1/reservations                        # List (filtered, paginated)
GET    /api/v1/reservations/:id                    # Get with guest/room/rate
PATCH  /api/v1/reservations/:id                    # Modify dates/room/rate
PATCH  /api/v1/reservations/:id/confirm            # Confirm
PATCH  /api/v1/reservations/:id/assign-room        # Assign room
PATCH  /api/v1/reservations/:id/check-in           # Check in
PATCH  /api/v1/reservations/:id/check-out          # Check out
POST   /api/v1/reservations/:id/express-checkout   # Express checkout
PATCH  /api/v1/reservations/:id/cancel             # Cancel
PATCH  /api/v1/reservations/:id/no-show            # Mark no-show
POST   /api/v1/reservations/:id/notes              # Add a note
GET    /api/v1/reservations/:id/notes              # List notes (with active count)
PATCH  /api/v1/reservations/notes/:noteId          # Update a note
DELETE /api/v1/reservations/notes/:noteId          # Delete a note
POST   /api/v1/reservations/:id/messages           # Send a message to the guest
Folios & Billing — 12 endpoints 
POST   /api/v1/folios                              # Create folio
GET    /api/v1/folios                              # List with filters
GET    /api/v1/folios/:id                          # Get folio
PATCH  /api/v1/folios/:id                          # Update folio
PATCH  /api/v1/folios/:id/settle                   # Settle folio
PATCH  /api/v1/folios/:id/close                    # Close folio
POST   /api/v1/folios/:id/charges                  # Post charge
GET    /api/v1/folios/:id/charges                  # List charges
POST   /api/v1/folios/:id/charges/:chargeId/reverse # Reverse charge
POST   /api/v1/folios/:id/charges/lock             # Lock charges
POST   /api/v1/folios/:id/transfer-charge          # Transfer charge
POST   /api/v1/folios/:id/transfer-to-city-ledger  # Transfer to city ledger
POST   /api/v1/folios/routing-rules                # Create a split-folio routing rule
GET    /api/v1/folios/routing-rules                # List routing rules (by reservation)
POST   /api/v1/folios/:id/move-transactions        # Move charges between folios
House Accounts & Products — 11 endpoints 
POST   /api/v1/products                            # Create retail product
GET    /api/v1/products                            # List products
GET    /api/v1/products/:id                         # Get product
PATCH  /api/v1/products/:id                         # Update product
POST   /api/v1/house-accounts                      # Open a house account
GET    /api/v1/house-accounts                      # List house accounts
GET    /api/v1/house-accounts/:id                   # Get house account
POST   /api/v1/house-accounts/:id/close            # Close house account
POST   /api/v1/house-accounts/:id/charges          # Post a charge
POST   /api/v1/house-accounts/:id/payments         # Record a payment
POST   /api/v1/house-accounts/:id/sell             # Sell a product (retail)
Groups & Allotment — 16 endpoints