---
title: "Returns a list of Channel Items"
method: GET
path: "/pim/channels/{channel_id}/items"
tags: ["PIM: Channels: Items"]
---

# Returns a list of Channel Items

`GET /pim/channels/{channel_id}/items`

## Request

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

## Search and Retrieve Channel Items
Endpoint for retrieving a collection of channel items. Column filters can be applied to limit the collection returned
to those items which match the given criteria.

## Path parameters

- `channel_id` string, required

## Query parameters

- `page` object
- `sort` string
- `relationships` string
- `filter` object

## Response `200`

success

- CategoryItems
  - `data` CategoryItemData[]
    - `type` string
    - `id` string
    - `attributes` object: Category Item Attributes
      - `string_field_example` object
        - `value` string
      - `boolean_field_example` object
        - `value` boolean
      - `numeric_field_example` object
        - `value` number
      - `resource_field_example` object
        - `value` string
        - `meta` object
          - `resource_item_id` string
          - `resource_category_id` string
    - `links` object: Links
      - `self` string
    - `meta` object: Meta Information
      - `category_id` string
      - `family` string
      - `path` string[]
      - `variation` string
      - `variation_name` string
      - `level` integer
      - `is_end_level` boolean
  - `meta` ChannelMeta
    - `total` integer: Total number of items matching the query across all pages, not just the current page.
    - `filters` object[]: The parsed filter criteria applied to the query.
      - `field` string
      - `operator_id` integer
      - `operator_codename` string
      - `value` string: A single value, or an array of values for multi-value searches.
    - `sort` string, nullable: Channel item lists only.
    - `page` object, nullable: Channel item lists only. The page query parameter as sent.
      - `size` string
      - `after` string[]
    - `links` object: Channel item lists only. Pagination links. "next" is null on the last page (when a page returns fewer items than the requested page size).
      - `current` string
      - `first` string
      - `next` string, nullable

## 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)