RoscoLive API v1.0
  1. User
RoscoLive API v1.0
  • Authentication
    • Login
      POST
    • Logout
      GET
    • mark eula as viewed
      POST
    • password change
      POST
    • password reset
      POST
  • Company
    • Get Camera Health Errors for Company
      GET
    • create a company
      PUT
    • get partner settings
      GET
    • get audit logs of a company
      GET
    • get input sensors notifications of a company
      GET
    • get ignition notifications of a company
      GET
    • get a company by ID
      GET
    • update a company by ID
      POST
    • update company
      POST
    • search companies
      GET
    • get companies list
      GET
    • get a company
      GET
    • get companies
      GET
    • get partner companies list
      GET
    • get own partner company
      GET
  • Custom Role Permissions
    • get full list of available custom user permission
  • Device
    • get company devices
    • search devices
    • update a device
    • get a device data usage
    • Play in-cab audible alert sound for device
    • 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
    • get available firmware versions
    • get list of latest firmware versions
    • push firmware to device
    • cancel pending firmware update to devices
    • get firmware updates history for company
  • 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 New Driver to Company
    • 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
    • Request Custom Snapshots for Time Range
    • Request Custom Event
    • Get an Event of a Device by Start Time
    • Get an Event by ID and Storage Type
    • Get Company Events
    • Get Event by Company and ID
    • send an event
    • get status of an event
    • Request videos of an event
    • Get Uploaded Event Videos
    • 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 Event Snapshots
    • get snapshots of an event or alert by company ID
    • get a last event
    • Get Latest Event for Each Device in Company
    • 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
    • Update 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 Device Events for Period
    • 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
    • Get an external service account
    • Pair RL device with external device
    • Get RL device data via external device unique serial number
    • external service login
    • get a device
  • Fleet Configuration
    • Get profiles of a company
    • Create new profile in a company
    • Get a company profile
    • get profile history
    • Update a company profile
  • 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
    • start live streaming
    • stop live streaming
    • start multi-channel live streaming
    • stop multi-channel live streaming
  • Metadata
    • get metadata of a device
    • get metadata of devices
    • Get alerts and events of devices for company
    • get alerts for charts and graphs
    • get metadata of device(s) for last 24 hours
    • get alerts of a device
    • get alerts of a driver
  • Modem Administration
    • get list of available modems
    • upgrade modem firmware
    • upgrade modem firmware for group of devices
  • 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
    • get full list of devices per partner
    • get full list of companies per partner
    • get user custom presets
    • create custom presets
    • update custom preset
    • delete custom preset by name
  • Releases
    • get last release
    • view a release
  • Remote Device Management
    • get config values from device
    • verify of device token
    • get current firmware of devices
    • SD-card formatting
    • get config file for device
  • Statistics
    • get statistics feature usage
  • User
    • Get Company Users
      GET
    • Get User Info from Email Address
      GET
    • Update a User's Info
      POST
    • remove a user
      DELETE
    • Get my Own User Info
      GET
    • Create a User
      PUT
    • Get Users by Company ID
      GET
    • get user settings
      GET
    • set user settings
      PUT
    • Get application notifications
      GET
    • remove the notification
      DELETE
    • mark notifications as viewed
      POST
    • verify password
      POST
    • SD card reformat reminder
      POST
    • Update notification by email
      POST
    • assign user to company
      PUT
    • get permissions by a user_id
      GET
    • Get event / sms notification settings
      GET
  • Webhooks
    • Add Webhook Subscription to Multiple Event Types
    • Get Notification Subscriptions for Event Type
    • Set Notifications for Event Type
    • Remove Notification Subscription for Event Type
    • Get All Webhook Subscriptions for a Company
    • Delete Webhook Subscription
  1. User

Get application notifications

GET
/user/notifications
Returns application notifications for the current user. These are notifications that detail updates for certain actions the user has taken, such as confirmation of successful profile updates, uploading of custom event videos from request, ect,...

Request

Query Params
type
enum<string> 
optional
Type of notifications to return in the response. If not included, all notifications are instead returned.
Allowed values:
glacieralertdriveridsdformatcustclipupl_driversfail_upl_driverscard_unknown_driver
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/user/notifications?type='

Responses

🟢200valid get users notifications
application/json
Body
meta
object 
required
code
integer 
required
response
array [object {7}] 
required
createtime
string <date-time>
required
Time notification was generated
Example:
Fri, 30 Aug 2024 14:56:47 GMT
geotab_user_id
string  | null 
required
Geotab user ID for Geotab integrated companies, otherwise returns null
id
integer 
required
Notification ID
>= 0
notification
string 
required

Description of notification. May contain an tag with href value to linked resource.

status
enum<string> 
required
Status if notification has been viewed by user
Allowed values:
viewednot_viewed
type
enum<string> 
required
Notification type
Allowed values:
glacieralertdriveridsdformatcustclipupl_driversfail_upl_driverscard_unknown_driver
user_id
integer 
required
User ID for which the notification is associated with.
result
enum<string> 
required
Allowed values:
OKFailed
Example
{
    "meta": {
        "code": 200
    },
    "response": [
        {
            "createtime": "Fri, 30 Aug 2024 14:56:47 GMT",
            "geotab_user_id": null,
            "id": 220207,
            "notification": "Custom video request for vehicle Truck 1 is now available. Event ID: <a href=/patterns/events/2602389/regular>2602389</a>",
            "status": "viewed",
            "type": "custclip",
            "user_id": 4737
        },
        {
            "createtime": "Thu, 25 Jul 2024 20:15:59 GMT",
            "geotab_user_id": null,
            "id": 220032,
            "notification": "Additional video request for vehicle Truck 42 is now available. Event ID: <a href=/patterns/events/2602083/regular>2602083</a>",
            "status": "viewed",
            "type": "alert",
            "user_id": 4737
        }
    ],
    "result": "OK"
}
🟠400get users notifications with invalid type
🟠401Login Required
Modified at 2025-05-06 13:07:22
Previous
set user settings
Next
remove the notification
Built with