Boats
List Your Fleet
List your companies' boats, unpublished ones included
Same in API v1.0 and v1.1
GET
/dashboard/boatsList the boats of the companies you belong to — unpublished boats included, which List Boats does not return. This is the call to find an imported boat that is not live yet, and to see what Update Boat changed. Newest boats come first.
Authentication
Requires one of:
- API key:
X-API-Keyheader with your API key. This is the way to call it from your own systems. - Session: a signed-in charter.boats session — what the dashboard uses from the browser. Outside charter.boats a request without a key is stopped by bot protection (HTML
403), so integrations should use the key.
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
company_id | string | No | The company whose boats to list. If you are not a member of it, the response is an empty array. Without it, the boats of every company your account belongs to are listed; each record's company_id says whose it is |
Request
Response
An array of boat records:
Each record carries these fields:
| Group | Fields |
|---|---|
| Identity | id, title, description, boat_type, model, year, company_id, location_id, manufacturer_id |
| Size | length_ft, capacity, cabins, crew_cabins, berths, toilets |
| Price | price_per_day, price_from, price_to, original_price_per_day, discount_percentage, discount_label, pricing_source, security_deposit |
| Charter terms | rental_type, charter_day, check_in_periods, checkin_time, checkout_time, min_charter_days, instant_book |
| State | is_published, created_at, updated_at, average_rating, review_count |
| Connected platforms | mmk_yacht_id, nausys_yacht_id, mmk_sync_status, nausys_sync_status |
| Images | images[] — id, url, category, is_primary, is_active, sort_order |
The fields mean what they mean on Get Boat.
Errors
| Status | Message |
|---|---|
401 | Invalid API key — a key that belongs to no account |
401 | Invalid API key format — a malformed key |
401 | Authentication required — no key and no signed-in session |