---
title: "List channels"
method: GET
path: "/channels"
tags: ["Channels"]
---

# List channels

`GET /channels`

## Query parameters

- `pageSize` number
- `page` number
- `sortBy` string
- `name__exact` string
- `status__exact` string

## Headers

- `organization` string, required

## Response `200`

Successful response

- object — A paginated list of Channel objects
  - `page` integer — The current page
  - `pageSize` integer — The number of objects per page
  - `total` integer — The total number of objects in the response
  - `pageCount` integer — The total number of pages
  - `pageNumberIsGood` boolean — Page number is valid.
  - `hasPreviousPage` boolean — There is a previous page.
  - `hasNextPage` boolean — There is a next page.
  - `isFirstPage` boolean — This is the first page.
  - `isLastPage` boolean — This is the last page.
  - `rows` ChannelRestOutput[]
    - `id` string — Channel ID
    - `name` string — Channel name
    - `slug` string — Channel slug
    - `organization` string — Organization ID
    - `description` string — Channel description
    - `status` string — Channel status
    - `geofence` GeofenceObject
      - `countryCodes` string[]
      - `type` 'WHITELIST' | 'BLACKLIST'
    - `customization` CustomizationObject
      - `logo` object — Logo image
        - `light` ImageDetails, required
          - `imgPath` string, required — The path to the image.
          - `baseUrl` string, required — The base URL for the image.
        - `dark` ImageDetails, required
          - `imgPath` string, required — The path to the image.
          - `baseUrl` string, required — The base URL for the image.
      - `icon` object — Icon image
        - `light` ImageDetails, required
          - `imgPath` string, required — The path to the image.
          - `baseUrl` string, required — The base URL for the image.
        - `dark` ImageDetails, required
          - `imgPath` string, required — The path to the image.
          - `baseUrl` string, required — The base URL for the image.
      - `thumbnail` ImageDetails
        - `imgPath` string, required — The path to the image.
        - `baseUrl` string, required — The base URL for the image.
    - `entitlements` string[] — Array of product IDs
    - `geofenceEntitlements` unknown[] — Geofence entitlements
      - unknown
    - `kind` string — The access level of the channel
    - `access` string — States if the channel is universally available or geolocked.

---

[API](https://skmtc.net/fanhero/apis/tenant-endpoints.md) · [All operations](https://skmtc.net/fanhero/apis/tenant-endpoints/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/fanhero/tenant-endpoints/versions/8e7584c449dc/schema)