---
title: "List models"
method: GET
path: "/v1/models"
tags: ["Models"]
---

# List models

`GET /v1/models`

Retrieves a paginated list of models with their metadata.

## Query parameters

- `baseModelId` string
- `connectionId` string
- `includeDeleted` boolean
- `modelId` string
- `modelKind` 'SCHEMA' | 'SHARED' | 'SHARED_EXTENSION' | 'WORKBOOK' | 'BRANCH' | 'QUERY' | 'TOPIC' | 'FIELD_PICKER_TOPIC'
- `name` string
- `pageSize` integer
- `cursor` string
- `sortDirection` 'asc' | 'desc'
- `sortField` 'name' | 'modelKind' | 'connectionId' | 'baseModelId' | 'createdAt' | 'updatedAt'
- `include` 'activeBranches'

## Response `200`

Paginated model list

- object
  - `pageInfo` PageInfo — Pagination information for paginated responses.
    - `hasNextPage` boolean — Indicates if there are more records available.
    - `nextCursor` string, nullable — Cursor for the next page of results. `null` if no more results.
    - `pageSize` integer — Number of records per page.
    - `totalRecords` integer — Total number of records matching the query.
  - `records` object[] — List of model records.
    - `id` string, uuid — ID of the model.
    - `baseModelId` string, uuid, nullable — ID of the base model, if applicable.
    - `connectionId` string, uuid, nullable — ID of the connection the model is based on.
    - `modelKind` string, nullable — The type of model.
    - `name` string, nullable — The name of the model.
    - `createdAt` string, date-time — The time the model was created.
    - `updatedAt` string, date-time — The time the model was last updated.
    - `deletedAt` string, date-time, nullable — The time the model was deleted, if applicable.
    - `branches` Model[] — List of branch models. Only included when `include=activeBranches`.
      - `id` string, uuid — ID of the model.
      - `baseModelId` string, uuid, nullable — ID of the base model, if applicable.
      - `connectionId` string, uuid, nullable — ID of the connection the model is based on.
      - `modelKind` string, nullable — The type of model.
      - `name` string, nullable — The name of the model.
      - `createdAt` string, date-time — The time the model was created.
      - `updatedAt` string, date-time — The time the model was last updated.
      - `deletedAt` string, date-time, nullable — The time the model was deleted, if applicable.

## Other responses

- `400` — Bad Request - Invalid parameters or request body
- `403` — Forbidden - Insufficient permissions
- `429` — Too Many Requests - Rate limit exceeded (60 requests/minute)

---

[API](https://skmtc.net/omni/apis/omni-api.md) · [All operations](https://skmtc.net/omni/apis/omni-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/omni/omni-api/revisions/6b02f7349d0e/schema)