[beta] List all Data Sharing Agreements
Returns every Data Sharing Agreement (DSA) your organization participates in, as either the provider or the recipient. Soft-deleted agreements are omitted. Narrow the results with the ids, statusIn, and roleIn filters, and page through large result sets with 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.
Request
- Base URLhttps://api.samsara.com
- AuthHTTP bearer
Query parameters
Comma-separated list of agreement IDs to filter by.
Comma-separated list of statuses to filter by. Valid values: pending, accepted, rejected, canceled.
Comma-separated list of roles to filter by. Valid values: provider, recipient.
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": [
{
"acceptedAtTime": "2024-01-15T11:00:00Z",
"acceptedByUserId": "678",
"canceledAtTime": "2024-01-15T11:00:00Z",
"canceledByParty": "recipient",
"canceledByUserId": "678",
"createdAtTime": "2024-01-13T10:00:00Z",
"createdByParty": "provider",
"createdByUserId": "111",
"deletedByUserId": "111",
"id": "33333333-3333-3333-3333-333333333333",
"operator": "provider",
"payer": "recipient",
"providerDataPackages": [
"safety",
"maintenance"
],
"providerOrganizationId": "123",
"recipientDataPackages": [
"telematics",
"location",
"telematics",
"all"
],
"recipientOrganizationId": "456",
"rejectedAtTime": "2024-01-15T11:00:00Z",
"rejectedByUserId": "678",
"status": "pending",
"updatedAtTime": "2024-01-13T10:00:00Z"
}
],
"pagination": {
"endCursor": "MjkY",
"hasNextPage": true
}
}Changes
No recorded changes to this operation across all 1 revision of this API.