- Authentication
- Company
- Get Camera Health Errors for CompanyGET
- 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 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
- 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
- Fleet Configuration
- Group
- get company groupsGET
- add a groupPUT
- remove a groupDELETE
- get devices of a groupGET
- add a device to a groupPUT
- remove a device from a groupDELETE
- get users of a groupGET
- add a user to a groupPUT
- remove a user from a groupDELETE
- get company groups by company IDGET
- add a device to a group by company IDPUT
- get devices of a group by company IDGET
- remove a device from a group by company IDDELETE
- remove a group by company IDDELETE
- add a group by company IDPUT
- add an user to a group by company IDPUT
- get users of a group by company IDGET
- remove an user from a group by company IDDELETE
- edit groupPOST
- get groups with IDGET
- get group of a company by group IDGET
- 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 Users
- Get User Info from Email Address
- Update a User's Info
- remove a user
- Get my Own User Info
- Create a User
- Get Users by Company ID
- get user settings
- set user settings
- Get application notifications
- remove the notification
- mark notifications as viewed
- verify password
- SD card reformat reminder
- Update notification by email
- assign user to company
- get permissions by a user_id
- Get event / sms notification settings
- Webhooks
get devices of a group by company ID
GET
/api/{{API_VERSION}}/partners/companies/{{COMPANY_ID}}/groups/{{GROUP_NAME}}/devices
Request
Query Params
byid
stringÂ
required
Example:
company
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 -g --request GET 'https://fleet.roscolive.com/api/v1.0/api/{{API_VERSION}}/partners/companies/{{COMPANY_ID}}/groups/{{GROUP_NAME}}/devices?byid=company' \
--header 'Content-Type: text/plain' \
--data-raw ''Responses
🟢200valid get devices of a group by company ID
application/json
Body
meta
objectÂ
required
code
integerÂ
required
response
objectÂ
required
devices
array [object {43}]Â
required
result
stringÂ
required
Example
{
"meta": {
"code": 200
},
"response": {
"devices": [
{
"cardreader": "bool",
"canbus": "str",
"device_type": "optional:str",
"is_flagged": "bool",
"activated_timestamp": "optional:datetime",
"active": "bool",
"ads_online": "bool",
"antenna_img": "optional:int",
"channel_available": "none|str",
"created_at": "datetime",
"config_checksum": "optional:none|int",
"data_limit": "int",
"flood_blocked": "optional:int",
"device_id": "str",
"driver_id": "optional:none|str",
"driver_name": "optional:str",
"driver_recognition": "optional:none|str",
"groups": "list",
"installed_by_user_id": "optional:none|int",
"is_installation": "optional:bool",
"live_online": "bool",
"matching_token": "optional:str",
"modem_img": "optional:int",
"online_gps": "bool",
"parking_duration": "int",
"partner_name": "optional:str",
"power_img": "optional:int",
"status": "str",
"serial_number": "optional:none|str",
"users": "optional:list",
"vehicle_icon": "none|str",
"vehicle_name": "none|str",
"vin_number": "optional:none|str",
"windshield_img": "optional:int",
"uploaded_company_profile": "optional:none|str",
"timezone": "optional:str",
"tag_plate": "optional:none|str",
"installed_id": "optional:int|none",
"dms_enabled": "optional:bool",
"is_installation_report": "optional:bool",
"deleted_at": "optional:str",
"recording_status": "optional:str",
"contract_id": "optional:str"
}
]
},
"result": "OK"
}🟠400get devices of a group by incorrect company ID
🟠404get devices of a none existing group by company ID
🟠401Login Required
Modified at 2024-07-25 02:00:14