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

# Returns a list of PIM Channels

`GET /pim/channels`

## Request

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

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

## Query parameters

- `relationships` string
- `includes` string

## Response `200`

success

- Channels
  - `data` ChannelData[]
    - `type` string
    - `id` string
    - `attributes` object
      - `name` string
      - `description` string, nullable
      - `is_resource` boolean
      - `is_subchannel` boolean
    - `links` object
      - `self` string
    - `meta` unknown[]
      - unknown
    - `relationships` object
      - `category` object
        - `data` object, nullable
          - `type` string
          - `id` string
      - `parent_channel` object: Null for a main channel.
        - `data` object, nullable
          - `type` string
          - `id` string
      - `subchannels` object
        - `data` object[]
          - `type` string
          - `id` string
      - `fields` object: The fields (columns) placed in the channel. Resource-linkage to channel_field resources; request ?includes=fields to embed them in the top-level included array.
        - `data` object[]
          - `type` string
          - `id` string
  - `included` ChannelField[]: Present only when ?includes=fields is requested.
    - `type` string
    - `id` string
    - `attributes` object
      - `name` string
      - `sort` integer
    - `relationships` object
      - `element` object
        - `data` object
          - `type` string
          - `id` string
  - `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)