Get all product categories (flat or tree)

Always returns { data, pagination }. Pagination counts root categories only (depth 0). Flat list (withChildren omitted or false): data[i] is a root category. withChildren=true: each data[i] is a root with its children[] (depth 1) attached; children are not independently paged. Optional search matches root name or description (substring, LIKE %value%); in tree mode, a matching direct child also includes its parent root. Optional hasProducts=true limits roots (and in tree mode, each root’s children[]) to categories that have at least one non-deleted product in product_category_map.

Access: Auth methods: JWT bearer or API key. Allowed user types: MVNO, PARTNER. Requires permissions: product-category:read.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
≥ 1
Defaults to 1

Page number (1-based)

integer
1 to 2000
Defaults to 20

Items per page

string
enum
Defaults to ACTIVE

Filter by category status (defaults to ACTIVE)

Allowed:
boolean
Defaults to false

Both modes return a paginated list of root categories (depth 0). When true, each row also includes its children[] (depth 1). When omitted or false, rows are flat (no children).

boolean
Defaults to false

When true, only roots that have at least one non-deleted product mapped to the root or any of its active subcategories are returned. In tree mode (withChildren=true), children[] is limited to subcategories that also have at least one such product. When omitted or false, categories are not filtered by product mappings.

string
length ≤ 200

Filter by exact category name (case-insensitive; trimmed). In flat mode, matches roots whose name equals the filter. In tree mode (withChildren=true), matches roots whose name OR any direct child name equals the filter, so a search for a child name returns its parent root with the child attached.

Search by category name or description (substring match; SQL LIKE %value% on each field).

Response

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json