GET
/
fault-codes
/
events
List Fault Code Events
curl --request GET \
  --url https://api.withterminal.com/tsp/v1/fault-codes/events \
  --header 'Authorization: Bearer <token>' \
  --header 'Connection-Token: <connection-token>'
{
  "results": [
    {
      "protocol": "j1939",
      "id": "fc_evt_01D8ZQFGHVJ858NBF2Q7DV9MNC",
      "provider": "geotab",
      "vehicle": "vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC",
      "status": "open",
      "code": "P0087",
      "description": "Fuel Rail/System Pressure - Too Low Bank 1",
      "observedAt": "2021-01-06T03:24:53.000Z",
      "milStatus": "on",
      "obdii": {
        "code": "P0087",
        "description": "Fuel Rail/System Pressure - Too Low Bank 1"
      },
      "j1939": {
        "fmi": 9,
        "fmiDescription": "Voltage Below Normal",
        "spn": 3031,
        "spnDescription": "System Diagnostic Code #1",
        "occurrenceCount": 15,
        "sourceAddress": 256
      },
      "metadata": {
        "addedAt": "2023-11-07T05:31:56Z",
        "modifiedAt": "2023-11-07T05:31:56Z"
      },
      "raw": []
    }
  ],
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Connection-Token
string
required

The token returned when a user authenticated their account. This authorizes access to a specific account.

Example:

"con_tkn_22vUhkC6tgre4kwaYfUkCDA1rzn6eyb4"

Query Parameters

​
cursor
string<cursor>

Pagination cursor to start requests from

Example:

"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"

​
limit
integer

The maximum number of results to return in a page.

​
modifiedAfter
string<date-time>

Only include records that were last modified after a provided date.

Example:

"2021-01-06T03:24:53.000Z"

​
modifiedBefore
string<date-time>

Only include records that were last modified before a provided date.

Example:

"2021-01-06T03:24:53.000Z"

​
startAt
string<date-time>

Only include fault code events after a provided date.

Example:

"2021-01-06T03:24:53.000Z"

​
endAt
string<date-time>

Only include fault code events before a provided date.

Example:

"2021-01-06T03:24:53.000Z"

​
vehicleIds
string

Comma separated list of vehicle IDs to filter for. Can filter up to 50 vehicles at a time.

​
expand
enum<string>

Expand resources in the returned response

Available options:
vehicle
​
raw
boolean

Include raw responses used to normalize model. Used for debugging or accessing unique properties that are not unified.

Response

OK

​
results
(FaultCodeEventObdii · object | FaultCodeEventJ1939 · object)[]
required
​
next
string<cursor>

Cursor used for pagination.

Example:

"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"