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

# List models

`GET /api/v1/models`

## Query parameters

- `baseModelId` string, uuid — Filter by base model ID
- `connectionId` string, uuid — Filter by connection ID
- `cursor` string — Cursor for pagination
- `include` string — Comma-separated list of fields to include (e.g., activeBranches)
- `includeDeleted` '0' | '1' | 'true' | 'false' — Include deleted models
- `modelId` string, uuid — Filter by specific model ID
- `modelKind` 'SCHEMA' | 'SHARED' | 'SHARED_EXTENSION' | 'BRANCH' | 'WORKBOOK' | 'QUERY' — Filter by model kind
- `name` string — Filter by model name
- `pageSize` integer — Number of results per page
- `sortDirection` 'asc' | 'desc' — Sort direction
- `sortField` 'name' | 'modelKind' | 'connectionId' | 'baseModelId' | 'createdAt' | 'updatedAt' — Field to sort by

## Response `200`

Paginated list of models

- ModelsListResponse
  - `pageInfo` object, required — Pagination information
    - `hasNextPage` boolean, required — Whether more results are available
    - `nextCursor` string, nullable, required — Cursor for fetching the next page
    - `pageSize` number, required — Number of results per page
    - `totalRecords` number, required — Total number of records matching the query
  - `records` object[], required — List of model records
    - `baseModelId` string, nullable, required — Base model ID for branch/extension models
    - `branches` object[] — Active branches (if include=activeBranches)
      - `id` string, required — Branch ID
      - `name` string, required — Branch name
    - `connectionId` string, nullable, required — Connection ID
    - `createdAt` string, required — Creation timestamp
    - `deletedAt` string, nullable, required — Deletion timestamp
    - `id` string, required — Model ID
    - `modelKind` string, nullable, required — Model kind
    - `name` string, nullable, required — Model name
    - `updatedAt` string, required — Last update timestamp

## Other responses

- `401` — Authentication required
- `403` — Permission denied

---

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