Contents
On this page

List Booking Forms - Plugixa Car Wash

GET /plugixa-carwash/v1/booking-forms

List booking forms, one page at a time, with search, sorting and filters.

Needs the plugixa_carwash_view capability.

Request

GET https://your-site.example/wp-json/plugixa-carwash/v1/booking-forms

Query parameters

Name Type Default Description
layout__in string Comma-separated: multi, single.
status__in string Comma-separated: published, unpublished.

Plus the list parameters every paged list accepts. search matches the name. orderby accepts id, name, layout, display, status, created_at, modified_at. Each filter is a field name and a comparison joined by two underscores: see Filters.

Responses

200 OK. data is one page of booking forms.

{
  "success": true,
  "data": [
    {
      "id": 1,
      "name": "Main booking form",
      "layout": "multi",
      "display": "packages_addons",
      "location_ids": [],
      "vehicle_type_ids": [],
      "package_ids": [],
      "primary_color": "#0EA5E9",
      "show_summary": true,
      "auto_scroll": true,
      "fields": [
        {
          "key": "first_name",
          "enabled": true,
          "required": true
        },
        {
          "key": "last_name",
          "enabled": true,
          "required": true
        },
        {
          "key": "email",
          "enabled": true,
          "required": true
        },
        {
          "key": "phone",
          "enabled": true,
          "required": true
        },
        {
          "key": "company",
          "enabled": false,
          "required": false
        },
        {
          "key": "vehicle_make",
          "enabled": true,
          "required": false
        },
        {
          "key": "vehicle_plate",
          "enabled": false,
          "required": false
        },
        {
          "key": "address",
          "enabled": false,
          "required": false
        },
        {
          "key": "message",
          "enabled": true,
          "required": false
        }
      ],
      "agreements": [
        {
          "text": "I accept the terms of service.",
          "required": true
        }
      ],
      "success_message": "",
      "status": "published",
      "created_by": 1,
      "modified_by": 1,
      "created_at": "2026-11-10 08:15:00",
      "modified_at": "2026-11-12 09:30:00",
      "deleted_at": null
    }
  ],
  "meta": {
    "total": 1,
    "pages": 1
  }
}
Field Type Meaning
data[].id integer The form’s id
data[].layout string multi (steps) or single (one page)
data[].display string packages, packages_addons or services
data[].location_ids array Locations it offers. Empty means every published one
data[].vehicle_type_ids array Vehicle types it offers. Empty means every one
data[].package_ids array Packages it offers. Empty means every one
data[].fields array The customer fields: key, enabled, required
data[].agreements array Boxes to tick: text (HTML) and required
data[].status string Only a published form takes bookings
data[].created_at string UTC datetime
data[].modified_at string UTC datetime of the last change. Send it back on an update to be warned about a conflicting edit
data[].deleted_at string|null null unless the record is in the trash
meta.total integer Booking Forms matching the search and filters, before paging
meta.pages integer Number of pages at this per_page

Errors

Status Code When
400 plugixa_carwash_unknown_filter A filter names a field this list cannot filter on.
400 plugixa_carwash_unknown_operator A comparison that does not work on that field.
400 plugixa_carwash_missing_value A filter that needs a value has none.
400 plugixa_carwash_invalid_date A date filter value is not a date.

Plus the errors every endpoint can return.

Examples

curl -s "https://your-site.example/wp-json/plugixa-carwash/v1/booking-forms" \
  -u "admin:$WP_APP_PASSWORD"

<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-carwash/v1/booking-forms');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_USERPWD        => 'admin:' . getenv('WP_APP_PASSWORD'),
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);

const auth = Buffer.from(`admin:${process.env.WP_APP_PASSWORD}`).toString('base64');
const response = await fetch('https://your-site.example/wp-json/plugixa-carwash/v1/booking-forms', {
  headers: {
    'Authorization': `Basic ${auth}`,
  },
});
const { data, meta } = await response.json();

Quick Links

Share