Tags

List all tags

Return all of the tags for an organization.

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 Tags 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/tags

Request

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

Query parameters

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

List of tags.

Example response

{
  "data": [
    {
      "id": "342417",
      "name": "California",
      "parentTagId": "4815",
      "addresses": [
        {
          "id": "23502866574",
          "name": "Driver Don"
        }
      ],
      "assets": [
        {
          "id": "23502866574",
          "name": "Driver Don"
        }
      ],
      "drivers": [
        {
          "id": "23502866574",
          "name": "Driver Don"
        }
      ],
      "externalIds": {
        "maintenanceId": "250020",
        "payrollId": "ABFS18600"
      },
      "machines": [
        {
          "id": "23502866574",
          "name": "Driver Don"
        }
      ],
      "parentTag": {
        "id": "23502866574",
        "name": "US West Vehicles"
      },
      "sensors": [
        {
          "id": "23502866574",
          "name": "Driver Don"
        }
      ],
      "vehicles": [
        {
          "id": "23502866574",
          "name": "Driver Don"
        }
      ]
    }
  ],
  "pagination": {
    "endCursor": "MjkY",
    "hasNextPage": true
  }
}

Changes

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