Contents
On this page
List Fleet Accounts - Plugixa Car Wash
GET /plugixa-carwash/v1/fleet-accounts
List company accounts, one page at a time, with search, sorting and filters.
Needs Plugixa Car Wash Pro with the Fleet accounts app on, and the plugixa_carwash_view capability.
Request
GET https://your-site.example/wp-json/plugixa-carwash/v1/fleet-accounts
Query parameters
| Name | Type | Default | Description |
|---|---|---|---|
status__in |
string |
Comma-separated: published, unpublished. |
Plus the list parameters every paged list accepts. search matches the company name, the contact name and the e-mail. orderby accepts id, name, discount, credit_limit, status, created_at. Each filter is a field name and a comparison joined by two underscores: see Filters.
Responses
200 OK. data is one page of company accounts.
{
"success": true,
"data": [
{
"id": 6,
"name": "Acme Deliveries",
"contact_name": "Sarah Jones",
"email": "accounts@acme.example",
"phone": "+1 217 555 0170",
"address": "1 Depot Lane\nSpringfield",
"tax_id": "US123456789",
"discount": 15.0,
"credit_limit": 2000.0,
"terms_days": 30,
"notes": "",
"color": "#14B8A6",
"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,
"members": 4,
"unbilled": 240.5,
"outstanding": 610.0,
"balance": 850.5
}
],
"meta": {
"total": 7,
"pages": 1
}
}
| Field | Type | Meaning |
|---|---|---|
data[].id |
integer |
The company account’s id |
data[].discount |
number |
Percent off its drivers’ bookings |
data[].credit_limit |
number |
Most it may owe. 0 means no limit |
data[].terms_days |
integer |
Days it has to pay a statement |
data[].members |
integer |
Customers linked to it |
data[].unbilled |
number |
Charges not on a statement yet |
data[].outstanding |
number |
Charges on statements issued and not paid |
data[].balance |
number |
unbilled plus outstanding |
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 |
Fleet Accounts 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/fleet-accounts" \
-u "admin:$WP_APP_PASSWORD"
<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-carwash/v1/fleet-accounts');
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/fleet-accounts', {
headers: {
'Authorization': `Basic ${auth}`,
},
});
const { data, meta } = await response.json();
Quick Links
Share