Contents
On this page

Get Booking Form Config - Plugixa Chauffeur

GET /plugixa-chauffeur/v1/public/form/{id}

Read what a visitor needs to fill in a published booking form: its services, currency, notice period, payment methods and availability rules.

Public: no login and no capability. Only published forms answer; a draft answers 404.

Request

GET https://your-site.example/wp-json/plugixa-chauffeur/v1/public/form/1

Path parameters

Name Type Description
id integer The booking form’s id

Responses

200 OK. data is the form’s public configuration.

{
  "success": true,
  "message": "",
  "data": {
    "id": 1,
    "name": "Airport transfers",
    "currency": "EUR",
    "service_types": [
      {
        "value": "distance",
        "label": "Distance"
      },
      {
        "value": "hourly",
        "label": "Hourly"
      }
    ],
    "default_service_type": "distance",
    "enable_return": true,
    "min_passengers": 1,
    "min_lead_time": 120,
    "require_phone": true,
    "distance_unit": "km",
    "payment_methods": [
      {
        "value": "stripe",
        "label": "Pay online (card)",
        "instructions": "",
        "type": "online"
      },
      {
        "value": "cash",
        "label": "Cash to the driver",
        "instructions": "Please pay the driver in cash at pickup.",
        "type": "offline"
      }
    ],
    "availability": {
      "enabled": true,
      "lead_time_minutes": 120,
      "horizon_days": 180,
      "business_hours": {
        "1": {
          "open": true,
          "start": "06:00",
          "end": "23:00"
        },
        "2": {
          "open": true,
          "start": "06:00",
          "end": "23:00"
        },
        "3": {
          "open": true,
          "start": "06:00",
          "end": "23:00"
        },
        "4": {
          "open": true,
          "start": "06:00",
          "end": "23:00"
        },
        "5": {
          "open": true,
          "start": "06:00",
          "end": "23:00"
        },
        "6": {
          "open": true,
          "start": "08:00",
          "end": "20:00"
        },
        "7": {
          "open": false,
          "start": "09:00",
          "end": "18:00"
        }
      },
      "blackout_dates": [
        {
          "start": "2026-12-24",
          "end": "2026-12-26",
          "label": "Christmas"
        }
      ]
    }
  }
}
Field Type Meaning
data.service_types array { value, label } for each service the form offers. With Pro and enable_flat on, flat is added
data.default_service_type string Always one of service_types
data.currency string The form’s currency, else the site currency, else USD
data.min_lead_time integer The form’s own minimum notice, in minutes
data.require_phone boolean Whether a phone number is required to book
data.distance_unit string km or mi
data.payment_methods array Enabled methods, { value, label, instructions, type }. type is online for Stripe, offline otherwise
data.availability object The site-wide rules, as in Get Availability
data.routes array With Pro and enable_flat on only: active flat-rate routes { id, name, pickup_label, dropoff_label, price }

Nothing else about the form, the operator or other customers is returned. The plugixa_chauffeur_form_config filter can add keys.

Errors

Status Code When
404 rest_error No published form with that id (“Booking form not found.”).

Plus the errors every endpoint can return.

Examples

curl -s "https://your-site.example/wp-json/plugixa-chauffeur/v1/public/form/1"
<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-chauffeur/v1/public/form/1');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);
const response = await fetch('https://your-site.example/wp-json/plugixa-chauffeur/v1/public/form/1');
const { data } = await response.json();

Quick Links

Share