RoscoLive API v1.0

Get a user

GET/partners/users/{user_email}

Get an existing RoscoLive user by email. The current user can request any user for which they have view permissions, including their own user.

Request

Path Params

user_email

string <email>

required

RoscoLive user email to retrieve

Query Params

show_notifications

boolean

optional

Return user notification settings when set to true

Request samples

Responses

valid get a user(200)

get a non existing user(404)

HTTP Code: 200

Content Type : JSONapplication/json

meta

object

required

Request metadata object

code

integer

required

HTTP status code returned by server

response

object

required

Contains response data

user

#/definitions/2746197

required

result

string

required

"OK" if request successful, otherwise "Failed"

{
  "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"
}

Last modified: a month ago