Group-scoped endpoints

Group scoping lets administrators restrict a company API key to specific Groups. Requests made with a Group-scoped API key return or modify only data associated with the key's assigned Groups.

Group scoping applies to company API keys created from Admin → Developers → API access. It does not apply to OAuth access.

How group scoping works

Depending on the endpoint, requests involving resources outside the API key's assigned Groups may:

Return only resources within the assigned Groups.
Return a 404 Not Found response.
Reject the request.
Apply the narrower scope when both the request and API key specify Groups.

Partially scoped operations

The following operations have partial Group-scoping behavior and should be documented separately:

POST /v1/assets
POST /v1/fuel_purchases
PUT /v1/fuel_purchases/:id
POST /v1/users
POST /v2/users
POST /v3/users
POST /v4/users
PUT /v1/vehicles/:id
POST /v1/vehicles

Unsupported or excluded operations

POST /v1/fuel_purchase_imports is not included because bulk fuel purchase imports bypass Group scoping.

Webhook delivery supports Group scoping for supported HTTP Webhooks V1 events. However, webhook management endpoints are not included in this API endpoint list.

Supported endpoints

Resource	Method	Endpoint	Group-scoping behavior
`asset_locations`	`GET`	`/v1/asset_locations`	Only locations for assets in the API key's assigned Groups are returned.
`asset_locations`	`GET`	`/v1/asset_locations/:id`	Returns a `404` if the asset does not belong to the API key's Groups.
`asset_locations`	`GET`	`/v2/asset_locations/:id`	Returns a `404` if the asset does not belong to the API key's Groups.
`assets`	`GET`	`/v1/assets`	Only assets in the API key's Groups are returned.
`assets`	`GET`	`/v2/assets`	Only assets in the API key's Groups are returned.
`assets`	`GET`	`/v1/assets/lookup_by_external_id`	Returns a `404` if the matched asset is not in the API key's Groups.
`assets`	`GET`	`/v1/assets/:id/recovery_mode`	Returns a `404` if the asset is not in the API key's Groups.
`assets`	`GET`	`/v1/assets/recovery_modes`	Only assets in recovery mode that belong to the API key's Groups are returned.
`assets`	`PUT`	`/v1/assets/:id`	Returns a `404` if the asset is not in the API key's Groups.
`assets`	`PUT`	`/v2/assets/:id`	Returns a `404` if the asset is not in the API key's Groups.
`assets`	`PUT`	`/v1/assets/:id/locate`	Returns a `404` if the asset is not in the API key's Groups.
`assets`	`PUT`	`/v1/assets/:id/recovery_mode`	Returns a `404` if the asset is not in the API key's Groups.
`available_time`	`GET`	`/v1/available_time`	Only availability data for drivers in the API key's Groups is returned.
`camera_connections`	`GET`	`/v1/camera_connections`	Only camera connections for vehicles and drivers in the API key's Groups are returned.
`cameras`	`PUT`	`/v1/cameras/:eld_device_id`	Returns a `404` if the ELD device is not on a vehicle in the API key's Groups.
`cameras`	`GET`	`/v1/cameras/:eld_device_id/:request_id`	Returns a `404` if the ELD device is not on a vehicle in the API key's Groups.
`compliance_driving_events`	`GET`	`/v1/compliance_driving_events`	Only events for drivers in the API key's Groups are returned.
`compliance_driving_events`	`GET`	`/v1/compliance_driving_events/:id`	Returns a `404` if the event belongs to a driver outside the API key's Groups.
`dispatches`	`GET`	`/v1/dispatches`	Only dispatches assigned to drivers or vehicles in the API key's Groups are returned.
`dispatches`	`GET`	`/v2/dispatches`	Only dispatches assigned to drivers or vehicles in the API key's Groups are returned.
`dispatches`	`GET`	`/v3/dispatches`	Only dispatches assigned to drivers or vehicles in the API key's Groups are returned.
`dispatches`	`POST`	`/v1/dispatches`	The request is rejected if the driver or vehicle is not in the API key's Groups.
`dispatches`	`POST`	`/v2/dispatches`	The request is rejected if the driver or vehicle is not in the API key's Groups.
`dispatches`	`POST`	`/v3/dispatches`	The request is rejected if the driver or vehicle is not in the API key's Groups.
`dispatches`	`PUT`	`/v1/dispatches`	Returns a `404` if the dispatch is outside the API key's Groups.
`dispatches`	`PUT`	`/v2/dispatches`	Returns a `404` if the dispatch is outside the API key's Groups.
`dispatches`	`PUT`	`/v3/dispatches`	Returns a `404` if the dispatch is outside the API key's Groups.
`driver_details`	`GET`	`/v1/driver_details`	Group-scoped according to the audit.
`driver_fuel_performance`	`GET`	`/v1/driver_fuel_performance`	Results are limited to drivers covered by both the `group_ids` parameter and the API key. The narrower set applies.
`driver_locations`	`GET`	`/v1/driver_locations`	Only locations for drivers in the API key's Groups are returned.
`driver_performance_events`	`GET`	`/v1/driver_performance_events`	Only events for drivers and vehicles in the API key's Groups are returned.
`driver_performance_events`	`GET`	`/v2/driver_performance_events`	Only events for drivers and vehicles in the API key's Groups are returned.
`driver_utilization`	`GET`	`/v1/driver_utilization`	Only utilization data for drivers in the API key's Groups is returned.
`driver_utilization`	`GET`	`/v2/driver_utilization`	Only utilization data for drivers in the API key's Groups is returned.
`driving_periods`	`GET`	`/v1/driving_periods`	Only driving periods for drivers in the API key's Groups are returned.
`driving_periods`	`PUT`	`/v1/driving_periods/:id`	Returns a `404` if the driving period is not for a driver in the API key's Groups.
`eld_devices`	`GET`	`/v1/eld_devices`	Only ELD devices on vehicles in the API key's Groups are returned.
`eld_disconnects`	`GET`	`/v1/eld_disconnects`	Only disconnect events for vehicles in the API key's Groups are returned.
`events`	`GET`	`/v1/events`	Only events for drivers in the API key's Groups are returned.
`events`	`POST`	`/v1/events`	The request is rejected if the driver is not in the API key's Groups.
`events`	`PUT`	`/v1/events/:id`	Returns a `404` if the event belongs to a driver outside the API key's Groups.
`events`	`DELETE`	`/v1/events/:id`	Returns a `404` if the event belongs to a driver outside the API key's Groups.
`fault_codes`	`GET`	`/v1/fault_codes`	Only fault codes from vehicles in the API key's Groups are returned.
`fuel_purchases`	`GET`	`/v1/fuel_purchases`	Only fuel purchases linked to drivers or vehicles in the API key's Groups are returned.
`fuel_purchases`	`GET`	`/v1/fuel_purchases/:id`	Returns a `404` if the fuel purchase is not linked to a driver or vehicle in the API key's Groups.
`fuel_purchases`	`PUT`	`/v1/fuel_purchases/:id`	Returns a `404` if the fuel purchase is outside the API key's Groups.
`fuel_purchases`	`DELETE`	`/v1/fuel_purchases/:id`	Returns a `404` if the fuel purchase is outside the API key's Groups.
`geofences`	`GET`	`/v1/geofences/events`	Only geofence events involving vehicles, drivers, or geofences in the API key's Groups are returned.
`geofences`	`GET`	`/v1/geofences/asset_events`	Only geofence events involving assets or geofences in the API key's Groups are returned.
`geofences`	`GET`	`/v1/geofences`	Only geofences assigned to the API key's Groups are returned.
`geofences`	`GET`	`/v1/geofences/:id`	Returns a `404` if the geofence is not assigned to the API key's Groups.
`geofences`	`PUT`	`/v1/geofences/:id`	Returns a `404` if the geofence is not in the API key's Groups.
`geofences`	`DELETE`	`/v1/geofences/:id`	Returns a `404` if the geofence is not in the API key's Groups.
`groups`	`GET`	`/v1/groups`	Only Groups within the API key's scope are returned.
`groups`	`POST`	`/v1/groups`	The parent Group must be within the API key's scope or the request is rejected.
`groups`	`GET`	`/v1/groups/:id`	Returns a `404` if the Group is outside the API key's scope.
`groups`	`DELETE`	`/v1/groups/:id`	Returns a `404` if the Group is outside the API key's scope.
`groups`	`PUT`	`/v1/groups/:id`	Returns a `404` if the Group is outside the API key's scope.
`groups`	`GET`	`/v1/groups/:id/users`	Returns a `404` if the Group is outside the API key's scope.
`groups`	`GET`	`/v1/groups/:id/drivers`	Returns a `404` if the Group is outside the API key's scope.
`groups`	`GET`	`/v1/groups/:id/fleet_managers`	Returns a `404` if the Group is outside the API key's scope.
`groups`	`GET`	`/v1/groups/:id/vehicles`	Returns a `404` if the Group is outside the API key's scope.
`groups`	`GET`	`/v1/groups/:id/assets`	Returns a `404` if the Group is outside the API key's scope.
`groups`	`GET`	`/v1/groups/:id/geofences`	Returns a `404` if the Group is outside the API key's scope.
`groups`	`POST`	`/v1/groups/:id/users`	The request is rejected if the Group or users are outside the API key's scope.
`groups`	`POST`	`/v1/groups/:id/vehicles`	The request is rejected if the Group or vehicles are outside the API key's scope.
`groups`	`POST`	`/v1/groups/:id/assets`	The request is rejected if the Group or assets are outside the API key's scope.
`groups`	`POST`	`/v1/groups/:id/geofences`	The request is rejected if the Group is outside the API key's scope.
`groups`	`DELETE`	`/v1/groups/:id/users`	Returns a `404` if the Group is outside the API key's scope.
`groups`	`DELETE`	`/v1/groups/:id/vehicles`	Returns a `404` if the Group is outside the API key's scope.
`groups`	`DELETE`	`/v1/groups/:id/assets`	Returns a `404` if the Group is outside the API key's scope.
`groups`	`DELETE`	`/v1/groups/:id/geofences`	Returns a `404` if the Group is outside the API key's scope.
`hos_violations`	`GET`	`/v1/hos_violations`	Only HOS violations for drivers in the API key's Groups are returned.
`hours_of_service`	`GET`	`/v1/hours_of_service`	Only HOS logs for drivers in the API key's Groups are returned.
`idle_events`	`GET`	`/v1/idle_events`	Only idle events for vehicles in the API key's Groups are returned.
`ifta`	`GET`	`/v1/ifta/trips`	Only IFTA trips for vehicles in the API key's Groups are returned.
`ifta`	`GET`	`/v1/ifta/summary`	Only IFTA summary data for vehicles in the API key's Groups is returned.
`image_captures`	`POST`	`/v1/image_captures`	Captures can only be requested for vehicles or assets in the API key's Groups. The request is rejected otherwise.
`images`	`GET`	`/v1/images`	Returns a `404` if the vehicle ID is not in the API key's Groups.
`inspection_reports`	`GET`	`/v1/inspection_reports`	Only reports are returned where the vehicle, asset, or driver belongs to the API key's Groups.
`inspection_reports`	`PUT`	`/v1/inspection_reports/:id`	Returns a `404` if the report's vehicle, asset, or driver is not in the API key's Groups.
`inspection_reports`	`GET`	`/v1/inspection_reports/lookup_by_external_id`	Returns a `404` if the report's vehicle, asset, or driver is not in the API key's Groups.
`inspection_reports`	`GET`	`/v2/inspection_reports`	Only reports are returned where the vehicle, asset, or driver belongs to the API key's Groups.
`inspection_reports`	`GET`	`/v2/inspection_reports/lookup_by_external_id`	Returns a `404` if the report's vehicle, asset, or driver is not in the API key's Groups.
`inspection_reports`	`PUT`	`/v2/inspection_reports/:id`	Returns a `404` if the report's vehicle, asset, or driver is not in the API key's Groups.
`inspection_reports`	`PUT`	`/v2/inspection_reports/:id/mark_safe`	Returns a `404` if the report's vehicle, asset, or driver is not in the API key's Groups.
`live_shares`	`GET`	`/v1/live_shares`	Only Live Shares of vehicles or assets in the API key's Groups are included.
`live_shares`	`GET`	`/v1/live_shares/:id`	Returns a `404` if the Live Share belongs to a vehicle or asset outside the API key's Groups.
`live_shares`	`POST`	`/v1/live_shares`	Returns a `404` if the provided entity is outside the API key's Groups.
`live_shares`	`PUT`	`/v1/live_shares/:id`	Returns a `404` if the Live Share belongs to a vehicle or asset outside the API key's Groups.
`log_suggestions`	`GET`	`/v1/log_suggestions`	Only log suggestions for drivers in the API key's Groups are returned.
`log_suggestions`	`POST`	`/v1/log_suggestions`	The request is rejected if the parent log belongs to a driver outside the API key's Groups.
`log_suggestions`	`PUT`	`/v1/log_suggestions/:id`	Returns a `404` if the log suggestion or driver is outside the API key's Groups.
`logs`	`GET`	`/v1/logs`	Only HOS logs for drivers in the API key's Groups are returned.
`logs`	`GET`	`/v2/logs`	Only HOS logs for drivers in the API key's Groups are returned.
`oem_entities`	`GET`	`/v1/oem_entities`	Only OEM entities for vehicles in the API key's Groups are returned.
`reefer_activity_data`	`GET`	`/v1/reefer_activity_data`	Only reefer data for vehicles in the API key's Groups is returned.
`reefer_activity_reports`	`GET`	`/v1/reefer_activity_reports`	Reefers outside the API key's Groups are excluded.
`reefers`	`GET`	`/v1/reefers/samples`	Only reefer samples for vehicles in the API key's Groups are returned.
`reefers`	`POST`	`/v1/reefers/samples`	Only reefer samples for vehicles in the API key's Groups are included.
`remarks`	`GET`	`/v1/remarks`	Only remarks made by drivers in the API key's Groups are returned.
`remarks`	`POST`	`/v1/remarks`	The request is rejected if the driver is not in the API key's Groups.
`remarks`	`PUT`	`/v1/remarks/:id`	Returns a `404` if the remark belongs to a driver outside the API key's Groups.
`remarks`	`DELETE`	`/v1/remarks/:id`	Returns a `404` if the remark belongs to a driver outside the API key's Groups.
`safety_ai_coach`	`PUT`	`/v1/safety_ai_coach/recaps/:id/reviewed`	Returns a `404` if the recap belongs to a driver outside the API key's Groups.
`scorecard_summary`	`GET`	`/v1/scorecard_summary`	Results are limited to drivers in the API key's Groups.
`speeding_events`	`GET`	`/v1/speeding_events`	Only speeding events for drivers and vehicles in the API key's Groups are returned.
`tachograph`	`GET`	`/v1/tachograph/driver-files/:driver_card_number`	Group-scoped according to the audit.
`tachograph`	`GET`	`/v1/tachograph/vehicle-files`	Group-scoped according to the audit.
`time_tracking`	`GET`	`/v1/time_tracking/worked_time`	Only worked time for drivers in the API key's Groups is returned.
`time_tracking`	`GET`	`/v1/time_tracking/timecard_entries`	Only timecard entries for drivers in the API key's Groups are returned.
`time_tracking`	`POST`	`/v1/time_tracking/timecard_entries`	The request is rejected if the driver is not in the API key's Groups.
`time_tracking`	`PUT`	`/v1/time_tracking/timecard_entries`	The request is rejected if the driver is not in the API key's Groups.
`users`	`GET`	`/v1/users`	Only drivers in the API key's Groups are returned. Non-driver roles, such as fleet managers and admins, are always returned regardless of Groups.
`users`	`GET`	`/v1/users/lookup`	Only drivers in the API key's Groups are matched. Non-driver roles are always included.
`users`	`GET`	`/v1/users/lookup_by_external_id`	Returns a `404` if the user is a driver outside the API key's Groups.
`users`	`GET`	`/v1/users/:id`	Returns a `404` if the user is a driver outside the API key's Groups.
`users`	`PUT`	`/v1/users/:id`	Returns a `404` if the user is a driver outside the API key's Groups.
`users`	`PUT`	`/v4/users/:id`	Returns a `404` if the user is a driver outside the API key's Groups.
`users`	`PUT`	`/v3/users/:id`	Returns a `404` if the user is a driver outside the API key's Groups.
`vehicle_fuel_performance`	`GET`	`/v1/vehicle_fuel_performance`	Results are limited to vehicles covered by both the `group_ids` parameter and the API key. The narrower set applies.
`vehicle_locations`	`GET`	`/v1/vehicle_locations`	Only locations for vehicles in the API key's Groups are returned.
`vehicle_locations`	`GET`	`/v2/vehicle_locations`	Only locations for vehicles in the API key's Groups are returned.
`vehicle_locations`	`GET`	`/v3/vehicle_locations`	Only locations for vehicles in the API key's Groups are returned.
`vehicle_locations`	`GET`	`/v1/vehicle_locations/:vehicle_id`	Returns a `404` if the vehicle is not in the API key's Groups.
`vehicle_locations`	`GET`	`/v2/vehicle_locations/:vehicle_id`	Returns a `404` if the vehicle is not in the API key's Groups.
`vehicle_locations`	`GET`	`/v3/vehicle_locations/:vehicle_id`	Returns a `404` if the vehicle is not in the API key's Groups.
`vehicle_utilization`	`GET`	`/v1/vehicle_utilization`	Only utilization data for vehicles in the API key's Groups is returned.
`vehicle_utilization`	`GET`	`/v2/vehicle_utilization`	Only utilization data for vehicles in the API key's Groups is returned.
`vehicles`	`GET`	`/v1/vehicles`	Only vehicles in the API key's Groups are returned.
`vehicles`	`GET`	`/v1/vehicles/lookup`	Only vehicles in the API key's Groups are matched.
`vehicles`	`GET`	`/v1/vehicles/lookup_by_external_id`	Returns a `404` if the vehicle is not in the API key's Groups.
`vehicles`	`GET`	`/v1/vehicles/:id`	Returns a `404` if the vehicle is not in the API key's Groups.
`vehicles`	`GET`	`/v1/vehicles/:id/last_active`	Returns a `404` if the vehicle is not in the API key's Groups.
`vehicles`	`PUT`	`/v1/vehicles/:id`	Returns a `404` if the vehicle is not in the API key's Groups.
`video_recall_requests`	`GET`	`/v1/video_recall_requests/quota`	Quota is calculated only for vehicles or assets in the API key's Groups.
`video_recall_requests`	`GET`	`/v1/video_recall_requests/:id`	Returns a `404` if the recall request is for an entity outside the API key's Groups.
`video_recall_requests`	`GET`	`/v1/video_recall_requests/vehicles/available_timelines`	Returns a `404` if the vehicle is not in the API key's Groups.
`video_recall_requests`	`GET`	`/v1/video_recall_requests/assets/available_timelines`	Returns a `404` if the asset is not in the API key's Groups.
`video_recall_requests`	`POST`	`/v1/video_recall_requests`	The request is rejected if the vehicle or asset is not in the API key's Groups.
`voice_messages`	`POST`	`/v1/voice_messages/device`	Returns a `404` if the provided ELD device ID is not paired with an in-group vehicle.
`engine_immobilizers`	`POST`	`/v1/engine_immobilizers/:vehicle_id/activate`	Returns a `404` if the vehicle is not in the API key's Groups.
`engine_immobilizers`	`POST`	`/v1/engine_immobilizers/:vehicle_id/deactivate`	Returns a `404` if the vehicle is not in the API key's Groups.
`engine_immobilizers`	`GET`	`/v1/engine_immobilizers/:vehicle_id/status`	Returns a `404` if the vehicle is not in the API key's Groups.