---
title: "List"
method: GET
path: "/config_schemas"
tags: ["Config Schemas"]
---

# List

`GET /config_schemas`

List config schemas.

## Query parameters

- `offset` integer
- `limit` integer
- `order_by` ConfigSchemaOrderBy[]
- `expand` ConfigSchemaListExpansion[]
- `id` string[]
- `config_type_id` string[]

## Response `200`

Successfully listed the config schemas.

- ConfigSchemaList
  - `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` ConfigSchema[], required — The list of config schemas.
    - `object` 'config_schema', required — The object type, which is always `config_schema`.
    - `id` string, required — ID of the config schema.
    - `digest` string, required — The digest of the config schema.
    - `config_type_name` string, required — The name of the config type.
    - `instance_filepath` string, required — The absolute file system path where config instances for this schema are written.
    - `created_at` string, date-time, required — Timestamp of when the config schema was created.
    - `updated_at` string, date-time, required — Timestamp of when the config schema was last updated.
    - `config_type_id` string, required — ID of the config type.
    - `language` 'jsonschema' | 'cue', required
    - `format` 'json' | 'yaml' | 'cue', required
    - `documents` SchemaDocument[]
      - `id` string, required — The unique identifier for this document.
      - `name` string, required — The document filename.
      - `data` string, required — The raw document content.
    - `config_type` ConfigType
      - `object` 'config_type', required — The object type, which is always `config_type`.
      - `id` string, required — ID of the config type.
      - `name` string, required — Name of the config type.
      - `slug` string, required — An immutable, code-friendly name for the config type.
      - `created_at` string, date-time, required — Timestamp of when the config type was created.
      - `updated_at` string, date-time, required — Timestamp of when the config type was last updated.

---

[API](https://skmtc.dev/mirurobotics/apis/miru-api.md) · [All operations](https://skmtc.dev/mirurobotics/apis/miru-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/mirurobotics/miru-api/revisions/cd84166b2b52/schema)