---
title: "List channels (datagrid parity)"
method: GET
path: "/settings/channels"
tags: ["Admin Settings: Channels"]
---

# List channels (datagrid parity)

`GET /settings/channels`

## Request

- Base URL: `http://localhost:8000/api/admin`
- URL: `http://localhost:8000/api/admin/settings/channels`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/bagisto/apis/bagisto-admin-api/docs/settings/channels/get.ts> (a function with typed inputs; its response is checked against the schema)

Paginated, filterable, sortable channels list. Filters: code, name, hostname. Sort: id, code, name.

## Query parameters

- `page` integer
- `per_page` integer
- `code` string
- `name` string
- `hostname` string
- `sort` 'id' | 'code' | 'name'
- `order` 'asc' | 'desc'

## Response `200`

Paginated channels in the { data, meta } envelope.

- AdminSettingsChannelAdminSettingsChannelRestDto[]
  - `id` integer, nullable
  - `code` string, nullable
  - `name` string, nullable
  - `description` string, nullable
  - `hostname` string, nullable
  - `theme` string, nullable
  - `timezone` string, nullable
  - `defaultLocaleId` integer, nullable
  - `baseCurrencyId` integer, nullable
  - `rootCategoryId` integer, nullable
  - `isMaintenanceOn` boolean, nullable
  - `maintenanceModeText` string, nullable
  - `allowedIps` string[], nullable
  - `logo` string, nullable
  - `logoUrl` string, nullable
  - `favicon` string, nullable
  - `faviconUrl` string, nullable
  - `locales` object[], nullable
  - `currencies` object[], nullable
  - `inventorySources` object[], nullable
  - `homeSeo` object, nullable
  - `translations` object[], nullable
  - `createdAt` string, nullable
  - `updatedAt` string, nullable

---

[API](https://skmtc.dev/bagisto/apis/bagisto-admin-api.md) - [All operations](https://skmtc.dev/bagisto/apis/bagisto-admin-api/llms.txt) - [OpenAPI document](https://skmtc.dev/bagisto/apis/bagisto-admin-api/revisions/3198f11be70f?raw)