--- title: "Retrieve a vehicle" method: GET path: "/fleet/vehicles/{id}" tags: ["Vehicles"] --- # Retrieve a vehicle `GET /fleet/vehicles/{id}` ## Request - Base URL: `https://api.samsara.com` - URL: `https://api.samsara.com/fleet/vehicles/{id}` - Auth: HTTP bearer Get information about a specific vehicle. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. To use this endpoint, select **Read Vehicles** under the Vehicles category when creating or editing an API token. Learn More. ## Path parameters - `id` string, required ## Response `200` Returns the specified vehicle object. - VehicleResponse: A single vehicle. - `data` Vehicle, required: The vehicle object. - `attributes` AttributeTiny[]: A minified attribute - `dateValues` string[]: Date values that are associated with this attribute (RFC 3339 date format: YYYY-MM-DD). - `id` string: The samsara id of the attribute object. - `name` string: Name of attribute. - `numberValues` number[]: Number values that are associated with this attribute. - `stringValues` string[]: String values that are associated with this attribute. - `auxInputType1` string: The type of auxiliary input configured for this Vehicle. Once configured, these inputs will generate dynamic, time-series data that will be available to view in the Samsara Dashboard. **By default**: empty. This can be set or updated through the Samsara Dashboard or the API at any time. Inputs 3-13 are only available on gateways with an attached aux expander. The value returned will match what is configured in the dashboard per vehicle. - `auxInputType10` string: The type of auxiliary input configured for this Vehicle. Once configured, these inputs will generate dynamic, time-series data that will be available to view in the Samsara Dashboard. **By default**: empty. This can be set or updated through the Samsara Dashboard or the API at any time. Inputs 3-13 are only available on gateways with an attached aux expander. The value returned will match what is configured in the dashboard per vehicle. - `auxInputType11` string: The type of auxiliary input configured for this Vehicle. Once configured, these inputs will generate dynamic, time-series data that will be available to view in the Samsara Dashboard. **By default**: empty. This can be set or updated through the Samsara Dashboard or the API at any time. Inputs 3-13 are only available on gateways with an attached aux expander. The value returned will match what is configured in the dashboard per vehicle. - `auxInputType12` string: The type of auxiliary input configured for this Vehicle. Once configured, these inputs will generate dynamic, time-series data that will be available to view in the Samsara Dashboard. **By default**: empty. This can be set or updated through the Samsara Dashboard or the API at any time. Inputs 3-13 are only available on gateways with an attached aux expander. The value returned will match what is configured in the dashboard per vehicle. - `auxInputType13` string: The type of auxiliary input configured for this Vehicle. Once configured, these inputs will generate dynamic, time-series data that will be available to view in the Samsara Dashboard. **By default**: empty. This can be set or updated through the Samsara Dashboard or the API at any time. Inputs 3-13 are only available on gateways with an attached aux expander. The value returned will match what is configured in the dashboard per vehicle. - `auxInputType2` string: The type of auxiliary input configured for this Vehicle. Once configured, these inputs will generate dynamic, time-series data that will be available to view in the Samsara Dashboard. **By default**: empty. This can be set or updated through the Samsara Dashboard or the API at any time. Inputs 3-13 are only available on gateways with an attached aux expander. The value returned will match what is configured in the dashboard per vehicle. - `auxInputType3` string: The type of auxiliary input configured for this Vehicle. Once configured, these inputs will generate dynamic, time-series data that will be available to view in the Samsara Dashboard. **By default**: empty. This can be set or updated through the Samsara Dashboard or the API at any time. Inputs 3-13 are only available on gateways with an attached aux expander. The value returned will match what is configured in the dashboard per vehicle. - `auxInputType4` string: The type of auxiliary input configured for this Vehicle. Once configured, these inputs will generate dynamic, time-series data that will be available to view in the Samsara Dashboard. **By default**: empty. This can be set or updated through the Samsara Dashboard or the API at any time. Inputs 3-13 are only available on gateways with an attached aux expander. The value returned will match what is configured in the dashboard per vehicle. - `auxInputType5` string: The type of auxiliary input configured for this Vehicle. Once configured, these inputs will generate dynamic, time-series data that will be available to view in the Samsara Dashboard. **By default**: empty. This can be set or updated through the Samsara Dashboard or the API at any time. Inputs 3-13 are only available on gateways with an attached aux expander. The value returned will match what is configured in the dashboard per vehicle. - `auxInputType6` string: The type of auxiliary input configured for this Vehicle. Once configured, these inputs will generate dynamic, time-series data that will be available to view in the Samsara Dashboard. **By default**: empty. This can be set or updated through the Samsara Dashboard or the API at any time. Inputs 3-13 are only available on gateways with an attached aux expander. The value returned will match what is configured in the dashboard per vehicle. - `auxInputType7` string: The type of auxiliary input configured for this Vehicle. Once configured, these inputs will generate dynamic, time-series data that will be available to view in the Samsara Dashboard. **By default**: empty. This can be set or updated through the Samsara Dashboard or the API at any time. Inputs 3-13 are only available on gateways with an attached aux expander. The value returned will match what is configured in the dashboard per vehicle. - `auxInputType8` string: The type of auxiliary input configured for this Vehicle. Once configured, these inputs will generate dynamic, time-series data that will be available to view in the Samsara Dashboard. **By default**: empty. This can be set or updated through the Samsara Dashboard or the API at any time. Inputs 3-13 are only available on gateways with an attached aux expander. The value returned will match what is configured in the dashboard per vehicle. - `auxInputType9` string: The type of auxiliary input configured for this Vehicle. Once configured, these inputs will generate dynamic, time-series data that will be available to view in the Samsara Dashboard. **By default**: empty. This can be set or updated through the Samsara Dashboard or the API at any time. Inputs 3-13 are only available on gateways with an attached aux expander. The value returned will match what is configured in the dashboard per vehicle. - `cameraSerial` string: The serial number of the camera installed in the vehicle - `esn` string: Engine serial number. - `externalIds` VehicleExternalIds: The external IDs for the given object. - `gateway` GatewayTiny: A minified gateway including serial number and model. - `model` string: The gateway model - `serial` string: The serial number of the gateway. - `grossVehicleWeight` GrossVehicleWeight: The gross weight of the vehicle in either pounds (lb) or kilograms (kg). Only returned for customers with commercial speed limits (CSL) enabled. - `unit` 'lb' | 'kg': The unit of weight for the vehicle. - `weight` integer: The weight value of the vehicle. - `harshAccelerationSettingType` 'passengerCar' | 'lightTruck' | 'heavyDuty' | 'off' | 'automatic': The harsh acceleration setting type. This setting influences the acceleration sensitivity from which a harsh event is triggered. **By default**, this setting is inferred by the Samsara Vehicle Gateway from the engine computer, but it may be set or updated through the Samsara Dashboard or the API at any time. If set to `off`, then no acceleration based harsh events are triggered for the vehicle. Valid values: `passengerCar`, `lightTruck`, `heavyDuty`, `off`, `automatic`. - `id` string, required: The unique Samsara ID of the Vehicle. This is automatically generated when the Vehicle object is created. It cannot be changed. - `licensePlate` string: The license plate of the Vehicle. **By default**: empty. Can be set or updated through the Samsara Dashboard or the API at any time. - `make` string: The Vehicle’s manufacturing make. Automatically read from the engine computer if available. Empty if not available. Cannot be manually set. - `model` string: The Vehicle’s manufacturing model. Automatically read from the engine computer if available. Empty if not available. Cannot be manually set. - `name` string: The human-readable name of the Vehicle. This is set by a fleet administrator and will appear in both Samsara’s cloud dashboard as well as the Samsara Driver mobile app. **By default**, this name is the serial number of the Samsara Vehicle Gateway. It can be set or updated through the Samsara Dashboard or through the API at any time. - `notes` string: These are generic notes about the Vehicle. Empty by default. Can be set or updated through the Samsara Dashboard or the API at any time. - `sensorConfiguration` VehicleSensorConfiguration: The sensors configured on a vehicle - `areas` VehicleSensorConfigurationArea[] - `cargoSensors` Sensor[]: Cargo sensors configured in this position of the vehicle - `id` string, required: ID of the sensor - `mac` string, required: MAC address of the sensor - `name` string, required: Name of the sensor - `humiditySensors` Sensor[]: Humidity sensors configured in this position of the vehicle - `id` string, required: ID of the sensor - `mac` string, required: MAC address of the sensor - `name` string, required: Name of the sensor - `position` 'Position_Front' | 'Position_Middle' | 'Position_Back': Position of the area on vehicle - `temperatureSensors` Sensor[]: Temperature sensors configured in this position of the vehicle - `id` string, required: ID of the sensor - `mac` string, required: MAC address of the sensor - `name` string, required: Name of the sensor - `doors` VehicleSensorConfigurationDoor[] - `position` 'Position_Left' | 'Position_Right': Position of the door monitor on the vehicle - `sensor` Sensor - `id` string, required: ID of the sensor - `mac` string, required: MAC address of the sensor - `name` string, required: Name of the sensor - `serial` string: The serial number of the gateway installed in the vehicle. - `staticAssignedDriver` DriverTinyResponse: A minified driver object. - `id` string: ID of the driver. - `name` string: Name of the driver. - `tags` TagTinyResponse[]: The list of tags associated with the Vehicle. **By default**: empty. Can be set or updated through the Samsara Dashboard or the API at any time. - `id` string: ID of the tag. - `name` string: Name of the tag. - `parentTagId` string: If this tag is part a hierarchical tag tree, this is the ID of the parent tag, otherwise this will be omitted. - `vehicleRegulationMode` 'regulated' | 'unregulated' | 'mixed': Whether or not the vehicle is regulated, unregulated (non-CMV), or a mixed use unregulated vehicle. Valid values: `regulated`, `unregulated`, `mixed`. - `vehicleType` string: The type of the vehicle. Only returned for customers with commercial speed limits (CSL) enabled. - `vin` string: The VIN of the Vehicle. Most of the time, this will be automatically read from the engine computer by the Samsara Vehicle Gateway. It will be empty if it cannot be read. It can be set or updated through the Samsara Dashboard or the API at any time. - `year` string: Year of the Vehicle. ## Other responses - `default`: Error response --- [API](https://skmtc.dev/samsara/apis/samsara-api.md) - [All operations](https://skmtc.dev/samsara/apis/samsara-api/llms.txt) - [OpenAPI document](https://skmtc.dev/samsara/apis/samsara-api/revisions/a9e35d4999be?raw)