Account
The account service provides a full list of drivers registered to your company.
For each driver, you will find useful information such as the registration date, the account details or the smartphone model.
If you have your admin API key, you can try the API via this link.
Query parameters
pageSize
int
Number of elements to return (default: 1000).
Min: 1000
Max: 20000
pageNumber
int
Position of the page to return, the first page has the position : 0 (default: 0)
Min: 0
startDate
int
Minimum date of the driver data's last update (timestamp)
endDate
int
Maximum date of the driver data's last update
groupLabel
string
Group name (default: All)
status
string
Status of the drivers (default: ALL).
Possible values: ALL, NO_TRIP, EXPIRED, ACTIVE
The startDate and endDate parameters can be used to filter the drivers based on their most recent interaction with the application. This date reflects the driver's last activity and is updated according to several criteria: last trip recorded, account or smartphone information updates.
Response
The table below summarizes the list of elements included in the response.
data
array[object]
totalElements
int
Total number of accounts that can be retrieved
pageNumber
int
Position of the requested page (0 for the first page)
pageSize
int
Requested page size (between 1000 and 20000)
hasNext
boolean
Indicates whether there are more results to fetch
Data array
The data array contains a list of driver's account.
userId
string
Driver's unique identifier set to initialize the DriveKit SDK
firstname
string
Driver's firstname
lastname
string
Driver's lastname
pseudo
string
Driver's pseudo
registerDate
string
Driver's registration date
Date format: YYYY-MM-dd’T’HH:mm:ss.SSSZ
pushDataStatus
string
Driver preference for data sharing
Possible values: UNKNOWN, DENY or ACCEPT
groups
array[string]
List of groups to which the driver belongs
smartphoneData
Technical information on the driver's smartphone
clientData
Client related metadata
admin
boolean
Indicates if the user is an administrator on the web dashboard
betaTester
boolean
Indicates if the account is a beta tester account
Smartphone data
The smartphoneData object includes details about the driver's smartphone.
phoneModel
string
Smartphone manufacturer codename
appBuildNumber
string
Mobile app build number
appVersion
string
Version of the mobile app
osVersion
string
Version of the operating system
osType
string
Operating system
sdkVersion
string
DriveKit SDK version
phoneLanguage
string
Detected phone lanquage
rawPhoneLanguage
string
Raw phone language
lastUpdate
string
Date of last update
Date format: YYYY-MM-dd’T’HH:mm:ss.SSSZ
Client data
Client data consists of customer-specific metadata such as: license plate number, commercial email opt-in, contract number (formatted as a map of key-value).
Error response
Unauthorized
If the request does not contain a valid authentication token, the service will answer with a http code 401.
Bad request
If the request cannot be processed, the service will answer with a http code 400. The response body will contain more details about the error:
dk_invalid_parameter_value
Invalid value for parameter 'status'
The requested status does not exist
dk_invalid_parameter_value
Invalid value for parameter(s) '[...]'
The page size or the page number are not within the authorized range
invalid_group_label
Invalid group label
The requested group does not exist
invalid_start_date
Invalid start date
The start date is not valid, or is after the end date
invalid_end_date
Invalid end date
The end date is not valid
Last updated