Authentication
Vehicles
Drivers
Vehicle Utilization
Devices
Groups
Data Management
Providers
Fault Codes
Webhook Events
- Event Types
- connection.created
- connection.disconnected
- connection.reconnected
- connection.completed
- connection.updated
- sync.requested
- sync.started
- sync.completed
- sync.failed
- connection.first_sync_completed
- issue.reported
- issue.resolved
- unsupported_provider.requested
- vehicle.added
- vehicle.modified
- vehicle.removed
- driver.added
- driver.modified
- driver.removed
- safety_event.added
- safety_event.modified
List Providers
Copy
Ask AI
curl --request GET \
--url https://api.withterminal.com/tsp/v1/providers \
--header 'Authorization: Bearer <token>'Copy
Ask AI
[
{
"name": "Geotab",
"code": "geotab",
"status": "live",
"logo": "https://cdn.withterminal.com/providers/geotab/logo.png",
"icon": "https://cdn.withterminal.com/providers/geotab/icon.png",
"supportedModels": {
"Group": {
"supportedOperations": {
"read": "supported"
}
},
"Vehicle": {
"supportedOperations": {
"read": "supported"
}
},
"Driver": {
"supportedOperations": {
"read": "supported"
}
},
"LatestVehicleLocation": {
"supportedOperations": {
"read": "supported"
}
},
"VehicleLocation": {
"sampleRate": "30 seconds",
"supportedOperations": {
"read": "supported"
},
"availableHistory": "1 year"
},
"VehicleStatLog": {
"supportedOperations": {
"read": "supported"
}
},
"Trailer": {
"supportedOperations": {
"read": "supported"
}
},
"LatestTrailerLocation": {
"supportedOperations": {
"read": "supported"
}
},
"Trip": {
"supportedOperations": {
"read": "supported"
}
},
"Device": {
"supportedOperations": {
"read": "supported"
}
},
"HOSLog": {
"supportedOperations": {
"read": "supported"
}
},
"HOSDailyLog": {
"supportedOperations": {
"read": "supported"
}
},
"HOSAvailableTime": {
"supportedOperations": {
"read": "supported"
}
},
"IFTASummary": {
"supportedOperations": {
"read": "supported"
}
},
"SafetyEvent": {
"supportedOperations": {
"read": "supported"
},
"types": [
"speeding",
"harsh_brake",
"harsh_acceleration",
"harsh_turn",
"crash"
]
},
"CameraMedia": {
"supportedOperations": {
"read": "supported"
}
},
"FaultCodeEvent": {
"supportedOperations": {
"read": "supported"
}
},
"VehicleUtilization": {
"supportedOperations": {
"read": "supported"
}
}
},
"baseCode": "geotab",
"userGuides": {
"en": "<string>",
"fr": "<string>",
"es": "<string>"
},
"references": [
{
"type": "login-page",
"url": "<string>",
"label": "<string>"
}
]
}
]Providers
List Providers
Retrieve a list of the providers Terminal supports. This endpoint will grow to include additional details about the supported capabilities of each provider.
GET
/
providers
List Providers
Copy
Ask AI
curl --request GET \
--url https://api.withterminal.com/tsp/v1/providers \
--header 'Authorization: Bearer <token>'Copy
Ask AI
[
{
"name": "Geotab",
"code": "geotab",
"status": "live",
"logo": "https://cdn.withterminal.com/providers/geotab/logo.png",
"icon": "https://cdn.withterminal.com/providers/geotab/icon.png",
"supportedModels": {
"Group": {
"supportedOperations": {
"read": "supported"
}
},
"Vehicle": {
"supportedOperations": {
"read": "supported"
}
},
"Driver": {
"supportedOperations": {
"read": "supported"
}
},
"LatestVehicleLocation": {
"supportedOperations": {
"read": "supported"
}
},
"VehicleLocation": {
"sampleRate": "30 seconds",
"supportedOperations": {
"read": "supported"
},
"availableHistory": "1 year"
},
"VehicleStatLog": {
"supportedOperations": {
"read": "supported"
}
},
"Trailer": {
"supportedOperations": {
"read": "supported"
}
},
"LatestTrailerLocation": {
"supportedOperations": {
"read": "supported"
}
},
"Trip": {
"supportedOperations": {
"read": "supported"
}
},
"Device": {
"supportedOperations": {
"read": "supported"
}
},
"HOSLog": {
"supportedOperations": {
"read": "supported"
}
},
"HOSDailyLog": {
"supportedOperations": {
"read": "supported"
}
},
"HOSAvailableTime": {
"supportedOperations": {
"read": "supported"
}
},
"IFTASummary": {
"supportedOperations": {
"read": "supported"
}
},
"SafetyEvent": {
"supportedOperations": {
"read": "supported"
},
"types": [
"speeding",
"harsh_brake",
"harsh_acceleration",
"harsh_turn",
"crash"
]
},
"CameraMedia": {
"supportedOperations": {
"read": "supported"
}
},
"FaultCodeEvent": {
"supportedOperations": {
"read": "supported"
}
},
"VehicleUtilization": {
"supportedOperations": {
"read": "supported"
}
}
},
"baseCode": "geotab",
"userGuides": {
"en": "<string>",
"fr": "<string>",
"es": "<string>"
},
"references": [
{
"type": "login-page",
"url": "<string>",
"label": "<string>"
}
]
}
]Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Response
OK
Example:
"Geotab"
Every provider has a unique code to identify it across Terminal's system. You can find each provider's code under provider details.
Example:
"geotab"
The status of the provider.
Available options:
live, beta, sandbox, deprecated Example:
"https://cdn.withterminal.com/providers/geotab/logo.png"
Example:
"https://cdn.withterminal.com/providers/geotab/icon.png"
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Enum values:
supported: Terminal supports this resourcenot_supported_by_terminal: Terminal does not support this resourcenot_supported_by_provider: The provider does not support this resource
Available options:
supported, not_supported_by_terminal, not_supported_by_provider Show child attributes
Show child attributes
Show child attributes
Show child attributes
Enum values:
supported: Terminal supports this resourcenot_supported_by_terminal: Terminal does not support this resourcenot_supported_by_provider: The provider does not support this resource
Available options:
supported, not_supported_by_terminal, not_supported_by_provider Show child attributes
Show child attributes
Show child attributes
Show child attributes
Enum values:
supported: Terminal supports this resourcenot_supported_by_terminal: Terminal does not support this resourcenot_supported_by_provider: The provider does not support this resource
Available options:
supported, not_supported_by_terminal, not_supported_by_provider Show child attributes
Show child attributes
Show child attributes
Show child attributes
Enum values:
supported: Terminal supports this resourcenot_supported_by_terminal: Terminal does not support this resourcenot_supported_by_provider: The provider does not support this resource
Available options:
supported, not_supported_by_terminal, not_supported_by_provider Show child attributes
Show child attributes
How frequently is data captured by the vehicle
Example:
"30 seconds"
Show child attributes
Show child attributes
Enum values:
supported: Terminal supports this resourcenot_supported_by_terminal: Terminal does not support this resourcenot_supported_by_provider: The provider does not support this resource
Available options:
supported, not_supported_by_terminal, not_supported_by_provider How much history is available to backfill. No history is available if undefined.
Example:
"1 year"
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Enum values:
supported: Terminal supports this resourcenot_supported_by_terminal: Terminal does not support this resourcenot_supported_by_provider: The provider does not support this resource
Available options:
supported, not_supported_by_terminal, not_supported_by_provider Show child attributes
Show child attributes
Show child attributes
Show child attributes
Enum values:
supported: Terminal supports this resourcenot_supported_by_terminal: Terminal does not support this resourcenot_supported_by_provider: The provider does not support this resource
Available options:
supported, not_supported_by_terminal, not_supported_by_provider Show child attributes
Show child attributes
Show child attributes
Show child attributes
Enum values:
supported: Terminal supports this resourcenot_supported_by_terminal: Terminal does not support this resourcenot_supported_by_provider: The provider does not support this resource
Available options:
supported, not_supported_by_terminal, not_supported_by_provider Show child attributes
Show child attributes
Show child attributes
Show child attributes
Enum values:
supported: Terminal supports this resourcenot_supported_by_terminal: Terminal does not support this resourcenot_supported_by_provider: The provider does not support this resource
Available options:
supported, not_supported_by_terminal, not_supported_by_provider Show child attributes
Show child attributes
Show child attributes
Show child attributes
Enum values:
supported: Terminal supports this resourcenot_supported_by_terminal: Terminal does not support this resourcenot_supported_by_provider: The provider does not support this resource
Available options:
supported, not_supported_by_terminal, not_supported_by_provider Show child attributes
Show child attributes
Show child attributes
Show child attributes
Enum values:
supported: Terminal supports this resourcenot_supported_by_terminal: Terminal does not support this resourcenot_supported_by_provider: The provider does not support this resource
Available options:
supported, not_supported_by_terminal, not_supported_by_provider Show child attributes
Show child attributes
Show child attributes
Show child attributes
Enum values:
supported: Terminal supports this resourcenot_supported_by_terminal: Terminal does not support this resourcenot_supported_by_provider: The provider does not support this resource
Available options:
supported, not_supported_by_terminal, not_supported_by_provider Show child attributes
Show child attributes
Show child attributes
Show child attributes
Enum values:
supported: Terminal supports this resourcenot_supported_by_terminal: Terminal does not support this resourcenot_supported_by_provider: The provider does not support this resource
Available options:
supported, not_supported_by_terminal, not_supported_by_provider Show child attributes
Show child attributes
Show child attributes
Show child attributes
Enum values:
supported: Terminal supports this resourcenot_supported_by_terminal: Terminal does not support this resourcenot_supported_by_provider: The provider does not support this resource
Available options:
supported, not_supported_by_terminal, not_supported_by_provider Show child attributes
Show child attributes
Show child attributes
Show child attributes
Enum values:
supported: Terminal supports this resourcenot_supported_by_terminal: Terminal does not support this resourcenot_supported_by_provider: The provider does not support this resource
Available options:
supported, not_supported_by_terminal, not_supported_by_provider The types of safety events that are supported by this provider.
Available options:
harsh_brake, harsh_acceleration, harsh_turn, speeding, crash, near_crash, tailgating, cell_phone, distracted, drowsiness, smoking, seat_belt_violation, stop_sign_violation, red_light_violation, unsafe_lane_change, camera_obstruction, eating_and_drinking, rolling_stop, unsafe_parking Example:
[
"speeding",
"harsh_brake",
"harsh_acceleration",
"harsh_turn",
"crash"
]Show child attributes
Show child attributes
Show child attributes
Show child attributes
Enum values:
supported: Terminal supports this resourcenot_supported_by_terminal: Terminal does not support this resourcenot_supported_by_provider: The provider does not support this resource
Available options:
supported, not_supported_by_terminal, not_supported_by_provider Show child attributes
Show child attributes
Show child attributes
Show child attributes
Enum values:
supported: Terminal supports this resourcenot_supported_by_terminal: Terminal does not support this resourcenot_supported_by_provider: The provider does not support this resource
Available options:
supported, not_supported_by_terminal, not_supported_by_provider Show child attributes
Show child attributes
Show child attributes
Show child attributes
Enum values:
supported: Terminal supports this resourcenot_supported_by_terminal: Terminal does not support this resourcenot_supported_by_provider: The provider does not support this resource
Available options:
supported, not_supported_by_terminal, not_supported_by_provider The base provider code that this provider is built on. Only visible to authenticated users. Used to identify providers that share the same underlying technology platform.
Example:
"geotab"
Additional reference links for the provider (e.g., login pages)
⌘I