API Reference
Complete reference for the Charter Boats API
Base URL
All API endpoints are relative to:
Authentication
Most endpoints require an API key passed in the X-API-Key header. See Authentication for details.
Response Format
All responses are JSON. Successful responses typically include:
Error responses include:
Available Endpoints
Boats
| Method | Endpoint | Description |
|---|---|---|
GET | /boats | List all boats |
GET | /boats/:id | Get boat details |
POST | /import/boat | Import a new boat |
Bookings
| Method | Endpoint | Description |
|---|---|---|
GET | /bookings | List user's bookings |
POST | /bookings | Create a booking |
GET | /bookings/:id | Get booking details |
Calendar
| Method | Endpoint | Description |
|---|---|---|
GET | /calendar/:boatId/export.ics | Export boat calendar |
HTTP Status Codes
| Code | Description |
|---|---|
200 | Success |
201 | Created |
400 | Bad Request - Invalid parameters |
401 | Unauthorized - Missing or invalid API key |
404 | Not Found |
429 | Rate Limited |
500 | Server Error |