Contents
On this page

List Customer Groups - Plugixa Car Parking

GET /plugixa-car-parking/v1/customer-groups

List customer groups, one page at a time. A customer group is a named set of WordPress users that pricing rules can target.

Needs Plugixa Car Parking Pro. The WordPress user needs the plugixa_carparking_view capability (view records).

Request

GET https://your-site.example/wp-json/plugixa-car-parking/v1/customer-groups?search=season

Query parameters

The list parameters every paged list accepts. search matches the name, the slug and the description. orderby accepts id, name, created_at and modified_at; anything else sorts by id. view=trash lists trashed customer groups only.

Filterable fields: name and slug (contains, eq, ne, empty, not_empty), and created_at and modified_at (date comparisons). For example name__contains=season. See Filtering lists for the syntax.

Responses

200 OK. data is one page of customer groups.

{
  "success": true,
  "data": [
    {
      "id": 3,
      "name": "Season ticket holders",
      "slug": "season-ticket-holders",
      "description": "Commuters on a yearly contract.",
      "created_by": 1,
      "modified_by": 1,
      "created_at": "2026-11-12 09:30:00",
      "modified_at": "2026-11-12 09:30:00",
      "deleted_at": null,
      "member_count": 12
    }
  ],
  "meta": {
    "total": 3,
    "pages": 1
  }
}
Field Type Meaning
data[].id integer The group’s id
data[].name string The group’s name
data[].slug string Unique among all groups, trashed ones included
data[].description string|null Plain text, or null when none was given
data[].member_count integer How many users are in the group
meta.total integer Customer Groups matching the search and filters, before paging
meta.pages integer Number of pages at this per_page

Errors

Status Code When
400 plugixa_carparking_unknown_filter A filter names a field this list cannot filter on.
400 plugixa_carparking_unknown_operator A filter uses an operator that does not work on that field.
400 plugixa_carparking_missing_value A filter has no value.
400 plugixa_carparking_invalid_date A date filter has a value that is not a date.

Plus the errors every endpoint can return.

Examples

curl -s "https://your-site.example/wp-json/plugixa-car-parking/v1/customer-groups?search=season" \
  -u "admin:$WP_APP_PASSWORD"

<?php
$query = http_build_query(['search' => 'season']);
$ch = curl_init('https://your-site.example/wp-json/plugixa-car-parking/v1/customer-groups?' . $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 query = new URLSearchParams({ search: 'season' });
const response = await fetch(`https://your-site.example/wp-json/plugixa-car-parking/v1/customer-groups?${query}`, {
  headers: {
    'Authorization': 'Basic ' + btoa(`admin:${process.env.WP_APP_PASSWORD}`),
  },
});
const { data, meta } = await response.json();

Quick Links

Share