> ## Documentation Index
> Fetch the complete documentation index at: https://docs.mirurobotics.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List

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

| Scope | Required |
| - | - |
| `calibrations:read` | Yes |


## OpenAPI

````yaml /references/platform-api/2026-10-29.yaml get /calibrations
openapi: 3.0.3
info:
  title: Miru Platform API
  description: The API between Miru and any external client
  version: 2026-10-29.everglades
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
  x-release-version: 2026-10-29.everglades
  x-git-commit:
    sha: fa872feb1c97431ace4e4f5636eea0856b5d73f3
    url: >-
      https://github.com/mirurobotics/openapi/commit/fa872feb1c97431ace4e4f5636eea0856b5d73f3
    message: >-
      feat(platform)!: name calibration components, roles and aspects by slug
      (#387)
    author: Ben's Agent
    branch: HEAD
    dirty: false
  x-build:
    built_at: '2026-10-29T05:41:56.762337+00:00'
servers:
  - url: https://api.mirurobotics.com/beta
    description: Miru Platform API
security:
  - ApiKeyAuth: []
paths:
  /calibrations:
    parameters:
      - $ref: '#/components/parameters/MiruVersion'
    get:
      tags:
        - Calibrations
      summary: List
      description: >-
        List calibrations. By default, results are ordered by `created_at`
        descending, with ties broken by `id`.
      operationId: listCalibrations
      parameters:
        - $ref: '#/components/parameters/offset'
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/calibration_order_bys'
        - $ref: '#/components/parameters/calibration_list_expansions'
        - $ref: '#/components/parameters/calibration_search_device_id'
        - $ref: '#/components/parameters/calibration_search_component'
        - $ref: '#/components/parameters/calibration_search_role'
        - $ref: '#/components/parameters/calibration_search_aspect'
        - $ref: '#/components/parameters/calibration_search_serial_number'
        - $ref: '#/components/parameters/calibration_search_report_id'
      responses:
        '200':
          description: Successfully listed the calibrations.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CalibrationList'
components:
  parameters:
    MiruVersion:
      name: Miru-Version
      in: header
      required: true
      schema:
        type: string
        example: 2026-10-29.everglades
      description: The API version the client was built against.
    offset:
      name: offset
      in: query
      required: false
      description: >-
        The offset of the items to return. An offset of 10 with a limit of 10
        returns items 11-20.
      schema:
        type: integer
        default: 0
        minimum: 0
        example: 0
    limit:
      name: limit
      in: query
      required: false
      description: >-
        The maximum number of items to return. A limit of 15 with an offset of 0
        returns items 1-15.
      schema:
        type: integer
        default: 10
        minimum: 1
        maximum: 100
        example: 10
    calibration_order_bys:
      name: order_by
      in: query
      required: false
      style: form
      explode: false
      description: Sort order for the calibration results.
      schema:
        type: array
        items:
          $ref: '#/components/schemas/CalibrationOrderBy'
        example:
          - created_at:desc
    calibration_list_expansions:
      name: expand
      in: query
      required: false
      description: Fields to expand on each calibration in the list.
      schema:
        type: array
        items:
          $ref: '#/components/schemas/CalibrationListExpansion'
        example:
          - content
    calibration_search_device_id:
      name: device_id
      in: query
      required: false
      style: form
      explode: false
      description: The device IDs to filter by.
      schema:
        type: array
        items:
          type: string
        example:
          - dvc_123
    calibration_search_component:
      name: component
      in: query
      required: false
      style: form
      explode: false
      description: The component slugs to filter by.
      schema:
        type: array
        items:
          type: string
        example:
          - arm
    calibration_search_role:
      name: role
      in: query
      required: false
      style: form
      explode: false
      description: >-
        The role slugs to filter by. Role slugs are unique only within a
        component, so filter by component too to match one component's role.
      schema:
        type: array
        items:
          type: string
        example:
          - front-left
    calibration_search_aspect:
      name: aspect
      in: query
      required: false
      style: form
      explode: false
      description: >-
        The aspect slugs to filter by. Aspect slugs are unique only within a
        component, so filter by component too to match one component's aspect.
      schema:
        type: array
        items:
          type: string
        example:
          - pose
    calibration_search_serial_number:
      name: serial_number
      in: query
      required: false
      style: form
      explode: false
      description: The unit serial numbers to filter by.
      schema:
        type: array
        items:
          type: string
        example:
          - SN-1234
    calibration_search_report_id:
      name: report_id
      in: query
      required: false
      style: form
      explode: false
      description: The report IDs to filter by.
      schema:
        type: array
        items:
          type: string
        example:
          - 0b6f3c2e-6a51-4e0f-9a43-2f1d7c9e8b10
  schemas:
    CalibrationList:
      title: Calibration List
      allOf:
        - $ref: '#/components/schemas/PaginatedList'
        - type: object
          required:
            - data
          properties:
            data:
              type: array
              items:
                $ref: '#/components/schemas/Calibration'
              description: The list of calibrations.
    CalibrationOrderBy:
      type: string
      enum:
        - id:asc
        - id:desc
        - created_at:asc
        - created_at:desc
        - reported_at:asc
        - reported_at:desc
      x-enum-varnames:
        - CALIBRATION_ORDER_BY_ID_ASC
        - CALIBRATION_ORDER_BY_ID_DESC
        - CALIBRATION_ORDER_BY_CREATED_AT_ASC
        - CALIBRATION_ORDER_BY_CREATED_AT_DESC
        - CALIBRATION_ORDER_BY_REPORTED_AT_ASC
        - CALIBRATION_ORDER_BY_REPORTED_AT_DESC
      default: created_at:desc
    CalibrationListExpansion:
      type: string
      enum:
        - content
        - total_count
      x-enum-varnames:
        - CALIBRATION_LIST_EXPAND_CONTENT
        - CALIBRATION_LIST_EXPAND_TOTAL_COUNT
    PaginatedList:
      title: Paginated List
      type: object
      required:
        - object
        - limit
        - offset
        - has_more
      properties:
        object:
          type: string
          enum:
            - list
          example: list
          x-stainless-const: true
          description: The object type, which is always `list`.
        total_count:
          type: integer
          format: int64
          description: >-
            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:
          type: integer
          description: >-
            The maximum number of items to return. A limit of 15 with an offset
            of 0 returns items 1-15.
          default: 10
          minimum: 1
          maximum: 100
        offset:
          type: integer
          description: >-
            The offset of the items to return. An offset of 10 with a limit of
            10 returns items 11-20.
          default: 0
          minimum: 0
        has_more:
          type: boolean
          description: >-
            True if there are more items in the list to return. False if there
            are no more items to return.
          example: false
    Calibration:
      title: Calibration
      type: object
      description: >-
        One calibration reported by a device for a unit of a component.
        Calibrations are immutable and append-only; a device's history is kept
        per component, role, and aspect. Content is at most 1 MiB.
      required:
        - object
        - id
        - device_id
        - component
        - role
        - aspect
        - serial_number
        - digest
        - report_id
        - reported_at
        - created_at
      properties:
        object:
          type: string
          enum:
            - calibration
          example: calibration
          x-stainless-const: true
          description: The object type, which is always `calibration`.
        id:
          type: string
          example: cal_123
          description: ID of the calibration, generated by Miru.
        device_id:
          type: string
          example: dvc_123
          description: ID of the device that reported the calibration.
        component:
          type: string
          example: arm
          description: >-
            Slug of the component the calibrated unit belongs to, as it was
            reported.
        role:
          type: string
          nullable: true
          example: front-left
          description: >-
            Slug of the role the calibrated unit fills on the device, as it was
            reported; null if no role was reported.
        aspect:
          type: string
          nullable: true
          example: pose
          description: >-
            Slug of the aspect of the unit that was calibrated, as it was
            reported; null if no aspect was reported.
        serial_number:
          type: string
          nullable: true
          maxLength: 255
          example: SN-1234
          description: >-
            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:
          type: string
          example: >-
            sha256:e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855
          description: >-
            Digest of the content, formatted as `sha256:` followed by 64
            lowercase hex characters.
        report_id:
          type: string
          format: uuid
          example: 0b6f3c2e-6a51-4e0f-9a43-2f1d7c9e8b10
          description: ID the agent gave the report this calibration came from.
        reported_at:
          type: string
          format: date-time
          example: '2021-01-01T00:00:00Z'
          description: >-
            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:
          type: string
          format: date-time
          example: '2021-01-01T00:00:00Z'
          description: Timestamp of when Miru recorded the calibration.
        content:
          allOf:
            - $ref: '#/components/schemas/InstanceContent'
          description: >-
            The calibration's content. Expand using `expand=content` in the
            query string.
      example:
        object: calibration
        id: cal_123
        device_id: dvc_123
        component: arm
        role: front-left
        aspect: null
        serial_number: SN-1234
        digest: >-
          sha256:e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855
        report_id: 0b6f3c2e-6a51-4e0f-9a43-2f1d7c9e8b10
        reported_at: '2021-01-01T00:00:00Z'
        created_at: '2021-01-01T00:00:00Z'
        content:
          format: json
          data: |
            {
              "x": 0.412,
              "y": -0.087,
              "z": 0.256,
              "roll": 0.0,
              "pitch": 0.0,
              "yaw": 1.571
            }
    InstanceContent:
      title: Instance Content
      type: object
      required:
        - format
        - data
      properties:
        format:
          $ref: '#/components/schemas/InstanceFormat'
        data:
          type: string
          description: The content's values, serialized in `format`.
          example: |
            {
              "enable_autonomy": true,
              "enable_remote_control": true,
              "max_payload_kg": 10.0
            }
      example:
        format: json
        data: |
          {
            "enable_autonomy": true,
            "enable_remote_control": true,
            "max_payload_kg": 10.0
          }
    InstanceFormat:
      title: Instance Format
      type: string
      description: >
        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.
      enum:
        - json
        - yaml
        - jsonc
        - xml
        - csv
        - text
      x-enum-varnames:
        - INSTANCE_FORMAT_JSON
        - INSTANCE_FORMAT_YAML
        - INSTANCE_FORMAT_JSONC
        - INSTANCE_FORMAT_XML
        - INSTANCE_FORMAT_CSV
        - INSTANCE_FORMAT_TEXT
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: The API key to use for authentication.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.