Skip to main content
POST
List Namespaces

Authorizations

Authorization
string
header
required

Mixpeek API key, sent as Authorization: Bearer mxp_sk_.... Create one in Studio under Settings → API Keys, or with an admin key via POST /v1/organizations/users/{user_email}/api-keys. A missing, malformed, unknown, revoked, inactive or expired key returns 401; a key without the permission, scope or plan an operation needs returns 403.

Query Parameters

include_system
boolean
default:false

Include read-only system namespaces (e.g. sample-data)

view
enum<string>
default:full

Response detail level. 'full' (default) returns complete namespace objects. 'summary' omits heavy per-namespace config (payload_indexes, feature_extractors, vector_inference_map, vector_configs) — ~93% smaller — for high-frequency list/switcher views. Fetch full config via GET /v1/namespaces/{namespace_identifier}.

Available options:
full,
summary
limit
integer | null
Required range: 1 <= x <= 1000
page_size
integer | null
Required range: 1 <= x <= 1000
offset
integer | null
Required range: 0 <= x <= 10000
page
integer | null
Required range: x >= 1
cursor
string | null
next_cursor
string | null
after
string | null
include_total
boolean
default:false

Body

application/json

Keys this body does not declare are refused with 422 extra_forbidden naming the accepted keys (since 2026-11-02).

Request schema for listing namespaces.

Inherits body-level limit/page_size/offset/page — body values win over query pagination via merge_body_pagination.

limit
integer | null

Page size. A body value wins over the limit query param.

Required range: 1 <= x <= 1000
page_size
integer | null

Alias for limit (page size). If both are given, limit wins.

Required range: 1 <= x <= 1000
offset
integer | null

Number of results to skip (legacy, use cursor instead). A body value wins over the offset query param.

Required range: 0 <= x <= 10000
page
integer | null

1-indexed page number. Folds to offset = (page-1) * limit. If both page and offset are given, offset wins.

Required range: x >= 1
filters
Filters · object | null

Optional filters to apply to the namespace list. Supports filtering by namespace_id or namespace_name.

Example:
sort
Sort · object | null

Optional sort criteria for the namespace list (single-column, legacy). With no sort at all, starred namespaces come first. A sort on any other field is applied exactly as given, so starred namespaces get no special place in it.

Example:
sorts
Sorts · object[] | null

Sort criteria as a list of {field, direction} — the shape Studio datatables and the retriever list send. The first entry is the primary sort. Takes precedence over the singular sort. To keep starred namespaces on top of another order, name starred first: the second entry then orders the namespaces inside each group. Any other second entry is ignored.

Example:
search
string | null

Search term for wildcard search across namespace_id, namespace_name, description, and other text fields.

Example:

"ns_abc123"

case_sensitive
boolean
default:false

If True, filters and search will be case-sensitive

Response

Successful Response

Response schema for listing namespaces.

results
NamespaceModel · object[]
required

List of namespaces matching the query

pagination
PaginationResponse · object
required

Pagination information for the current result window

total_count
integer
required

Total number of namespaces that match the query

stats
NamespaceListStats · object | null

Aggregate statistics across all namespaces in the result