Skip to main content

List Models

Page Outline

Returns a paginated list of all models accessible to the authenticated user within the current organization.

Base Path: /api/v1/models

Method: GET

Path: /

Auth: Requires a valid Bearer token (Authorization: Bearer <JWT>)

Query Parameters

ParameterTypeDefaultDescription
pageinteger1Page number for pagination
page_sizeinteger20Number of results per page (max: 100)
statusstringFilter by model status: draft, training, ready, archived, failed
model_typestringFilter by type: auto or custom
task_typestringFilter by task: classification, regression, clustering
searchstringFull-text search across model names and descriptions
tagsstringComma-separated list of tag filters (AND logic)
sort_bystringcreated_atSort field: name, created_at, updated_at, status
sort_orderstringdescSort direction: asc or desc

Behavior

  • Returns only models belonging to the caller's organization.
  • Archived models are excluded by default unless status=archived is explicitly provided.
  • Each item in the response list contains a summary representation; full detail requires calling GET /{model_id}.
  • Audit logging is not triggered on list reads.

Response

Returns a paginated ModelList object.

{
"total": 134,
"page": 1,
"page_size": 20,
"results": [
{
"id": "mdl-7f3a19bc",
"name": "My Churn Predictor",
"model_type": "auto",
"task_type": "classification",
"status": "ready",
"version": 3,
"created_at": "2026-03-13T11:00:00Z",
"updated_at": "2026-03-13T14:22:10Z"
}
]
}