List Departures - Plugixa Boat Rental for WordPress

List Departures - Plugixa Boat Rental

GET /pbr/v1/slots

A boat’s fixed departures on one day, each saying whether it can still be booked. For boats booked by fixed departure times.

Public: no key or login is needed. An API key PRO of either access level may call it too.

Note. available says whether the departure is still ahead (within the site’s booking window) and a unit is free for it. It does not check the marina’s opening hours or the number of guests: the booking is refused for those when it is made. It is rate limited per visitor address, sharing the 120 requests every 10 minutes of Search Availability.

Request

GET https://your-site.example/wp-json/pbr/v1/slots?boat_id=5&location_id=2&date=2026-11-20

Query parameters

Name	Type	Default	Description
`boat_id`	`integer`		Required. The boat.
`location_id`	`integer`		Required. The marina.
`date`	`string`		Required. The day, `YYYY-MM-DD`, on the marina’s clock.
`guests`	`integer`	`1`	Passed on to Pro apps that judge a departure by the people on board.

Responses

`200` OK. `data` is the day’s departures.

{
  "success": true,
  "message": "",
  "data": {
    "boat_id": 5,
    "date": "2026-11-20",
    "slots": [
      { "start_time": "10:00:00", "end_time": "12:00:00", "available": false },
      { "start_time": "14:00:00", "end_time": "16:00:00", "available": true }
    ]
  }
}

Field	Type	Meaning
`data.slots`	`array`	The boat’s departures that day from its weekly timetable, earliest first. Empty for a boat with none
`data.slots[].start_time`, `data.slots[].end_time`	`string`	The departure and return times on the marina’s clock
`data.slots[].available`	`boolean`	Whether it can still be booked

A Pro app may add a note to a departure, shown beside its time. To book one, send its times on that date as start and end to Create Booking.

Errors

Status	Code	When
`422`	`rest_error`	`boat_id`, `location_id` or `date` is missing, or `date` is not a real `YYYY-MM-DD` day.
`429`	`plugixa_boatrental_rate_limited`	Too many requests from this address. `Retry-After` says when to try again.

Plus the errors every endpoint can return.

Examples

curl -s "https://your-site.example/wp-json/pbr/v1/slots?boat_id=5&location_id=2&date=2026-11-20"

<?php
$query = http_build_query(['boat_id' => 5, 'location_id' => 2, 'date' => '2026-11-20']);
$ch = curl_init('https://your-site.example/wp-json/pbr/v1/slots?' . $query);
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);

const params = new URLSearchParams({ boat_id: '5', location_id: '2', date: '2026-11-20' });
const response = await fetch(`https://your-site.example/wp-json/pbr/v1/slots?${params}`);
const { data } = await response.json();