Skip to main content

​
v1 Resource Matrix

ResourceCollectionItemRequired scopes
VehiclesGET, POSTGET, PUT, DELETEvehicles:read, vehicles:write
Vehicle FieldsGETGET /vehicle-fields/{id}/vehiclesvehicle-fields:read
Vehicle GroupsGET, POSTGET, PUT, DELETEvehicle-groups:read, vehicle-groups:write
Inspection TemplatesGET, POSTGET, PUT, DELETEinspection-templates:read, inspection-templates:write
InspectionsGET, POSTGET, PATCH, DELETEinspections:read, inspections:write
DamagesGET, POSTGET, PUT, DELETEdamages:read, damages:write
Driver AssignmentsGET, POSTGET, PATCH, DELETEdriver-assignments:read, driver-assignments:write

​
Legacy Compatibility

The original v1 coarse scopes still work:
  • vehicles:read also covers read access for vehicle-groups, damages, and driver-assignments
  • vehicles:read also covers read access for vehicle-fields
  • vehicles:write also covers write access for those resources
  • inspections:read also covers read access for inspection-templates
  • inspections:write also covers write access for inspection-templates
New integrations should use the narrower resource-family scopes.

​
Delete Semantics

ResourceDelete behavior
VehiclesSoft-delete. Subsequent reads reflect the deleted state.
Vehicle GroupsHard-delete, but only after the group is empty.
Inspection TemplatesHard-delete. Use force=true when the template already has inspections.
InspectionsHard-delete. Intended for correction and rollback flows.
DamagesHard-delete. Prefer status updates for ordinary repair lifecycle changes.
Driver AssignmentsRelease transition. DELETE records returnedAt and preserves history.

​
Notes

  • Every collection route supports page and limit.
  • Every mutation route validates company scope before it writes.
  • All responses use the standard data, meta, and errors envelope.