Beta APIs

[beta] List shared assets for an agreement

Returns shared asset records under a Data Sharing Agreement, identified by the dsaId query parameter. Results may include ended or historical sharing records; use each record's startTime and endTime to determine whether sharing is currently active. Supports cursor pagination.

<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 Asset Sharing under the Asset Sharing 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/asset-sharing/agreements/assets

Request

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

Query parameters

dsaIdstring required

The unique identifier of the Data Sharing Agreement.

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": [
    {
      "createdAtTime": "2024-01-13T10:00:00Z",
      "createdByUserId": "111",
      "endTime": "2025-01-13T10:00:00Z",
      "id": "11111111-1111-1111-1111-111111111111",
      "providerAssetId": "1234567890",
      "recipientAssetId": "9876543210",
      "serial": "GVJC-3VX-XXX",
      "startTime": "2024-01-13T10:00:00Z"
    }
  ],
  "pagination": {
    "endCursor": "MjkY",
    "hasNextPage": true
  }
}

Changes

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