SAsamsara
Beta APIs

[beta] List devices.

Returns all installed cameras (CM3x, AIM4, AHD1), vehicle gateways (VGs), asset gateways (AGs), and asset tags (AT11–AT13) and their health information within an organization.

Beta: This endpoint is in beta and is likely to change before being broadly available. Reach out to your Samsara Representative to have Devices API enabled for your organization.

<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 Devices under the Devices 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/devices

Request

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

Query parameters

modelsstring[]

Optional string of comma separated device models. Valid values: CM31, CM32, CM33, CM34, VG34, VG34M, VG34EU, VG34FN, VG54NA, VG54EU, VG55NA, VG55EU, AG24, AG24EU, AG26, AG26EU, AG45, AG45EU, AG46, AG46EU, AG46P, AG46PEU, AG51, AG51EU, AG52, AG52EU, AG53, AG53EU, AT11, AT11X, AT12, AT12X, AT13, LM11, AIM4, AHD1

healthStatusesstring[]

Optional string of comma separated device health statuses. Valid values: healthy, needsAttention, needsReplacement, dataPending.

includeHealthboolean

Optional boolean to control whether device health information is returned in the response. Defaults to false.

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.

limitinteger

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

includeTagsboolean

Optional boolean to control whether tags are returned in the response. Defaults to false.

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": [
    {
      "asset": {
        "id": "281474982859091",
        "name": "MyAsset-1234"
      },
      "health": {
        "healthDetails": {
          "bleAssetTagDetails": {
            "batteryState": "critical",
            "lastCheckInTime": "2019-06-13T19:08:25Z"
          },
          "cameraConnectorDetails": {
            "gatewayLastConnectedTime": "2019-06-13T19:08:25Z",
            "lastFiftyHoursUptimePercentage": 95.5,
            "vehicleGatewaySerial": "VG-1234-5678"
          },
          "cameraDetails": {
            "gatewayLastConnectedTime": "2019-06-13T19:08:25Z",
            "lastFiftyHoursUptimePercentage": 95.5,
            "vehicleGatewaySerial": "VG-1234-5678"
          },
          "gatewayDetails": {
            "cellConnectivity": {
              "operator": "AT&T",
              "signalBar": "1/4"
            },
            "gatewayBatteryState": "critical",
            "gatewayBatteryTemp": 25.5,
            "gatewayBatteryVolts": 12.5,
            "lastCheckInTime": "2019-06-13T19:08:25Z",
            "vehicleBatteryVolts": 12.5
          }
        },
        "healthReasons": [
          {
            "healthReasonCode": "assetUnplugged",
            "startTime": "2019-06-13T19:08:25Z"
          }
        ],
        "healthStatus": "dataPending",
        "primaryHealthReason": "assetUnplugged",
        "primaryHealthReasonStartTime": "2019-06-13T19:08:25Z",
        "recommendedAction": "recommendedActionAgHealthy"
      },
      "lastConnectedTime": "2019-06-13T19:08:25Z",
      "lastKnownLocation": {
        "id": 12345,
        "latitude": 12333122.3,
        "longitude": 1233331.4
      },
      "model": "AG24",
      "serial": "ABCD-123-EFG",
      "tags": [
        {
          "id": "3914",
          "name": "East Coast",
          "parentTagId": "4815"
        }
      ]
    }
  ],
  "pagination": {
    "endCursor": "MjkY",
    "hasNextPage": true
  }
}

Changes

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