---
title: "List schemas"
method: GET
path: "/api/v1/schemas"
tags: ["Schema"]
---

# List schemas

`GET /api/v1/schemas`

Retrieve all schema objects.

## Query parameters

- `page_size` integer
- `cursor` string
- `id` integer[]
- `name` string
- `queue` integer[]
- `ordering` 'id' | '-id'

## Response `200`

OK

- object
  - `pagination` Pagination, required
    - `next` string, uri, nullable — URL for the next page of results. Contains an opaque signed `cursor` query parameter. Use this URL directly to fetch the next page — do not attempt to construct or modify the cursor value.
    - `previous` string, uri, nullable — URL for the previous page of results. Contains an opaque signed `cursor` query parameter. Use this URL directly to fetch the previous page — do not attempt to construct or modify the cursor value.
  - `results` SchemaList[], required
    - `id` integer, required — ID of the schema.
    - `name` string, required — Name of the schema (not visible in UI).
    - `url` string, uri, required — URL of the schema.
    - `queues` string[], required — List of queues that use schema object.
    - `metadata` Metadata, required — Client data. May be used to store e.g. external system object IDs. See [Metadata](/guides/overview#metadata) for more details.
    - `modified_by` string, uri, nullable, required — User that last modified the object.
    - `modified_at` string, date-time, nullable, required — Timestamp of last modification.
    - `content` Section[] — Schema content: list of sections.
      - `id` string — Unique identifier of an object. Maximum length is 50 characters.
      - `label` string — User-friendly label for an object, shown in the user interface.
      - `hidden` boolean — If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
      - `disable_prediction` boolean — Can be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
      - `category` 'section'
      - `icon` string, nullable — The icon that appears on the left panel in the UI for a given section (not yet supported on UI).
      - `children` union[] — Specifies objects grouped under a given section. It may contain multivalue or datapoint objects.
        - union
          - Multivalue
            - `id` string — Unique identifier of an object. Maximum length is 50 characters.
            - `label` string — User-friendly label for an object, shown in the user interface.
            - `hidden` boolean — If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden.
            - `disable_prediction` boolean — Can be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines.
            - `category` 'multivalue'
            - `min_occurrences` integer, nullable — Minimum number of occurrences of nested objects. If condition of min_occurrences is violated corresponding fields should be manually reviewed. Minimum required value for the field is 0. If not specified, it is set to 0 by default.
            - `max_occurrences` integer, nullable — Maximum number of occurrences of nested objects. All additional rows above max_occurrences are removed by extraction process. Minimum required value for the field is 1. If not specified, it is set to 1000 by default.
            - `show_grid_by_default` boolean — If set to true, the magic-grid is opened instead of footer upon entering the multivalue. Default false. Applied only in UI. Useful when annotating documents for custom training.
            - `rir_field_names` string[], nullable — List of names used to initialize content from the AI engine predictions. If specified, the value of the first field from the array is used, otherwise default name line_items is used. Attribute can be set only for multivalue containing objects with category tuple.
            - `grid` Grid — Multivalue grid object allows to specify a row type for each row of the grid. Configure magic-grid feature properties.
              - …
            - `children` union — Object specifying type of children. It may contain only objects with categories tuple or datapoint.
              - …
          - union
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …

## Other responses

- `400` — Invalid input data.
- `401` — The username/password is invalid or token is invalid (e.g. expired).
- `403` — Insufficient permission, missing authentication, invalid CSRF token and similar issue.
- `404` — The specified resource was not found.
- `409` — Conflict
- `429` — Request rate is too high, wait before sending more requests. See [Rate Limiting](/guides/overview#rate-limiting) for more details.
- `500` — Server failure while processing the request.
- `502` — Invalid response from the upstream server.
- `503` — We're temporarily offline for maintenance. Please try again later.
- `504` — Upstream server could not complete the request in time.

---

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