Skip to main content
POST
List Taxonomies

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

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
include_total
boolean
default:false

Body

application/json

Request model to list taxonomies.

Inherits body-level limit/page_size/offset/page (BACKE-2846) — 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
search
string | null

Search term for wildcard search across taxonomy_id, taxonomy_name, description, and other text fields

filters
LogicalOperator · object | null

Filters to apply to the taxonomy list. Supports filtering by taxonomy_id or taxonomy_name.

sort
SortOption · object | null

Sort configuration for the taxonomy list (single-column, legacy)

sorts
Sorts · object[] | null

Sort configuration 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.

case_sensitive
boolean
default:false

If True, filters and search will be case-sensitive

Response

Successful Response

Response model for listing taxonomies.

results
TaxonomyResponse · object[]
required
pagination
Pagination · object
required
total_count
integer
required
stats
TaxonomyListStats · object | null

Aggregate statistics across all taxonomies in the result