Authentication
Vehicles
Drivers
Devices
Groups
Data Management
Providers
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
Retrieve a list of the providers Terminal supports. This endpoint will grow to include additional details about the supported capabilities of each provider.
curl --request GET \
--url https://api.withterminal.com/tsp/v1/providers
[
{
"name": "Geotab",
"code": "geotab",
"baseCode": "geotab",
"status": "live",
"logo": "https://cdn.withterminal.com/providers/geotab/logo.png",
"icon": "https://cdn.withterminal.com/providers/geotab/icon.png",
"userGuides": {
"en": "<string>",
"fr": "<string>",
"es": "<string>"
},
"supportedModels": {
"Group": {
"supportedOperations": {
"read": "supported"
}
},
"Vehicle": {
"supportedOperations": {
"read": "supported"
}
},
"Driver": {
"supportedOperations": {
"read": "supported"
}
},
"VehicleLocation": {
"sampleRate": "30 seconds",
"availableHistory": "1 year",
"supportedOperations": {
"read": "supported"
}
},
"VehicleStatLog": {
"supportedOperations": {
"read": "supported"
}
},
"Trailer": {
"supportedOperations": {
"read": "supported"
}
},
"TrailerLocation": {
"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"
}
}
}
}
]
Response
"Geotab"
Every provider has a unique code to identify it across Terminal's system. You can find each provider's code under provider details.
"geotab"
live
, beta
"https://cdn.withterminal.com/providers/geotab/logo.png"
"https://cdn.withterminal.com/providers/geotab/icon.png"
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
supported
, not_supported_by_terminal
, not_supported_by_provider
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
supported
, not_supported_by_terminal
, not_supported_by_provider
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
supported
, not_supported_by_terminal
, not_supported_by_provider
How frequently is data captured by the vehicle
"30 seconds"
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
supported
, not_supported_by_terminal
, not_supported_by_provider
How much history is available to backfill. No history is available if undefined.
"1 year"
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
supported
, not_supported_by_terminal
, not_supported_by_provider
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
supported
, not_supported_by_terminal
, not_supported_by_provider
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
supported
, not_supported_by_terminal
, not_supported_by_provider
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
supported
, not_supported_by_terminal
, not_supported_by_provider
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
supported
, not_supported_by_terminal
, not_supported_by_provider
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
supported
, not_supported_by_terminal
, not_supported_by_provider
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
supported
, not_supported_by_terminal
, not_supported_by_provider
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
supported
, not_supported_by_terminal
, not_supported_by_provider
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
supported
, not_supported_by_terminal
, not_supported_by_provider
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
supported
, not_supported_by_terminal
, not_supported_by_provider
The types of safety events that are supported by this provider.
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
[
"speeding",
"harsh_brake",
"harsh_acceleration",
"harsh_turn",
"crash"
]
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
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.
"geotab"
curl --request GET \
--url https://api.withterminal.com/tsp/v1/providers
[
{
"name": "Geotab",
"code": "geotab",
"baseCode": "geotab",
"status": "live",
"logo": "https://cdn.withterminal.com/providers/geotab/logo.png",
"icon": "https://cdn.withterminal.com/providers/geotab/icon.png",
"userGuides": {
"en": "<string>",
"fr": "<string>",
"es": "<string>"
},
"supportedModels": {
"Group": {
"supportedOperations": {
"read": "supported"
}
},
"Vehicle": {
"supportedOperations": {
"read": "supported"
}
},
"Driver": {
"supportedOperations": {
"read": "supported"
}
},
"VehicleLocation": {
"sampleRate": "30 seconds",
"availableHistory": "1 year",
"supportedOperations": {
"read": "supported"
}
},
"VehicleStatLog": {
"supportedOperations": {
"read": "supported"
}
},
"Trailer": {
"supportedOperations": {
"read": "supported"
}
},
"TrailerLocation": {
"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"
}
}
}
}
]