- Authentication
- Company
- get camera health errorGET
- create a companyPUT
- get partner settingsGET
- get audit logs of a companyGET
- get input sensors notifications of a companyGET
- get ignition notifications of a companyGET
- get a company by IDGET
- update a company by IDPOST
- update companyPOST
- search companiesGET
- get companies listGET
- get a companyGET
- get companiesGET
- get partner companies listGET
- get own partner companyGET
- Custom Role Permissions
- Device
- get company devices
- search devices
- update a device
- get a device data usage
- Play audible alert sound
- get devices data usage
- get a company devices by company ID
- restart a device
- get company devices with modems
- get distance
- get installed report of a device
- get an installed report
- merge profile with device config
- get audit logs of a device
- get list of trip dates for device
- get list of trips for passed device and date
- Get a device
- get list of company devices
- get device with driver id
- create devices (legacy/DV4)
- create devices (auto-prov/DV6)
- get company device using IMEI/SN
- check red bubble in manage vehicles
- bulk device creation
- get devices for all companies available for user
- get list of trip related snapshots
- reset status of sd card
- get list of all available dates
- get available video list for date
- replace device
- get replace history by device id
- clear device channel status
- get camera health error by device id
- get camera health definitions
- update camera health error by error id
- update camera health errors
- Get device list for multiple companies
- Get current activity status of devices
- Device Firmware
- Driver Scoring / Coaching
- get company drivers list
- get a list of trips
- associate a driver with a trip
- get driver by event_id
- update a driver
- get driver by trip_photo_id
- get driver scores
- add driver photo
- add a driver
- remove a driver
- upload a driver from csv file
- get unknown driver trips
- associate trip with the driver.
- Get company event score weights
- Update company event score weights
- Get drivers coaching events
- Event
- Get company events
- get an event
- send an event
- get status of an event
- Request videos of an event
- get uploaded videos of an event
- get events summary of devices
- get events summary of a device
- get a company events by company ID
- get status of an event by company ID
- get snapshots of an event or alert
- get snapshots of an event or alert by company ID
- get a last event
- get a last event of devices
- get events log of a device
- get dates of events
- get events for charts and graphs
- get events for charts and graphs by company ID
- get an event by company ID
- get events summary of a device by company ID
- request videos of an event by company ID
- get dates of an events by company ID
- get a last event of company device
- clear last event
- get dates of events of a device
- push custom event
- delete an event
- request videos of an alert
- share an event
- get an event by a permalink
- get geotab events
- get a last updated event of devices
- download a blocked event
- Get flagged company events
- flag an event
- unflag an event
- generate snapshots
- local geocoding service
- update an event
- get snapshot/location of event
- Get events for a device
- Request custom video from device
- get snapshot on demand
- get an event by a permalink hash
- Set Event Label for Event
- Restore event video from archive
- Add users for notification of event restore from archive
- Add event label
- Add user feedback to event
- Get event user feedback
- Get event filters list for date range in company
- External Service
- Fleet Configuration
- Group
- get company groups
- add a group
- remove a group
- get devices of a group
- add a device to a group
- remove a device from a group
- get users of a group
- add a user to a group
- remove a user from a group
- get company groups by company ID
- add a device to a group by company ID
- get devices of a group by company ID
- remove a device from a group by company ID
- remove a group by company ID
- add a group by company ID
- add an user to a group by company ID
- get users of a group by company ID
- remove an user from a group by company ID
- edit group
- get groups with ID
- get group of a company by group ID
- Live streaming
- Metadata
- Modem Administration
- Report
- get data usage report
- Get custom report data
- get data usage report by device id
- get list of companies with data usage for date range
- get data usage for active devices for specified companies
- get companies with data usage for date range
- get data usage report for devices in company
- get data tracking report
- get all events report
- Get all events report for company
- get vehicle activity report
- get firmware report
- Get event count summary report for company devices
- get driver event breakdown report
- get driver event performance report
- Update custom report
- get custom reports by user email
- get custom report by report id
- put subscribe to a report
- get report subscriptions
- get list of standard reports
- get speeding summary report
- get speeding breakdown report
- get idling summary report
- get idling breakdown report
- Create custom report for user
- Partner Portal
- Releases
- Remote Device Management
- Statistics
- User
- get company usersGET
- Get a userGET
- update a userPOST
- remove a userDELETE
- Get own infoGET
- create a userPUT
- get company users by company IDGET
- get user settingsGET
- set user settingsPUT
- Get application notificationsGET
- remove the notificationDELETE
- mark notifications as viewedPOST
- verify passwordPOST
- SD card reformat reminderPOST
- Update notification by emailPOST
- assign user to companyPUT
- get permissions by a user_idGET
- Get event / sms notification settingsGET
- Webhooks
Get a user
GET
/partners/users/{user_email}
usernotificationdata
Request
Path Params
user_email
string <email>
required
Query Params
show_notifications
booleanÂ
optional
true
Body Params multipart/form-data
object {0}
Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://fleet.roscolive.com/api/v1.0/partners/users/?show_notifications'
Responses
🟢200valid get a user
application/json
Body
meta
objectÂ
required
code
integerÂ
required
response
objectÂ
required
user
object (User schema)Â
required
result
stringÂ
required
Examples
{
"meta": {
"code": 200
},
"response": {
"user": {
"active": true,
"aggr_notific_interval": null,
"alert_camera_errors": null,
"alert_camera_failure": false,
"alert_critical_gsensor": false,
"alert_dv_camera_failure": false,
"alert_high_temperature": false,
"alert_idling": false,
"alert_inactive_vehicles": false,
"alert_inactive_vehicles_time": 5,
"alert_no_sd_card": null,
"alert_sd_error": false,
"alert_sensor": false,
"alert_speed": false,
"audit_notification": false,
"company_audit_log": null,
"company_data": {
"data_limit": 0,
"live_active": true,
"storage_active": true,
"trace_active": true
},
"company_driver_recognition": "manual",
"company_id": 3,
"company_name": "Acme Trucking, LLC",
"company_reformat_reminder": 4,
"company_token": "12345670",
"company_type": "PARTNER",
"confirmed_at": true,
"created_timestamp": "Thu, 05 Nov 2020 13:35:32 GMT",
"daily_new_cameras_notifs": null,
"daily_recording_status_notifs": false,
"data_overage_notification": null,
"data_overage_notification_vehicle_limit": "10",
"data_pool_usage": false,
"data_pool_usage_frequency": "weekly",
"data_pool_warning": false,
"data_pool_warning_threshold": "75",
"data_usage_notification": false,
"data_usage_notification_vehicle_limit": "100",
"device_high_data_usage": false,
"device_high_data_usage_threshold_data_pool": 30,
"email": "jon.doe@example.com",
"eula_was_viewed": true,
"event_breakdown": false,
"first_name": "Jon",
"flood_notification": false,
"groups": [],
"harshaccel": null,
"harshbraking": null,
"has_registered_sms": false,
"high_speeding": null,
"id": 4737,
"installer_company_name": null,
"is_fake": false,
"last_login": "Wed, 24 Jul 2024 13:16:00 GMT",
"last_name": "Doe",
"low_speeding": null,
"mecp_cert": false,
"moderate_speeding": null,
"phone_number": "12345678",
"recent_activity": "Wed, 24 Jul 2024 17:38:35 GMT",
"recording_status_notifs": false,
"reformat_last_notifs": "Thu, 05 Nov 2020 13:35:33 GMT",
"reformat_reminder": false,
"release_viewed": "Thu, 28 Dec 2023 17:13:00 GMT",
"roles": [
"partner"
],
"rosco_product_owned": null,
"settings": {
"inputsensor1_active": false,
"inputsensor1_description": null,
"inputsensor1_name": null,
"inputsensor2_active": false,
"inputsensor2_description": null,
"inputsensor2_name": null,
"inputsensor3_active": false,
"inputsensor3_description": null,
"inputsensor3_name": null,
"inputsensor4_active": false,
"inputsensor4_description": null,
"inputsensor4_name": null,
"latitude": null,
"longitude": null,
"time_zone": null,
"zoom_level": 5
},
"severe_speeding": null,
"speed_unit": "mph",
"status": "used",
"unidentified_drivers": false,
"work_submission_report": null
}
},
"result": "OK"
}
🟠404get a non existing user
🟠401Login Required
Modified at 2024-11-26 20:49:00