---
title: "Get Live Sharing Links"
method: GET
path: "/live-shares"
tags: ["Live Sharing Links"]
---

# Get Live Sharing Links

`GET /live-shares`

## Request

- Base URL: `https://api.samsara.com`
- URL: `https://api.samsara.com/live-shares`
- Auth: HTTP bearer

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.

## Query parameters

- `ids` string[]
- `type` 'all' | 'assetsLocation' | 'assetsNearLocation' | 'assetsOnRoute'
- `limit` integer
- `after` string

## Response `200`

OK response.

- LiveSharingLinksGetLiveSharingLinksResponseBody
  - `data` LiveSharingLinkFullResponseObjectResponseBody[], required
    - `assetsLocationLinkConfig` AssetsLocationLinkResponseConfigObjectResponseBody: Configuration details specific to the 'By Asset' Live Sharing Link.
      - `assetId` string: Unique assets ID that Live Sharing Link will show.
      - `location` AssetsLocationLinkConfigAddressDetailsObjectResponseBody: Location object that indicates what address information (destination point and/or ETA) will be shown by Live Sharing Link.
        - `formattedAddress` string, required: Formatted address of a location
        - `latitude` number, double, required: Latitude of a location
        - `longitude` number, double, required: Longitude of a location
        - `name` string, required: Name of a location
      - `tags` GoaTagTinyResponseResponseBody[]: The list of [tags](https://kb.samsara.com/hc/en-us/articles/360026674631-Using-Tags-and-Tag-Nesting) associated with assets for Live Sharing Link. Only populated if the link is configured for by tags instead of by asset ID.
        - `id` string, required: ID of the tag
        - `name` string, required: Name of the tag.
        - `parentTagId` string: If this tag is part a hierarchical tag tree, this is the ID of the parent tag, otherwise this will be omitted.
    - `assetsNearLocationLinkConfig` AssetsNearLocationLinkConfigObjectResponseBody: Configuration details specific to the 'By Location' Live Sharing Link.
      - `addressId` string, required: ID of the address. Can be either a unique Samsara ID or an external ID for the address.
    - `assetsOnRouteLinkConfig` AssetsOnRouteLinkConfigObjectResponseBody: Configuration details specific to the 'By Recurring Route' Live Sharing Link.
      - `recurringRouteId` string, required: Samsara ID of the recurring route.
    - `description` string: Description for the Live Sharing Link (not applicable for 'assetsOnRoute' type).
    - `expiresAtTime` string: Date that this link expires, in RFC 3339 format.
    - `id` string, required: Unique identifier for the Live Sharing Link.
    - `liveSharingUrl` string, required: The shareable URL of the vehicle's location.
    - `name` string, required: Name of the Live Sharing Link.
    - `type` 'assetsLocation' | 'assetsNearLocation' | 'assetsOnRoute', required: Type of the Live Sharing Link. Valid values: `assetsLocation`, `assetsNearLocation`, `assetsOnRoute`
  - `pagination` GoaPaginationResponseResponseBody, required: Pagination parameters.
    - `endCursor` string, required: Cursor identifier representing the last element in the response. This value should be used in conjunction with a subsequent request's 'after' query parameter. This may be an empty string if there are no more pages left to view.
    - `hasNextPage` boolean, required: True if there are more pages of results immediately available after this endCursor.

## Other responses

- `401`: Unauthorized response.
- `404`: Not Found response.
- `405`: Method Not Allowed response.
- `413`: Content Too Large response.
- `429`: Too Many Requests response.
- `500`: Internal Server Error response.
- `501`: Not Implemented response.
- `502`: Bad Gateway response.
- `503`: Service Unavailable response.
- `504`: Gateway Timeout response.
- `default`: Bad Request response.

---

[API](https://skmtc.dev/samsara/apis/samsara-api.md) - [All operations](https://skmtc.dev/samsara/apis/samsara-api/llms.txt) - [OpenAPI document](https://skmtc.dev/samsara/apis/samsara-api/revisions/a9e35d4999be?raw)