Contents
On this page

List Customers - Plugixa Car Wash

GET /plugixa-carwash/v1/customers

List customers, 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/customers?search=bernard

Query parameters

Plus the list parameters every paged list accepts. search matches first name, last name, e-mail, phone and company. orderby accepts id, first_name, last_name, email, created_at, modified_at. Customers take no filters.

Responses

200 OK. data is one page of customers.

{
  "success": true,
  "data": [
    {
      "id": 25,
      "first_name": "Lucas",
      "last_name": "Bernard",
      "email": "lucas@example.com",
      "phone": "+1 217 555 0199",
      "company": "",
      "address": "",
      "notes": "",
      "wp_user_id": null,
      "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,
      "visits": 4,
      "last_visit": "2026-11-08 14:00:00",
      "spent": 156.24,
      "name": "Lucas Bernard"
    }
  ],
  "meta": {
    "total": 212,
    "pages": 1
  }
}
Field Type Meaning
data[].id integer The customer’s id
data[].email string Unique among customers not in the trash
data[].wp_user_id string|null Not set by the plugin today. When set it is a number in a string
data[].status string published or unpublished
data[].visits integer Bookings completed or in_progress
data[].last_visit string|null UTC start of the latest of those
data[].spent number Total of those bookings
data[].name string First and last name together
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 Customers matching the search and filters, before paging
meta.pages integer Number of pages at this per_page

Errors

Plus the errors every endpoint can return.

Examples

curl -s "https://your-site.example/wp-json/plugixa-carwash/v1/customers?search=bernard" \
  -u "admin:$WP_APP_PASSWORD"

<?php
$query = http_build_query([
    'search' => 'bernard',
]);
$ch = curl_init('https://your-site.example/wp-json/plugixa-carwash/v1/customers?' . $query);
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 query = new URLSearchParams({ search: 'bernard' });
const response = await fetch(`https://your-site.example/wp-json/plugixa-carwash/v1/customers?${query}`, {
  headers: {
    'Authorization': `Basic ${auth}`,
  },
});
const { data, meta } = await response.json();

Quick Links

Share