Get Telematics Fault Data

Retrieve a list of all the fault data in an organization or subset of an organization

SecuritybearerAuth

Request

query Parameters

deviceId	string or null Can use either device serial number or device ID. Example: deviceId=5100FFFF-60B6-D7CD-3FA2-22CA712B0000
Severity	string or null A value indicating the severity codes to search for. Example: Severity=Low
Status	string or null The to state of the fault. The Fault data logs are searched for events which are under the this state. Example: Status=Active
limit	integer or null Number of records to return. Example: limit=5000
offset	integer or null Record to start with. Example: offset=1500
startDate	string <date-time> The start date must be within the last 60 days. Example: startDate=2023-06-01
endDate	string <date-time> End date to filter by. Example: endDate=2023-06-02
order	string or null Sort direction. Example: order=asc
sortProperty	string or null Name of property to sort on. Example: sortProperty=name
version required	string or null API version number. Example: version=1

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/plus/v1/faultdata

Request samples

curl
JavaScript
Node.js

Response samples

application/json

{"data": [{"amberWarningLamp": true,
"classCode": "A",
"controller": {"code": 100,
"codeId": 10,
"id": "ctrl-001",
"name": "Engine Controller",
"source": {"id": "SRC-001",
"name": "Telematics Provider"
},
"version": "v1.0"
},
"count": 3,
"dateTime": "2025-01-20T10:30:00.000Z",
"device": {"id": "1b33bcbe-15d3-445e-a06f-dda61208ad18",
"activeFrom": "2023-10-06T00:22:30.000Z",
"activeTo": "2025-10-06T00:22:30.000Z",
"comment": "Installed in vehicle A123",
"groups": ["Group1",
"Group2"
],
"timeZoneId": "America/Toronto",
"deviceFlags": "FLAG_001",
"deviceType": "GO9",
"hardwareId": "HW-ABC-12345",
"ignoreDownloadsUntil": "2025-05-15T12:00:00.000Z",
"maxSecondsBetweenLogs": 300,
"name": "Device A123",
"productId": "PROD-456",
"serialNumber": "SN123456789",
"timeToDownload": "2025-09-20T10:00:00.000Z",
"workTime": "08:00-17:00",
"registerDeviceResultLite": { },
"devicePlanBillingInfo": { },
"deviceReplacementInfo": { },
"customProperties": { },
"mediaFiles": ["file1.jpg",
"file2.mp4"
],
"tmpTrailerId": "TRAILER-123",
"version": "v1.2.3"
},
"diagnostic": {"code": 101,
"controller": { },
"diagnosticType": "Engine",
"faultResetMode": "Automatic",
"id": "d1f6e56d-1234-4567-89ab-cdef12345678",
"isReadOnly": false,
"name": "Engine Overheat",
"source": { },
"tamperingDiagnostics": 0,
"unitOfMeasure": { },
"version": "v1.0"
},
"dismissDateTime": "2025-01-21T09:00:00.000Z",
"dismissUser": {"id": "1b33bcbe-15d3-445e-a06f-dda61208ad18",
"firstName": "John",
"lastName": "Doe",
"name": "John Doe",
"licenseNumber": "DL-123456",
"licenseProvince": "CA",
"acceptedEULA": 1,
"driveGuideVersion": 2,
"wifiEULA": 1,
"activeFrom": "2023-10-06T00:22:30.000Z",
"activeTo": "2025-10-06T00:22:30.000Z",
"lastAccessDate": "2025-09-15T12:22:30.000Z",
"companyName": "Acme Corp",
"companyAddress": "123 Main Street, Toronto, ON",
"carrierNumber": "CARR123",
"isDriver": true,
"isEmailReportEnabled": false,
"language": "en-US",
"timeZoneId": "America/Toronto",
"userAuthenticationType": 1,
"zoneDisplayMode": 2,
"driverGroups": [{"id": "grp-123",
"name": "Drivers Group",
"comment": "Main driver group",
"reference": "REF123",
"parent": { },
"children": [{ }
],
"color": { }
}
],
"companyGroups": [{"id": "grp-123",
"name": "Drivers Group",
"comment": "Main driver group",
"reference": "REF123",
"parent": { },
"children": [{ }
],
"color": { }
}
],
"keys": [{ }
],
"bookmarks": [{ }
],
"viewDriversOwnDataOnly": false,
"designation": "Manager",
"employeeNo": "EMP12345",
"phoneNumber": "+1-123-456-7890",
"phoneNumberExtension": "101"
},
"effectOnComponent": "Reduced performance",
"failureMode": {"id": "FM-09",
"code": 9,
"name": "Overheating",
"version": "1.0",
"source": {"id": "SRC-001",
"name": "Telematics Provider"
}
},
"faultDescription": "Engine overheating detected",
"faultLampState": "ON",
"faultState": "Active",
"effectiveStatus": {"id": "STAT-ACT",
"name": "Active"
},
"flashCode": {"id": "FC-778",
"name": "Flash Code 778",
"circuitIndex": "CIR-02",
"flashCodeIndex": "FCI-778",
"pageReference": "Page 120",
"helpUrl": "https://help.example.com/faults/778",
"priorityLevel": 1,
"diagnostic": {"code": 101,
"controller": { },
"diagnosticType": "Engine",
"faultResetMode": "Automatic",
"id": "d1f6e56d-1234-4567-89ab-cdef12345678",
"isReadOnly": false,
"name": "Engine Overheat",
"source": { },
"tamperingDiagnostics": 0,
"unitOfMeasure": { },
"version": "v1.0"
},
"failureMode": {"id": "FM-09",
"code": 9,
"name": "Overheating",
"version": "1.0",
"source": {"id": "SRC-001",
"name": "Telematics Provider"
}
}
},
"id": "fault-12345",
"malfunctionLamp": false,
"protectWarningLamp": false,
"recommendation": "Stop vehicle and inspect engine cooling system",
"redStopLamp": false,
"riskOfBreakdown": 2,
"severity": "High",
"sourceAddress": 33
}
]
}