Admin Catalog: Categories
List categories (datagrid parity)
Paginated, filterable, sortable category list mirroring the admin Catalog → Categories datagrid.
get/catalog/categories
Request
- Base URLhttp://localhost:8000/api/admin
- AuthHTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
pageinteger
Example:1
Page number (1-based).
per_pageinteger
Example:10
Items per page (default 10, max 50).
category_idstring
Example:12
Filter by category ID — single integer or comma-separated list (e.g. "12" or "12,18").
namestring
Example:Apparel
Partial category name match (SQL LIKE).
positioninteger
Example:1
Exact position filter.
status0 | 1
Example:1
Filter by status (0 = disabled, 1 = enabled).
parent_idinteger
Example:1
Filter by parent category ID.
localestring
Example:en
Locale code for translation resolution (e.g. "en").
sort'id' | 'name' | 'position' | 'status'
Example:id
Column to sort by.
order'asc' | 'desc'
Example:desc
Sort direction.
Response
Paginated list of category rows in the { data, meta } envelope.
Changes
No recorded changes to this operation across all 8 revisions of this API.