Contents
On this page

List Resources - Plugixa Car Wash

GET /plugixa-carwash/v1/resources

List bays and mobile teams, 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/resources?location_id__in=3

Query parameters

Name Type Default Description
location_id__in string Comma-separated location ids.
type__in string Comma-separated: bay, mobile_team.
status__in string Comma-separated: published, unpublished.

Plus the list parameters every paged list accepts. search matches the name. orderby accepts id, name, type, location_id, status, sort_order, 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 bays and teams.

{
  "success": true,
  "data": [
    {
      "id": 5,
      "location_id": 3,
      "type": "bay",
      "name": "Bay 1",
      "color": "#0EA5E9",
      "vehicle_type_ids": [],
      "notes": "",
      "sort_order": 0,
      "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": 3,
    "pages": 1
  }
}
Field Type Meaning
data[].id integer The bay or team’s id
data[].location_id integer Where it works
data[].type string bay or mobile_team
data[].color string Hex colour on the schedule, or empty
data[].vehicle_type_ids array Vehicle types it takes. Empty means every type
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 Resources 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/resources?location_id__in=3" \
  -u "admin:$WP_APP_PASSWORD"
<?php
$query = http_build_query([
    'location_id__in' => '3',
]);
$ch = curl_init('https://your-site.example/wp-json/plugixa-carwash/v1/resources?' . $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({ location_id__in: '3' });
const response = await fetch(`https://your-site.example/wp-json/plugixa-carwash/v1/resources?${query}`, {
  headers: {
    'Authorization': `Basic ${auth}`,
  },
});
const { data, meta } = await response.json();

Quick Links

Share