---
title: "List models for an organization"
method: GET
path: "/models"
---

# List models for an organization

`GET /models`

List models for an organization with pagination, filtering, and sorting.

Filter parameters support Supabase filter operators, per the field's
declared policy:
- Text fields (name, description, created_by_email): use ``ilike.%value%``
  for partial match
- Date fields: use ``gte.value``, ``lte.value``, etc.
- Date range: use created_at_gt and created_at_lt for between queries

## Query parameters

- `limit` integer
- `offset` integer
- `q` string, nullable — Free-text search on model name and search_vector.
- `name` string, nullable
- `description` string, nullable
- `created_by_email` string, nullable
- `created_at` string, nullable
- `created_at_gt` string, nullable
- `created_at_lt` string, nullable
- `updated_at` string, nullable
- `updated_at_gt` string, nullable
- `updated_at_lt` string, nullable
- `order_by` 'name' | 'created_at' | 'updated_at'
- `order` 'asc' | 'desc'

## Response `200`

Successful Response

- PaginatedResponseModel
  - `items` Model[], required
    - `name` string, required — The name of the model.
    - `description` string, nullable — An optional description for the model.
    - `pybamm_version` string, nullable — PyBaMM version used for this model. If not provided, will be read from pybamm.__version__.
    - `chemistry` 'lithium_ion' | 'lithium_sulfur' | 'ecm' | 'generic' — Model chemistry kind: 'lithium_ion' (default — assumes pybamm lithium-ion conventions), 'lithium_sulfur', 'ecm', or 'generic' (no chemistry-specific enrichment).
    - `simulation_settings` object, nullable — Optional persistent simulation kwargs (var_pts / submesh_types / spatial_methods / geometry / solver) in the flat canonical form, re-applied at simulation time. None uses the model defaults.
    - `id` string, required — The unique identifier for the model.
    - `user_id` string, required — The ID of the user who created the model.
    - `organization_id` string, required — The ID of the organization this model belongs to.
    - `created_by_email` string, nullable — Email of the user who created the model.
    - `created_at` string, date-time, required — Timestamp of when the model was created.
    - `updated_at` string, date-time, required — Timestamp of when the model was last updated.
    - `is_custom_model` boolean, required — Check if this is a custom model (has compressed model data).
  - `count` integer, required
  - `total` integer, required

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.dev/ionworks/apis/fastapi.md) · [All operations](https://skmtc.dev/ionworks/apis/fastapi/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/ionworks/fastapi/revisions/7337a3cbdaf2/schema)