---
title: "Returns a list of PIM Categories"
method: GET
path: "/pim/categories"
tags: ["PIM: Categories"]
---

# Returns a list of PIM Categories

`GET /pim/categories`

## Request

- Base URL: `https://api.kontainer.com/jsonapi/v2`
- URL: `https://api.kontainer.com/jsonapi/v2/pim/categories`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/kontainer/apis/kontainer-api-documentation/docs/pim/categories/get.ts> (a function with typed inputs; its response is checked against the schema)

## Retrieve PIM Categories
Endpoint for retrieving a collection of Categories.

## Response `200`

success

- Categories
  - `data` CategoryData[]
    - `type` string
    - `id` string
    - `attributes` object
      - `name` string
      - `description` string
      - `is_resource` boolean
      - `is_file` boolean
    - `links` object
      - `self` string
    - `meta` unknown[]
      - unknown
  - `links` Links
    - `first` string
    - `last` string
    - `prev` string, nullable
    - `next` string, nullable
  - `meta` Meta
    - `current_page` integer
    - `from` integer
    - `last_page` integer
    - `links` Link[]
      - `url` string, nullable
      - `label` string
      - `active` boolean
    - `path` string
    - `per_page` integer
    - `to` integer
    - `total` integer
    - `filter` union: The `filter` query parameter echoed back as sent; an empty array when none was sent
      - object
      - unknown[]
        - unknown
    - `sort` string

## Other responses

- `401`: Unauthorized

---

[API](https://skmtc.dev/kontainer/apis/kontainer-api-documentation.md) - [All operations](https://skmtc.dev/kontainer/apis/kontainer-api-documentation/llms.txt) - [OpenAPI document](https://skmtc.dev/kontainer/apis/kontainer-api-documentation/revisions/b80a5167e09a?raw)