SAsamsara
Routes

List routes for a specific plan

Retrieve routes for a specific plan.

<b>Rate limit:</b> 10 requests/sec (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).

To use this endpoint, select Read Routes under the Driver Workflow category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>

Submit Feedback: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.

get/hub/plan/routes

Request

  • Base URL
    https://api.samsara.com
  • Auth
    HTTP bearer

Query parameters

planIdstring required

The plan identifier

routeIdsstring

Comma-separated list of route IDs for filtering.

startTimestring date-time

Time filter of when the route was updated, in RFC 3339 format

endTimestring date-time

Time filter of when the route was updated, in RFC 3339 format

afterstring

If specified, should be the endCursor from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.

limitinteger

Maximum number of objects to return. Default and maximum is 100

Response

OK response.

Example response

{
  "data": [
    {
      "cost": 125.5,
      "createdAt": "2024-04-10T10:30:00Z",
      "dispatchRouteId": "123456",
      "distanceMeters": 15420,
      "driver": {
        "id": "12345",
        "name": "Driver Bob"
      },
      "durationSeconds": 3600,
      "hubId": "550e8400-e29b-41d4-a716-446655440000",
      "id": "950e8400-e29b-41d4-a716-446655440005",
      "name": "Route 1",
      "orgLocationTimezone": "America/Los_Angeles",
      "planId": "850e8400-e29b-41d4-a716-446655440003",
      "quantities": [
        {
          "capacityId": "f1e2d3c4-b5a6-9870-fedc-ba0987654321",
          "quantity": 750
        }
      ],
      "scheduledRouteEndTime": "2019-06-13T19:08:25Z",
      "scheduledRouteStartTime": "2024-04-10T08:00:00Z",
      "stops": [
        {
          "hubLocationId": "d4e5f6a7-b8c9-0123-defa-456789012345",
          "id": "c3d4e5f6-a7b8-9012-cdef-345678901234",
          "name": "Stop 1",
          "orders": [
            {
              "customProperties": [
                {
                  "id": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
                  "name": "CustomerType",
                  "value": "Premium"
                }
              ],
              "customerLocationId": "LOC-12345",
              "id": "e5f6a7b8-c9d0-1234-efab-567890123456",
              "quantities": [
                {
                  "capacityId": "f1e2d3c4-b5a6-9870-fedc-ba0987654321",
                  "quantity": 750
                }
              ],
              "requiredSkills": [
                {
                  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
                  "name": "Forklift Operation"
                }
              ],
              "serviceWindow": "9:00AM - 5:00PM",
              "type": "pickup"
            }
          ],
          "scheduledArrivalTime": "2024-04-10T09:00:00Z",
          "scheduledDepartureTime": "2024-04-10T09:30:00Z",
          "singleUseLocation": {
            "address": "1234 Main St, San Jose, CA",
            "latitude": 123.456,
            "longitude": 37.459
          }
        }
      ],
      "type": "dynamic",
      "updatedAt": "2024-04-10T10:30:00Z",
      "vehicle": {
        "id": "67890",
        "name": "Fleet Truck #1"
      }
    }
  ],
  "pagination": {
    "endCursor": "YXJyYXljb25uZWN0aW9uOjEwMA=="
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.