> ## Documentation Index
> Fetch the complete documentation index at: https://docs.connectedfleet.michelin.com/llms.txt
> Use this file to discover all available pages before exploring further.
# List Driver
> Returns details for all drivers and the group they have been assigned to.
## OpenAPI
````yaml https://api.connectedfleet.michelin.com/performance/api-docs get /public/v1/customer/{customerId}/driver
openapi: 3.0.1
info:
title: Performance
description: >-
Delivers deeper insights into driver behaviour, fuel efficiency, CO₂ impact
and safe driving practices.
contact:
name: Masternaut
url: https://www.masternaut.com
email: support@masternautconnect.com
version: 124.0.2607160821
servers:
- url: https://api.connectedfleet.michelin.com/performance
description: Product Server
security:
- bearerAuth: []
tags:
- name: /alert
description: Alert history and notification management operations
- name: /driver
description: Driver Operations
- name: /driverbehaviourmetrics
description: Driver Behaviour Metrics
- name: customers
description: Customer Behaviour Metrics
- name: /ecoscore
description: EcoScore
- name: /fuel
description: Fuel
- name: /idling
description: Idling
- name: /speeding
description: Speeding
- name: /tokenInformation
description: Token operations
- name: /utilisation
description: Utilisation
- name: /vehicle
description: Vehicle management operations
paths:
/public/v1/customer/{customerId}/driver:
get:
tags:
- /driver
summary: List Driver
description: >-
Returns details for all drivers and the group they have been assigned
to.
operationId: findDrivers
parameters:
- name: customerId
in: path
required: true
schema:
type: string
- name: pageIndex
in: query
description: >-
Specifies the pagination page index.
Pages are zero indexed,
i.e. the first page has an index value of zero.
required: false
schema:
type: integer
description: >-
Specifies the pagination page index.
Pages are zero indexed,
i.e. the first page has an index value of zero.
format: int32
- name: pageSize
in: query
description: >-
Specifies the number of items to include on a page.
Must be
specified if pageIndex has been specified.
required: false
schema:
type: integer
description: >-
Specifies the number of items to include on a page.
Must be
specified if pageIndex has been specified.
format: int32
- name: name
in: query
description: Name of the driver
required: false
schema:
type: string
description: Name of the driver
- name: groupId
in: query
description: Id of the group in hierarchy
required: false
schema:
type: string
description: Id of the group in hierarchy
- name: groupName
in: query
description: Name of the group in hierarchy
required: false
schema:
type: string
description: Name of the group in hierarchy
- name: active
in: query
description: If driver is active (true = active, false = inactive)
required: false
schema:
type: boolean
description: If driver is active (true = active, false = inactive)
- name: defaultVehicleId
in: query
description: Id of default vehicle
required: false
schema:
type: string
description: Id of default vehicle
- name: keys
in: query
description: List of driver keys for filtering
required: false
schema:
type: array
description: List of driver keys for filtering
items:
type: string
responses:
'200':
description: >-
Drivers were successfully returned or empty if none of drivers
fulfill criteria
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/WithPaginationResultDriverSearchResultDto'
'400':
description: Bad request
components:
schemas:
WithPaginationResultDriverSearchResultDto:
type: object
properties:
totalPages:
type: integer
description: Total number of pages based on the pageSize.
format: int32
totalCount:
type: integer
description: Total number of items that matched the search parameters.
format: int64
items:
type: array
description: Array of items.
items:
$ref: '#/components/schemas/DriverSearchResultDto'
DriverSearchResultDto:
type: object
properties:
id:
type: string
description: Unique driver identifier (alphanumeric)
name:
type: string
description: Full name of the driver
groupId:
type: string
description: >-
Unique, unchangeable system generated identifier (alphanumeric) of
the primary group assigned to the driver
groupName:
type: string
description: Name of the primary group assigned to the driver
customerId:
type: string
description: Unique customer identifier that the driver belongs to
active:
type: boolean
description: >-
Indicates if the driver is currently active (true = active, false =
inactive)
activeDate:
type: string
description: >-
Date and time when the driver was activated or last deactivated (ISO
8601 format: yyyy-MM-dd'T'HH:mm:ss in UTC)
format: date-time
timezoneId:
type: string
description: Timezone identifier for the driver (e.g., 'Europe/London')
defaultVehicleId:
type: string
description: >-
Unique identifier of the driver's default vehicle. Not returned if
no default vehicle is assigned
tempVehicleId:
type: string
description: >-
Unique identifier of the temporarily assigned vehicle. Not returned
if no temporary vehicle is assigned
tempVehicleExpiry:
type: string
description: >-
Date and time when the temporary vehicle assignment expires. Not
returned if no temporary vehicle is assigned
format: date-time
tempVehicleNextJourneyOnly:
type: boolean
description: >-
Indicates if the temporary vehicle assignment is for the next
journey only. Not returned if no temporary vehicle is assigned
tempPrivateMode:
type: boolean
description: >-
Indicates if the driver is currently in temporary private mode (true
= private mode active, false = private mode inactive)
tempPrivateModeExpiry:
type: string
description: >-
Date and time when the temporary private mode expires. Not returned
if not in temporary private mode
format: date-time
tempPrivateModeNextJourneyOnly:
type: boolean
description: Indicates if the temporary private mode is for the next journey only
keys:
type: array
description: >-
List of driver keys associated with the driver. Not returned if no
keys are assigned
items:
$ref: '#/components/schemas/DriverKeyDto'
tags:
type: array
description: >-
Set of tags associated with the driver for categorization. Not
returned if no tags are assigned
items:
type: string
secondaryGroups:
type: array
description: >-
List of secondary groups assigned to the driver. Only returned when
group visibility is enabled and driver belongs to secondary groups
items:
$ref: '#/components/schemas/IdNameDto'
externalId:
type: string
description: >-
External identifier of the driver from external systems. Not
returned if no external ID is set
description: >-
Driver search result containing driver information including personal
details, group assignments, vehicle associations, and temporary
settings.
DriverKeyDto:
type: object
properties:
value:
type: string
description: Unique identifier or value of the driver key
example: key-value
type:
type: string
description: Type of the driver key (e.g., 'CARD', 'FOB', 'PIN')
example: CARD
privateMode:
type: boolean
description: >-
Driver key information including key value, type, and private mode
status.
IdNameDto:
type: object
properties:
id:
type: string
description: Unique identifier of the entity (alphanumeric)
name:
type: string
description: Display name of the entity. Not returned if empty
description: Simple identifier and name pair for groups, vehicles, or other entities.
securitySchemes:
bearerAuth:
type: http
scheme: bearer
````