Get Route

Retrieve a single route record by its ID from Samsara.

Operation

getRoute

Resource

route

Parameters

Parameter	Type	Required	Default	Description
Route ID	string	Yes	-	The ID of the route to retrieve

Response

Success

{
  "id": "route_123",
  "name": "Morning Delivery Route",
  "driverId": "driver_456",
  "vehicleId": "vehicle_789",
  "notes": "Priority deliveries",
  "stops": [
    {
      "id": "stop_1",
      "name": "Customer A",
      "scheduledArrivalTime": "2024-01-15T10:00:00Z",
      "state": "scheduled"
    }
  ],
  "settings": {
    "routeStartingCondition": "arriveFirstStop",
    "routeCompletionCondition": "arriveLastStop"
  },
  "externalIds": {}
}

Error

{
  "success": false,
  "error": "Route not found",
  "routeId": "invalid_id"
}

Error Handling

• Missing API Token: Samsara credential is missing apiToken
• Route Not Found: Route with specified ID does not exist
• Permission Denied: API token lacks permission for this operation