View All Drivers

Use this API to view the account information of drivers. Driver accounts are also considered as user accounts with limited access to the application.

📘

Sample Request

https://services.azuga.com/azuga-ws-oauth/v3/users?limit=2&offset=1&userType=driver

API Response Explanation

FieldDescriptionData Type
idUnique identifier assigned to the associated user.String
firstNameFirst name of the userString
lastNameLast name of the userString
emailEmail address associated to the user account.String
primaryContactNumberMain contact number of the associated user.String
alternateContactNumberAlternate contact number of the associated user.Long
roleIdRole ID assigned to the current user account which is assigned according to the role of the user.String
userNameThe username of the accountString
passwordThe password used by the user account.String
pinThe pin set by the user to password protect the device.String
isGetMaintenanceAlertBoolean value denoting whether the maintenance alert package is enabled or not for the user.String
isGetNewReleaseAlertBoolean value denoting whether the new release alert package is enabled or not for the user.String
customerIdUnique identifier of customer ID that the user is associated to.Long
createdByThe user account which created the current user.String
lastModifiedByThe user who made the last modification to the associated user account.String
userTypeThe types of users available on Azuga application. Each user type has an exclusive identifier assigned to them. They are:

1 - Super User (Administrator for all customer account and used by Azuga team to login any account)

2 - Admin (Administrator of customer account)

3 -Web Admin(User created by Admin)

4 - Driver (Driver associated with the vehicle)
Object
lastModifiedAtThe time stamp at which last modification was made to the user account.Timestamp
deletedBoolean value represents the delete status of the user
True = Deleted
False = Not Deleted
boolean
timeZoneLocal timezone of the driverString
deletedAtFor internal Azuga useTimestamp
apiKeyThe unique code that is passed in to the API to identify the calling user.String
lastLoginDateTimeTime stamp at which last login was made by the user account.Timestamp
licenseNumberLicence number linked with the user account(Driver).String
licenseIssuedDateThe issue date of the user's license.Date
licenseExpiryThe date on which the user's licence will expire.Date
licenseIssuedStateThe state from which the user's licence has been issued from.String
profilepicUrlThe URL of the profile pictureString
emailVerificationBoolean value denoting whether the email account linked to the user account has been verified.boolean
userDetailsDetails of the user account.Object
vehicleIdVehicle ID associated with the user accountString
vehicleNameName of the vehicle associated with the user account.String
fromDeleteDeviceFor internal Azuga useboolean
fullNameThe full name of the user i.e. combination of the first name and last name.String
tagsThe tags associated with the usersString
userTagsAssociatedFor internal Azuga useList
userTagsNamesFor internal Azuga useList
roleNameThe role assigned to the associated user.String
adminingGroupsThe groups administered by the associated user.List
countryIdThe ID of the country to which the associated user belongs to.Integer
groupIdsAndNamesThe group IDs and names which are linked with the user.List
userTypeNameThe type of user associated with the account.String
userTypeIdThe unique identifier assigned to each user type.
The ID designated to each user type are:

1 - Super User (Administrator for all customer account and used by Azuga team to login any account)

2 - Admin (Administrator of customer account)

3 -Web Admin(User created by Admin)

4 - Driver (Driver associated with the vehicle)
Integer
enabledPackageNamesThe list of packages enabled for the associated user account.String
pairingTypeIdThe types of pairing method available on Azuga application. Each pairing method has a unique identifier assigned to them. They are:

0 - Web

1 - Bluetooth

2 - Beacon

3 - NoPairing

4 - E-Logs

5- Bluetooth
Integer
pairingTypeThe pairing method used to associate the device to the user profile.String
nodeTableCreatedFor internal Azuga useBoolean
employeeIdThe employee ID linked to the user account.String
serviceHourThe number of hours the associated user needs to complete.Boolean
dispatchNumberThe unique number of the package being dispatched.String
dispatchStatusThe latest status of the package being dispatched.String
dispatchRedirectURLFor internal Azuga useString
notInGroupBoolean value denoting whether the current user account is linked to any group.boolean
pageNameName of the page.String
pageIdThe unique identifier of the different modules of web page. You can select a module from the Azuga web app to exclusively appear as the home page for a particular users. The modules are represented by the following code:

0 - Null(Default homepage of Azuga web application)
1 - map.html'(Live Map)
2 - dashboardsoverview.html(Live Map)
3 - reports.html
(Live Map)
4 - admin.html
(Live Map)
5 - rewards.html
(Live Map)
6 - maintenance.html
(Live Map)
9 - reseller.html
(Live Map)
11 - safetycam.html
(Live Map)_
Long
pageUrlURL of the displayed page.String
groupIdsList of group IDs to which the user account has been assigned to.List
String
groupNamesList of group names to which the user is assigned to.String
userDocumentListThe list of document names saved by the user.List
userDocsDeletedThe list of documents the associated user has deleted.List
userDocsThe object which consists of all metadata of the docs which the current user account has stored in the server.String
uploadTypeThe media type of the uploaded file.List
userDocURIsThe URL of user documents where the user documents have been stored.List
notLoggedinHasAccessToGroupThe list of group the associated user has acces to without logging in.Boolean
fuelCardNumberThe fuel card number linked to the current user account.String
plainPasswordThe decrypted password set by the user.String
useDefaultRoleBoolean value representing whether the role of the driver is assigned with a default one at the time of driver creationBoolean
useDefaultGroupBoolean value representing whether the group of the driver is assigned with a default one at the time of driver creationBoolean
fetchCompleteResponseFor internal Azuga useBoolean
adminUserIdThe user ID of the admin to which the user account is linked to.String
nodeFor internal Azuga useString
loginPwdOptionFor internal Azuga useShort
prevLastLoginDateTimeFor internal Azuga useTimestamp
elogVistrackBoolean representing the Vistrack package is enabled for the driverBoolean
ssouserFor internal Azuga useBoolean
Language
Authorization
Header
Click Try It! to start a request and see the response here!