---
title: "List"
method: GET
path: "/calibrations"
tags: ["Calibrations"]
---

# List

`GET /calibrations`

## Request

- Base URL: `https://api.mirurobotics.com/beta`
- URL: `https://api.mirurobotics.com/beta/calibrations`
- Auth: API key in header `X-API-Key`

List calibrations. By default, results are ordered by `created_at` descending, with ties broken by `id`.

## Query parameters

- `offset` integer
- `limit` integer
- `order_by` CalibrationOrderBy[]
- `expand` CalibrationListExpansion[]
- `device_id` string[]
- `component` string[]
- `role` string[]
- `aspect` string[]
- `serial_number` string[]
- `report_id` string[]

## Response `200`

Successfully listed the calibrations.

- CalibrationList
  - `object` 'list', required: The object type, which is always `list`.
  - `total_count` integer: The total number of items in the list. By default the total count is not returned. The total count must be expanded (using expand=total_count) to get the total number of items in the list.
  - `limit` integer, required: The maximum number of items to return. A limit of 15 with an offset of 0 returns items 1-15.
  - `offset` integer, required: The offset of the items to return. An offset of 10 with a limit of 10 returns items 11-20.
  - `has_more` boolean, required: True if there are more items in the list to return. False if there are no more items to return.
  - `data` Calibration[], required: The list of calibrations.
    - `object` 'calibration', required: The object type, which is always `calibration`.
    - `id` string, required: ID of the calibration, generated by Miru.
    - `device_id` string, required: ID of the device that reported the calibration.
    - `component` string, required: Slug of the component the calibrated unit belongs to, as it was reported.
    - `role` string, nullable, required: Slug of the role the calibrated unit fills on the device, as it was reported; null if no role was reported.
    - `aspect` string, nullable, required: Slug of the aspect of the unit that was calibrated, as it was reported; null if no aspect was reported.
    - `serial_number` string, nullable, required: Serial number of the physical unit that was calibrated, not of the device, such as `SN-1234`, or null if none was reported. Free text, at most 255 characters.
    - `digest` string, required: Digest of the content, formatted as `sha256:` followed by 64 lowercase hex characters.
    - `report_id` string, uuid, required: ID the agent gave the report this calibration came from.
    - `reported_at` string, date-time, required: Timestamp of when the calibration was reported to the agent on the device. The agent may upload it much later, for example after an outage, so this can be well before `created_at`.
    - `created_at` string, date-time, required: Timestamp of when Miru recorded the calibration.
    - `content` InstanceContent
      - `format` 'json' | 'yaml' | 'jsonc' | 'xml' | 'csv' | 'text', required: The serialization format of config content. A config instance is written to the device filesystem in this format. - `json`: standard JSON. - `yaml`: YAML 1.2. - `jsonc`: JSON with comments (JSON plus `//` and `/* */` comment syntax). - `xml`: XML. - `csv`: comma-separated values (RFC 4180). - `text`: plain, unstructured text with no specific format.
      - `data` string, required: The content's values, serialized in `format`.

---

[API](https://skmtc.dev/mirurobotics/apis/miru-platform-api.md) - [All operations](https://skmtc.dev/mirurobotics/apis/miru-platform-api/llms.txt) - [OpenAPI document](https://skmtc.dev/mirurobotics/apis/miru-platform-api/revisions/80ee5be70cc3?raw)