SAsamsara
Documents

Fetch all documents

Get all documents for the given time range. 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 Documents 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/documents

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).

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.

documentTypeIdstring

ID of the document template type.

queryBystring

Query by document creation time (created) or updated time (updated). Defaults to created.

Response

OK response.

Example response

{
  "data": [
    {
      "conditionalFieldSections": [
        {
          "conditionalFieldFirstIndex": 8217465358527716000,
          "conditionalFieldLastIndex": 1543582388420605000,
          "triggeringFieldIndex": 7540159348423735000,
          "triggeringFieldValue": "Optiona 1"
        }
      ],
      "createdAtTime": "2015-09-08T06:33:15Z",
      "documentType": {
        "id": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7",
        "name": "Fleet Truck List"
      },
      "driver": {
        "id": "45646",
        "name": "Driver Bob"
      },
      "fields": [
        {
          "label": "Load weight",
          "type": "photo",
          "value": {
            "barcodeValue": [
              {
                "barcodeType": "org.gs1.EAN-13",
                "barcodeValue": "0853883003114"
              }
            ],
            "dateTimeValue": {
              "dateTime": "1973-12-20T17:06:49Z"
            },
            "multipleChoiceValue": [
              {
                "value": "Yes"
              }
            ],
            "numberValue": 123.456,
            "photoValue": [
              {
                "id": "f5271458-21f9-4a9f-a290-780c6d8840ff",
                "url": "https://samsara-driver-media-upload.s3.us-west-2.amazonaws.com/123456"
              }
            ],
            "scannedDocumentValue": [
              {
                "id": "f5271458-21f9-4a9f-a290-780c6d8840ff",
                "url": "https://samsara-driver-media-upload.s3.us-west-2.amazonaws.com/123456"
              }
            ],
            "signatureValue": {
              "id": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7",
              "name": "John Smith",
              "signedAtTime": "1989-09-25T02:38:09Z",
              "url": "https://samsara-driver-media-upload.s3.us-west-2.amazonaws.com/123456"
            },
            "stringValue": "Red Truck"
          }
        }
      ],
      "id": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7",
      "name": "Dropoff Slip 123",
      "notes": "Missing a crate",
      "route": {
        "id": "131313",
        "name": "Pineapple delivery"
      },
      "routeStop": {
        "id": "494123",
        "name": "Company Warehouse #1"
      },
      "state": "submitted",
      "updatedAtTime": "1975-05-20T03:23:39Z",
      "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.