/devices - FleetUp API Docs

This API returns all device details registered with the account. Enterprise users must include a JWT token in the Authorization header. Use the category filter to fetch specific device types (e.g., vehicle, asset, temperature).

Request

Authorization

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Header Params

Authorization

string

optional

JWT token (e.g., Bearer <token>)

Example:

Bearer your_jwt_token_here

Body Params application/json

acctId

string

required

Account ID

category

string

optional

Optional category to fetch the devices for the given category only.
Available categories:
vehicle
asset
bike
temperature
dashcam
airfilter
workforce

Example

{
    "acctId": "string",
    "category": "string"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200成功

application/json

200 response

Body

devices

array [object {34}]

optional

acctId

number

optional

Account ID

Example:

16816

devId

string

optional

Device ID

Example:

7200000018

vehicleName

string

optional

Vehicle Name in FleetUp

Example:

This is a test vehicle

status

string

optional

0: Offline, 1: Online

Example:

vin

string

optional

if Vin pref=1 then NOTES_FOR_VIN otherwise VEHICLE_VIN

Example:

null

year

string

optional

Device year

<= 4 characters

Example:

null

make

string

optional

Vehicle Make in FleetUp

Example:

null

model

string

optional

Vehicle Model in FleetUp

Example:

null

location

string

optional

Device Location

Example:

641 Turnbuckle Drive, Redwood City, CA 94063, USA

deviceType

string

optional

Optional category to fetch the devices for the given category .
Available categories:
vehicle
asset
bike
temperature
dashcam
airfilter
workforce

Example:

asset

license

string

optional

Vehicle License.
This data is fetched for deviceType = vehicle

Example:

null

assetNumber

string

optional

Asset Number.
This data is fetched for deviceType= asset , temperature

Example:

7200000018(4CJ)

assetModel

string

optional

Asset Model.
This data is fetched for deviceType= asset

Example:

null

assetContents

string

optional

Asset Contents.
This data is fetched for deviceType= asset

Example:

Asset for test

battery

number

optional

Battery Percentage, 255 means charging.
This field is fetched for deviceType= asset , temperature

lockStatus

number

optional

Lock Status
0: Unlocked
1: Locked
Blank : N/A
This data is fetched for deviceType= asset , temperature

bike

string

optional

Bike Name.
This data is fetched for deviceType= bike

bikeNumber

string

optional

Bike License Number.
This data is fetched for deviceType= bike

notesForVin

string

optional

Notes For Vin.
This data is fetched for deviceType= bike

notesForOdometer

string

optional

Notes for odometer.
This data is fetched for deviceType= bike

assignTo

string

optional

Device Group Name.
This data is fetched for deviceType= bike

simCard

string

optional

Sim Card.
This data is fetched for deviceType= bike

simCardPhoneNumber

string

optional

Sim Card Phone Number.
This data is fetched for deviceType= bike

contents

string

optional

Asset Contents.
This data is fetched for deviceType= temperature

dashcamId

string

optional

Dashcam Device Id.
This data is fetched for deviceType= dashcam

dashcamNumber

string

optional

Dashcam Device number.
This data is fetched for deviceType= dashcam

groupName

string

optional

Group name.
This data is fetched for deviceType= dashcam

pairedVehicleNumber

string

optional

Paired Device Number.
This data is fetched for deviceType= dashcam

sensorNumber

string

optional

This is the name assigned to the specific senzit device.
This data is fetched for deviceType= airfilter

sensorID

string

optional

Unique Identifier for each device.
This data is fetched for deviceType= airfilter

sensorIMEI

string

optional

Senzit Device Id is the Senders device id.
This data is fetched for deviceType= airfilter

vehiclePairingNumber

string

optional

Paired Device License Number.
This data is fetched for deviceType= airfilter

loadPercent

string

optional

Dust load start with 0 and end at 100.
0% means branch new filter with no dust load and
100% means filter needs to be replaced .
This data is fetched for deviceType= airfilter

remainingTime

number

optional

It is the predicted remaining filter life time left in Hours
This data is fetched for deviceType= airfilter

Example

{
    "devices": [
        {
            "acctId": 16816,
            "devId": "7200000018",
            "vehicleName": "This is a test vehicle",
            "status": "0",
            "vin": null,
            "year": null,
            "make": null,
            "model": null,
            "location": "641 Turnbuckle Drive, Redwood City, CA 94063, USA",
            "deviceType": "asset",
            "license": null,
            "assetNumber": "7200000018(4CJ)",
            "assetModel": null,
            "assetContents": "Asset for test",
            "battery": 0,
            "lockStatus": 0,
            "bike": "string",
            "bikeNumber": "string",
            "notesForVin": "string",
            "notesForOdometer": "string",
            "assignTo": "string",
            "simCard": "string",
            "simCardPhoneNumber": "string",
            "contents": "string",
            "dashcamId": "string",
            "dashcamNumber": "string",
            "groupName": "string",
            "pairedVehicleNumber": "string",
            "sensorNumber": "string",
            "sensorID": "string",
            "sensorIMEI": "string",
            "vehiclePairingNumber": "string",
            "loadPercent": "string",
            "remainingTime": 0
        }
    ]
}