List product categories
get
https://api.flactrum.com/v1/product-categories
| Required scope | categories.read |
| Panel screen | Menu & products → Product categories |
| Success status | 200 |
| Returns | A paginated list of ProductCategory objects |
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| parent_id | query | string | Children of one category. Send it empty to get root categories only. |
| search | query | string | — |
| page | query | integer | Page number. |
| per_page | query | integer | Page size. Values above the maximum are rejected rather than silently clamped. |
| active | query | boolean | Filter by active flag. Omit to get both. |
| updated_since | query | string | Only records changed at or after this instant. Use it for incremental sync. |
| lang | query | string | Language for translatable fields. Must be configured for the brand. |
| sort | query | string | Column to sort by. Each endpoint lists what it accepts. |
| direction | query | string | Sort direction. |
Response fields
| Field | Type | Description |
|---|---|---|
| id | string | — |
| name | string | Follows ?lang. |
| slug | string|null | — |
| parent_id | string|null | — |
| sort_order | integer | — |
| is_active | boolean | — |
| product_count | integer | — |
| translations | object | All translations keyed by language code. |
| created_at | string | — |
| updated_at | string | — |
Examples
No recorded example yet.