Skip to content

List Tax Categories

EndpointMethod
/api/admin/settings/tax-categoriesGET

Returns every tax category configured in the store in the { data, meta } envelope. Each tax category is a named group of tax rates that you assign to products to determine how they are taxed.

Pagination

ParameterDescription
pagePage number, 1-based. Default 1.
per_pageItems per page. Default 10, max 50.

Filters

Query parameters that narrow the result. Supplying more than one narrows further — they combine with logical AND. They mirror the admin Tax Categories datagrid filters.

ParameterMatchExample
codePartial (contains).?code=doc
namePartial (contains).?name=Demo

Sorting

ParameterValues
sortid (default), code, name
orderasc, desc (default desc)

Both the compound form ?sort=name-asc and the split form ?sort=name&order=asc are accepted.

Notes

  • taxRates lists the attached rate ids. It is detail-only — empty ([]) on the listing to keep the list query light. Fetch a single category to read its attached rates.

See the Tax Categories overview for field meanings and behaviour.

Released under the MIT License.