List Drivers - Plugixa Chauffeur for WordPress

List Drivers - Plugixa Chauffeur

GET /plugixa-chauffeur/v1/drivers

List drivers with the number of bookings assigned to each.

Needs Plugixa Chauffeur Pro with an active licence. Needs a signed-in user with the plugixa_chauffeur_manage capability (administrators have it after activation).

Request

GET https://your-site.example/wp-json/plugixa-chauffeur/v1/drivers?status=active

Query parameters

Name	Type	Default	Description
`search`	`string`		Matches part of the name, e-mail or phone.
`status`	`string`		`active` or `inactive`.

Plus the list parameters every list accepts. orderby accepts created_at (the default), name, display_order and status.

Responses

`200` OK. `data.items` is one page of drivers.

{
  "success": true,
  "message": "",
  "data": {
    "items": [
      {
        "id": "2",
        "language_code": null,
        "translation_group": null,
        "name": "Thomas Leroy",
        "slug": "thomas-leroy",
        "email": "thomas.leroy@example.com",
        "phone": "+33 6 98 76 54 32",
        "photo_id": null,
        "bio": "Ten years of airport and event transfers.",
        "status": "active",
        "display_order": "0",
        "created_at": "2026-11-12 09:30:00",
        "booking_count": 14
      }
    ],
    "total": 5,
    "limit": 20,
    "offset": 0
  }
}

Field	Type	Meaning
`data.items`	`array`	One page of rows
`data.total`	`integer`	Rows matching the filters, before paging
`data.limit`	`integer`	Rows per page used. `999999` when you asked for every row
`data.offset`	`integer`	Rows skipped
`data.items[]`	`object`	A driver, as in Get Driver
`data.items[].booking_count`	`integer`	Bookings assigned to the driver, every status included. Only in the list

In the list, photo_url is the thumbnail size; a single read returns the medium size.

Errors

Plus the errors every endpoint can return.

Examples

curl -s "https://your-site.example/wp-json/plugixa-chauffeur/v1/drivers?status=active" \
  -u "admin:$WP_APP_PASSWORD"

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