List Routes

Retrieve all route records from Samsara with automatic pagination handling.

Operation

listRoutes

Resource

route

Parameters

This operation has no required parameters.

Options

Option	Type	Default	Description
Tag IDs	string	-	Comma-separated list of tag IDs to filter routes by
Created After Time	dateTime	-	Filter routes created after this time (RFC 3339 format)
Updated After Time	dateTime	-	Filter routes updated after this time (RFC 3339 format)
Include Debug Info	boolean	false	Whether to include metadata about the API request

Response

Success

Returns an array of route records:

{
  "id": "route_123",
  "name": "Morning Delivery Route",
  "driverId": "driver_456",
  "vehicleId": "vehicle_789",
  "stops": [],
  "settings": {}
}

With debug info enabled:

{
  "id": "route_123",
  "name": "Morning Delivery Route",
  "_metadata": {
    "totalRoutes": 25
  }
}

Error

{
  "success": false,
  "error": "API rate limit exceeded"
}

Error Handling

• Missing API Token: Samsara credential is missing apiToken
• Rate Limiting: API rate limit exceeded
• Invalid Date Format: Created/updated time is not in RFC 3339 format