---
title: "Get Readings Definitions"
method: GET
path: "/readings/definitions"
tags: ["Readings"]
---

# Get Readings Definitions

`GET /readings/definitions`

## Request

- Base URL: `https://api.samsara.com`
- URL: `https://api.samsara.com/readings/definitions`
- Auth: HTTP bearer

An introspection endpoint for discovering the set of readings including their name, description, data type, unit, and other metadata.

Related guide: [Readings](https://developers.samsara.com/docs/readings).

 <b>Rate limit:</b> 10 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 Readings** under the Readings 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.

## Query parameters

- `after` string
- `ids` string
- `entityTypes` string

## Response `200`

OK response.

- ReadingsListReadingsDefinitionsResponseBody
  - `data` ReadingDefinitionResponseBody[], required: A list of reading definitions.
    - `category` string, required: The category enumeration that this reading belongs to.
    - `description` string, required: The human readable description for this reading. Translated to English.
    - `entityType` string, required: Entity type of this reading.
    - `enumValues` EnumValueResponseBody[]: Array of enumeration values
      - `label` string, required: The label for this enum value that is suitable to show to a user. Translated to english.
      - `symbol` string, required: The symbol that can be used to represent this enumeration value.
    - `grouping` ReadingGroupingResponseBody: The grouping this reading belongs to. Readings sharing a grouping measure the same property across different positions or components.
      - `id` string, required: The ID of the grouping.
      - `label` string, required: The label for the grouping that is suitable to show to a user. Translated to English.
    - `ingestionEnabled` boolean, required: Indicates whether this reading can be ingested using the API.
    - `label` string, required: The label for this reading that is suitable to show to a user. Translated to English.
    - `readingId` string, required: The ID of the reading used to fetch time series data in other endpoints.
    - `type` string, required: The type information for the reading. Contains the complete type structure including dataType, unit, enumValues, fields, etc.
  - `pagination` GoaPaginationResponseResponseBody, required: Pagination parameters.
    - `endCursor` string, required: Cursor identifier representing the last element in the response. This value should be used in conjunction with a subsequent request's 'after' query parameter. This may be an empty string if there are no more pages left to view.
    - `hasNextPage` boolean, required: True if there are more pages of results immediately available after this endCursor.

## Other responses

- `401`: Unauthorized response.
- `404`: Not Found response.
- `405`: Method Not Allowed response.
- `413`: Content Too Large response.
- `429`: Too Many Requests response.
- `500`: Internal Server Error response.
- `501`: Not Implemented response.
- `502`: Bad Gateway response.
- `503`: Service Unavailable response.
- `504`: Gateway Timeout response.
- `default`: Bad Request response.

---

[API](https://skmtc.dev/samsara/apis/samsara-api.md) - [All operations](https://skmtc.dev/samsara/apis/samsara-api/llms.txt) - [OpenAPI document](https://skmtc.dev/samsara/apis/samsara-api/revisions/a9e35d4999be?raw)