FleetUp API Docs
  1. Account & User & Device
FleetUp API Docs
  • Quick Start
    • Your First API Call
    • Token Expiration
    • Rate Limit
    • Error Codes
  • API Reference
    • Introduction
    • Authentication
      • /token
      • Obtain JWT Token
    • Account & User & Device
      • /account-info
        POST
      • /users
        GET
      • /drivers/list
        GET
      • /devices
        POST
      • /devices/status
        POST
      • /devices/unlock
        POST
      • /devices/driver-overview
        POST
      • /devices/engine-hours
        POST
      • /devices/fuel-level
        POST
      • /devices/odometer
        POST
      • /devices/latest-ecu-data
        POST
      • /devices/{device-id}
        PUT
      • /devices/{device-type}
        GET
      • /devices/{device-type}/details
        POST
      • /devices/{device-type}/history
        POST
    • Trips
      • /trips/history
      • /trips/ongoing-trips
    • Trip Share
      • /tripshare/live-eta
      • /tripshare/partners
      • /tripshare/share
    • Alerts
      • /alerts/summary
      • /alerts/history
      • /alerts/bulk-history
      • /fencealerts/fence-names
      • /fencealerts/geo-fencealerts
    • Location
      • Retrieve GPS data within a 24-hour time range
      • /gpsdata/device-last-location
      • /gpsdata/latest
      • /gpsdata/latest/4cj
      • /gpsdata/latest/5ta
      • /bulk-gpsdata
    • Maintenance
      • /maintenance/history
      • /maintenance/indicators
      • /maintenance/settings/indicators
      • /maintenance/settings/measurements
    • Reports
      • /reports/temperature-sensors
      • /reports/{report-key}
    • Geofence
      • Get all fences
      • Get fence detail
      • Retrieve geofence alerts
    • Others
      • /jobs
  • API Guides
    • Retrieve All Devices from an Enterprise
  1. Account & User & Device

/users

GET
/users
Get all users. Can be filtered by role query parameter

Request

Authorization
Add parameter in header
x-api-key
Example:
x-api-key: ********************
Query Params
role
string 
optional
User role type. Possible values: BROKER, DRIVER, MANAGER, MONITOR, OBSERVER, SUPERVISOR, WORKFORCE
Header Params
token
string 
required

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/users' \
--header 'token;' \
--header 'x-api-key;'

Responses

🟢200成功
application/json
200 response
Body
status
number 
optional
response status (http status)
data
array [object {3}] 
optional
userId
string 
optional
User ID
userName
string 
optional
User name
role
enum<string> 
optional
User role
Allowed values:
BROKERDRIVERMANAGERMONITOROBSERVERSUPERVISORWORKFORCE
Example
{
    "status": 0,
    "data": [
        {
            "userId": "string",
            "userName": "string",
            "role": "BROKER"
        }
    ]
}
Modified at 2025-02-28 08:12:14
Previous
/account-info
Next
/drivers/list
Built with