Retrieve an attribute
Fetch an attribute by id, including all of its applications.
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.
To use this endpoint, select Read Attributes under the Setup & Administration 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>
Request
- Base URLhttps://api.samsara.com
- AuthHTTP bearer
Path parameters
Samsara-provided UUID of the attribute.
Query parameters
Denotes the type of entity, driver, asset, or workOrder. workOrder requires work order attributes to be enabled for the organization.
Response
The attribute corresponding to request id.
Example response
{
"data": {
"attributeType": "single-select",
"entityType": "asset",
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "License Certifications",
"unit": "METER",
"values": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"stringValue": "CDL"
}
],
"entities": [
{
"externalIds": {
"maintenanceId": "250020",
"payrollId": "ABFS18600"
},
"values": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"stringValue": "CDL"
}
]
}
]
}
}Changes
No recorded changes to this operation across all 1 revision of this API.