SAsamsara
Attributes

List all attributes by entity type

Fetch all attributes in an organization associated with drivers, assets, or work orders.

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>

get/attributes

Request

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

Query parameters

entityType'driver' | 'asset' | 'workOrder' required

Denotes the type of entity, driver, asset, or workOrder. workOrder requires work order attributes to be enabled for the organization.

limitinteger

The limit for how many objects will be in the response. Default and max for this value is 512 objects.

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

All attributes in an organization for an entity type

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"
        }
      ]
    }
  ],
  "pagination": {
    "endCursor": "MjkY",
    "hasNextPage": true
  }
}

Changes

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