---
title: "Gets a list of categories"
method: POST
path: "/api/v{version}/categories/search"
tags: ["catalog"]
---

# Gets a list of categories

`POST /api/v{version}/categories/search`

Gets a list of categories with pagination and filtering support. Permissions requises : SupplierAdminRole, SupplierParcelsManagerRole.

## Path parameters

- `version` string, required

## Headers

- `X-Tenant` string, required

## Request body

- SearchCategoriesRequest
  - `advancedSearch` Search
    - `fields` string[], nullable
    - `keyword` string, nullable
  - `keyword` string, nullable
  - `advancedFilter` Filter
    - `logic` string, nullable
    - `filters` Filter[], nullable
    - `field` string, nullable
    - `operator` string, nullable
    - `value` unknown
  - `pageSize` integer
  - `pageNumber` integer
  - `orderBy` string[], nullable
  - `includeSubCategories` boolean
  - `expiration` string, date-span, nullable

## Response `200`

OK

- PagedListCategoryResponse
  - `items` CategoryResponse[], nullable
    - `id` string, uuid
    - `name` string, nullable
    - `subCategories` SubCategoryResponse[], nullable
      - `id` string, uuid
      - `name` string, nullable
  - `pageNumber` integer
  - `pageSize` integer
  - `totalCount` integer
  - `totalPages` integer
  - `hasPrevious` boolean
  - `hasNext` boolean

---

[API](https://skmtc.dev/zrexpress/apis/zrexpress-api.md) · [All operations](https://skmtc.dev/zrexpress/apis/zrexpress-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/zrexpress/zrexpress-api/revisions/99b075e0b641/schema)