SAsamsara
Live Sharing Links

Get Live Sharing Links

Returns all non-expired Live Sharing Links.

<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 Live Sharing Links 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/live-shares

Request

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

Query parameters

idsstring[]

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

type'all' | 'assetsLocation' | 'assetsNearLocation' | 'assetsOnRoute'

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

limitinteger

The limit for how many objects will be in the response. Default and max for this value is 100 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.

Response

OK response.

Example response

{
  "data": [
    {
      "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",
      "id": "leesdwqjx42dkvp86so",
      "liveSharingUrl": "https://cloud.samsara.com/o/123456/fleet/viewer/address/7hf4lnu455wep22rtun",
      "name": "Example Live Sharing Link name",
      "type": "assetsLocation"
    }
  ],
  "pagination": {
    "endCursor": "MjkY",
    "hasNextPage": true
  }
}

Changes

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