---
title: "Get list of categories"
method: GET
path: "/api/rest/v1/categories"
tags: ["Category"]
---

# Get list of categories

`GET /api/rest/v1/categories`

This endpoint allows you to get a list of categories. Categories are paginated and sorted by `root/left`.

## Query parameters

- `search` string
- `page` integer
- `limit` integer
- `with_count` boolean
- `with_position` boolean

## Response `200`

Return categories paginated

- object
  - `_links` object
    - `self` object
      - `href` string — URI of the current page of resources
    - `first` object
      - `href` string — URI of the first page of resources
    - `previous` object
      - `href` string — URI of the previous page of resources
    - `next` object
      - `href` string — URI of the next page of resources
  - `current_page` integer — Current page number
  - `_embedded` object
    - `items` object[]
      - `_links` object
        - `self` object
          - `href` string — URI of the resource
      - `code` string, required — Category code
      - `parent` string — Category code of the parent's category
      - `updated` string, dateTime — Date of the last update
      - `position` integer — Position of the category in its level, start from 1 (only available since the 7.0 version and when query parameter "with_position" is set to "true")
      - `labels` object — Category labels for each locale
        - `localeCode` string — Category label for the locale `localeCode`
      - `values` object — Attribute values
        - `attributeCode|attributeUuid|channelCode|localeCode` object
          - `data` object — Attribute value
          - `type` string — The attribute type
          - `locale` string — <a href='api-reference-paas.html#Locale'>Locale</a> code of the attribute value
          - `channel` string — <a href='api-reference-paas.html#Channel'>Channel</a> code of the attribute value
          - `attribute_code` string — The attribute code with its uuid (attributeCode|attributeUuid)
      - `channel_requirements` string[] — List of <a href='api-reference-paas.html#Channel'>Channel</a> codes on which the category tree is required for products completeness. Only category trees can be required, not child categories.

## Other responses

- `401` — Authentication required
- `403` — Access forbidden
- `406` — Not Acceptable

---

[API](https://skmtc.net/akeneo/apis/akeneo-pim-rest-api.md) · [All operations](https://skmtc.net/akeneo/apis/akeneo-pim-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/akeneo/akeneo-pim-rest-api/versions/d8bda9b93b59/schema)