Skip to main content
GET
/
live-shares
Get Live Sharing Links
curl --request GET \
  --url https://api.samsara.com/live-shares \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "leesdwqjx42dkvp86so",
      "liveSharingUrl": "https://cloud.samsara.com/o/123456/fleet/viewer/address/7hf4lnu455wep22rtun",
      "name": "Example Live Sharing Link name",
      "type": "assetsLocation",
      "assetsLocationLinkConfig": {
        "assetId": "1234",
        "location": {
          "formattedAddress": "1990 Alameda Street, San Francisco, CA 94103",
          "latitude": 37.456345,
          "longitude": 34.5633749,
          "name": "Suburbs"
        },
        "tags": [
          {
            "id": "3914",
            "name": "East Coast",
            "parentTagId": "4815"
          }
        ]
      },
      "assetsNearLocationLinkConfig": {
        "addressId": "1234"
      },
      "assetsOnRouteLinkConfig": {
        "recurringRouteId": "1234"
      },
      "description": "Sample description",
      "expiresAtTime": "2020-01-27T07:06:25Z"
    }
  ],
  "pagination": {
    "endCursor": "MjkY",
    "hasNextPage": true
  }
}

Documentation Index

Fetch the complete documentation index at: https://samsara-showcase.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
ids
string[]

A filter on the data based on this comma-separated list of Live Share Link IDs

​
type
enum<string>
default:all

A filter on the data based on the Live Sharing Link type. Valid values: all, assetsLocation, assetsNearLocation, assetsOnRoute

Available options:
all,
assetsLocation,
assetsNearLocation,
assetsOnRoute
​
limit
integer
default:100

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

Required range: 1 <= x <= 100
​
after
string

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.

Response

OK response.

​
data
object[]
required
​
pagination
object
required

Pagination parameters.