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

# List Models Overview

`GET /api/v1/overview/models`

Returns a list of models from the MaaS catalog, each enriched with the K8s subscriptions
and authorization policies that reference it. Phase comes from the MaaSModelRef CR status.
Intended for admin overview pages that need to display per-model subscription and policy counts.

## Response `200`

Model overview list

- object
  - `data` ModelOverviewItem[], required
    - `id` string, required — Model identifier (matches the maas-api model ID and K8s MaaSModelRef name).
    - `namespace` string, required — Namespace of the model.
    - `modelDetails` ModelOverviewDetails — Model catalog metadata combined with the K8s MaaSModelRef phase.
      - `displayName` string — Human-readable display name from the maas-api catalog.
      - `description` string — Model description from the maas-api catalog.
      - `phase` string — Current phase of the K8s MaaSModelRef CR (e.g. Ready, Pending).
      - `statusMessage` string — Human-readable status message from the Ready condition in status.conditions
      - `reason` string — Reason from the Ready condition in status.conditions
      - `status` string — Status from the Ready condition in status.conditions (e.g. True, False, Unknown)
      - `type` string — Condition type from the Ready condition in status.conditions
      - `lastTransitionTime` string, date-time — lastTransitionTime from the Ready condition in status.conditions
    - `subscriptions` ModelOverviewSubscription[], required — Subscriptions that reference this model.
      - `name` string, required — K8s subscription name.
      - `displayName` string — Human-readable subscription name.
      - `phase` string — Subscription phase (e.g. Active, Pending, Degraded).
      - `statusMessage` string — Subscription status message.
      - `reason` string — Reason from the Ready condition in status.conditions
      - `status` string — Status from the Ready condition in status.conditions (e.g. True, False, Unknown)
      - `type` string — Condition type from the Ready condition in status.conditions
      - `lastTransitionTime` string, date-time — lastTransitionTime from the Ready condition in status.conditions
      - `groups` string[] — Group names that own this subscription.
      - `tokenRateLimits` TokenRateLimit[] — Token rate limits applied to this model within the subscription.
        - `limit` integer, required — Maximum number of tokens allowed
        - `window` string, required — Time window (e.g., "1m", "1h", "24h")
    - `authPolicies` ModelOverviewPolicy[], required — Authorization policies that reference this model.
      - `name` string, required — K8s auth policy name.
      - `displayName` string — Human-readable auth policy name.
      - `phase` string — Auth policy phase (e.g. Active, Pending, Unknown).
      - `statusMessage` string — Auth policy status message.
      - `reason` string — Reason from the Ready condition in status.conditions
      - `status` string — Status from the Ready condition in status.conditions (e.g. True, False, Unknown)
      - `type` string — Condition type from the Ready condition in status.conditions
      - `lastTransitionTime` string, date-time — lastTransitionTime from the Ready condition in status.conditions
      - `groups` string[] — Group names subject to this policy.

## Other responses

- `401` — Unauthorized
- `500` — Internal Server Error

---

[API](https://skmtc.net/opendatahub-io/apis/maas-bff-api.md) · [All operations](https://skmtc.net/opendatahub-io/apis/maas-bff-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/opendatahub-io/maas-bff-api/versions/9112415ceeca/schema)
