SAsamsara
Routes

Fetch all routes

Returns multiple routes. The legacy version of this endpoint can be found at samsara.com/api-legacy.

<b>Rate limit:</b> 5 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/fleet/routes

Request

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

Query parameters

startTimestring required

A start time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).

endTimestring required

An end time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).

limitinteger

The limit for how many objects will be in the response. Default and max for this value is 512 objects.

afterstring

If specified, this should be the endCursor value 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.

includestring[]

A comma-separated list of additional fields to include in the response. Valid values: stops.actualDistanceMeters

tagIdsstring

A filter on the data based on this comma-separated list of tag IDs. Example: tagIds=1234,5678

parentTagIdsstring

A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: parentTagIds=345,678

Response

OK response.

Example response

{
  "data": [
    {
      "actualRouteEndTime": "2019-06-13T19:08:25Z",
      "actualRouteStartTime": "2019-06-13T19:08:25Z",
      "driver": {
        "id": "45646",
        "name": "Driver Bob"
      },
      "id": "342341",
      "name": "Bid 123",
      "notes": "These are my notes",
      "orgLocalTimezone": "America/Los_Angeles",
      "recurringRouteLiveSharingLinks": [
        {
          "expiresAtTime": "2020-01-27T07:06:25Z",
          "liveSharingUrl": "https://cloud.samsara.com/o/123456/fleet/viewer/address/gEAitEnnOwcv92cuPzcU",
          "name": "Name"
        }
      ],
      "scheduledRouteEndTime": "2019-06-13T19:08:25Z",
      "scheduledRouteStartTime": "2019-06-13T19:08:25Z",
      "settings": {
        "routeCompletionCondition": "arriveLastStop",
        "routeStartingCondition": "departFirstStop",
        "sequencingMethod": "scheduledArrivalTime"
      },
      "stops": [
        {
          "actualArrivalTime": "2006-01-02T15:04:05+07:00",
          "actualDepartureTime": "2006-01-02T15:04:05+07:00",
          "actualDistanceMeters": 5450,
          "address": {
            "id": "494123",
            "name": "Company Office #1"
          },
          "appointmentWindows": [
            {
              "endTime": "2019-06-13T20:08:25Z",
              "startTime": "2019-06-13T19:08:25Z"
            }
          ],
          "documents": [
            {
              "id": "494123",
              "name": "Fuel Receipt Wichita"
            }
          ],
          "enRouteTime": "2006-01-02T15:04:05+07:00",
          "eta": "2006-01-02T15:04:05+07:00",
          "forms": [
            {
              "formTemplateId": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7",
              "id": "41234",
              "isRequired": true
            }
          ],
          "id": "324231",
          "issues": [
            {
              "id": "32812"
            }
          ],
          "liveSharingUrl": "https://cloud.samsara.com/fleet/viewer/job/fleet_viewer_token",
          "locationLiveSharingLinks": [
            {
              "expiresAtTime": "2020-01-27T07:06:25Z",
              "liveSharingUrl": "https://cloud.samsara.com/o/123456/fleet/viewer/address/gEAitEnnOwcv92cuPzcU",
              "name": "Name"
            }
          ],
          "name": "Stop #1",
          "notes": "These are my notes",
          "ontimeWindowAfterArrivalMs": 300000,
          "ontimeWindowBeforeArrivalMs": 300000,
          "orders": [
            {
              "id": "018f7b62-7d55-7b9e-a92f-2a6b7ff10392",
              "taskId": "12345678"
            }
          ],
          "plannedDistanceMeters": 5200,
          "scheduledArrivalTime": "2019-06-13T19:08:25Z",
          "scheduledDepartureTime": "2019-06-13T19:08:25Z",
          "sequenceNumber": 10,
          "singleUseLocation": {
            "address": "1234 Main St, San Jose, CA",
            "latitude": 123.456,
            "longitude": 37.459,
            "radiusMeters": 100
          },
          "skippedTime": "2006-01-02T15:04:05+07:00",
          "state": "scheduled"
        }
      ],
      "tagIds": [
        "123",
        "321"
      ],
      "vehicle": {
        "id": "494123",
        "name": "Fleet Truck #1"
      }
    }
  ],
  "pagination": {
    "endCursor": "MjkY",
    "hasNextPage": true
  }
}

Changes

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