{
"opencollection": "1.0.0",
"info": {
"name": "Samsara Assets API",
"version": "2024-11-18"
},
"request": {
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"items": [
{
"info": {
"name": "Assets",
"type": "folder"
},
"items": [
{
"info": {
"name": "List All Assets",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.samsara.com/industrial/assets",
"params": [
{
"name": "limit",
"value": "",
"type": "query",
"description": "The limit for how many objects will be in the response. Default and max for this value is 512 objects."
},
{
"name": "after",
"value": "",
"type": "query",
"description": "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."
},
{
"name": "parentTagIds",
"value": "",
"type": "query",
"description": "A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`"
},
{
"name": "tagIds",
"value": "",
"type": "query",
"description": "A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`"
},
{
"name": "assetIds",
"value": "",
"type": "query",
"description": "A comma-separated list of industrial asset UUIDs. Example: `assetIds=076efac2-83b5-47aa-ba36-18428436dcac,6707b3f0-23b9-4fe3-b7be-11be34aea544`"
}
]
},
"docs": "List all assets in the organization. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.\n\nTo use this endpoint, select **Read Equipment** under the Equipment category when creating or edi"
},
{
"info": {
"name": "Create an Asset",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.samsara.com/industrial/assets",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create an asset with optional configuration parameters. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.\n\nTo use this endpoint, select **Write Equipment** under the Equipment category "
},
{
"info": {
"name": "Update an Asset",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.samsara.com/industrial/assets/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Id of the asset to be updated"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update an existing asset. Only the provided fields will be updated. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.\n\nTo use this endpoint, select **Write Equipment** under the Equipme"
},
{
"info": {
"name": "Delete an Existing Asset",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.samsara.com/industrial/assets/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Id of the asset to be deleted."
}
]
},
"docs": "Delete asset. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.\n\nTo use this endpoint, select **Write Equipment** under the Equipment category when creating or editing an API token. Rate limit: 100 requests/min (learn more about rate limits here).\n\nTo use this endpoint, select **Write Equipment Statistics** under the Equipment category when creating or editing an API token. Lear"
},
{
"info": {
"name": "List All Assets",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.samsara.com/v1/fleet/assets"
},
"docs": "\n\n\nThis endpoint is still on our legacy API.\n\n\n\nFetch all of the assets. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our supp"
},
{
"info": {
"name": "List Current Location for All Assets",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.samsara.com/v1/fleet/assets/locations",
"params": [
{
"name": "startingAfter",
"value": "",
"type": "query",
"description": "Pagination parameter indicating the cursor position to continue returning results after. Used in conjunction with the 'limit' parameter. Mutually exclusive with 'endingBefore' parameter."
},
{
"name": "endingBefore",
"value": "",
"type": "query",
"description": "Pagination parameter indicating the cursor position to return results before. Used in conjunction with the 'limit' parameter. Mutually exclusive with 'startingAfter' parameter."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Pagination parameter indicating the number of results to return in this request. Used in conjunction with either 'startingAfter' or 'endingBefore'."
}
]
},
"docs": "\n\n\nThis endpoint is still on our legacy API.\n\n\n\nFetch current locations of all assets. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case"
},
{
"info": {
"name": "List Stats for All Reefers",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.samsara.com/v1/fleet/assets/reefers",
"params": [
{
"name": "startMs",
"value": "",
"type": "query",
"description": "Timestamp in milliseconds representing the start of the period to fetch, inclusive. Used in combination with endMs."
},
{
"name": "endMs",
"value": "",
"type": "query",
"description": "Timestamp in milliseconds representing the end of the period to fetch, inclusive. Used in combination with startMs."
},
{
"name": "startingAfter",
"value": "",
"type": "query",
"description": "Pagination parameter indicating the cursor position to continue returning results after. Used in conjunction with the 'limit' parameter. Mutually exclusive with 'endingBefore' parameter."
},
{
"name": "endingBefore",
"value": "",
"type": "query",
"description": "Pagination parameter indicating the cursor position to return results before. Used in conjunction with the 'limit' parameter. Mutually exclusive with 'startingAfter' parameter."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Pagination parameter indicating the number of results to return in this request. Used in conjunction with either 'startingAfter' or 'endingBefore'."
}
]
},
"docs": "\n\n\nThis endpoint is still on our legacy API.\n\n\n\nFetches all reefers and reefer-specific stats. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit "
},
{
"info": {
"name": "List Historical Locations for a Given Asset",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.samsara.com/v1/fleet/assets/:asset_id/locations",
"params": [
{
"name": "asset_id",
"value": "",
"type": "path",
"description": "ID of the asset. Must contain only digits 0-9."
},
{
"name": "startMs",
"value": "",
"type": "query",
"description": "Timestamp in milliseconds representing the start of the period to fetch, inclusive. Used in combination with endMs."
},
{
"name": "endMs",
"value": "",
"type": "query",
"description": "Timestamp in milliseconds representing the end of the period to fetch, inclusive. Used in combination with startMs."
}
]
},
"docs": "\n\n\nThis endpoint is still on our legacy API.\n\n\n\nList historical locations for a given asset. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a "
},
{
"info": {
"name": "List Stats for a Given Reefer",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.samsara.com/v1/fleet/assets/:asset_id/reefer",
"params": [
{
"name": "asset_id",
"value": "",
"type": "path",
"description": "ID of the asset. Must contain only digits 0-9."
},
{
"name": "startMs",
"value": "",
"type": "query",
"description": "Timestamp in milliseconds representing the start of the period to fetch, inclusive. Used in combination with endMs."
},
{
"name": "endMs",
"value": "",
"type": "query",
"description": "Timestamp in milliseconds representing the end of the period to fetch, inclusive. Used in combination with startMs."
}
]
},
"docs": "\n\n\nThis endpoint is still on our legacy API.\n\n\n\nFetch the reefer-specific stats of an asset. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a "
}
]
}
],
"bundled": true
}