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

# GET /api/v1/channels

`GET /api/v1/channels`

Retrieves multiple channels.

## Query parameters

- `pageNumber` number — The page number.
- `pageSize` number — The page size.
- `responderIds` union
  - string[]
  - string, uuid — A UUID v4 string that identifies an entity.
- `search` string — Search term to filter channels by name, description, or prompt.

## Headers

- `authorization` string, required — The API key to use for authentication. Can be created in the api keys section on the workspace settings page.

## Response `200`

Retrieves all channels for the workspace.

- object[]
  - `createdAt` string, date-time, required
  - `id` string, uuid, required — A UUID v4 string that identifies an entity.
  - `isRemoved` boolean, required
  - `updatedAt` string, date-time, required
  - `delay` integer, required — The delay between the last user message and the beginning of the response generation.
  - `description` string, nullable, required — The internal description of the channel.
  - `detail` union, required
    - object
      - `initialMessage` string, nullable, required — The initial message to be displayed when the API is used.
      - `responseWebhookUrl` string, uri, required — The webhook URL that receives responses produced through the API channel.
      - `type` 'api', required — The channel subtype represented by this detail payload.
    - object
      - `allowClientSideMcp` boolean, required — Whether registering tools from the widget's parent page is allowed.
      - `initialMessage` string, nullable, required — The initial message to be displayed when the widget is opened.
      - `loading` 'private' | 'named' | 'explained', required — The level of detail to be included in the loading message when the widget is opened.
      - `openOnLoad` boolean, required — Whether the widget should be opened automatically when the page is loaded.
      - `themes` object, required — The widget theme palette configuration for the channel.
        - `dark` object, required
          - `ownerMessageBackground` string, nullable, required
          - `ownerMessageColor` string, nullable, required
          - `responderMessageBackground` string, nullable, required
          - `responderMessageColor` string, nullable, required
        - `light` object, required
          - `ownerMessageBackground` string, nullable, required
          - `ownerMessageColor` string, nullable, required
          - `responderMessageBackground` string, nullable, required
          - `responderMessageColor` string, nullable, required
      - `type` 'widget', required — The channel subtype represented by this detail payload.
    - object
      - `connectionId` string, uuid, nullable, required — The backing connection ID used by this channel, when one exists.
      - `reactionTakeover` object, required — The reaction-based takeover policy configured for the channel.
        - `handoverEmojis` string[], required — The emojis that will handover the chat back to the agent.
        - `status` boolean, required — Whether the reaction takeover is enabled.
      - `splitLongerMessages` boolean, required — Weather longer messages should be split when delivering them to the connected Waha (WhatsApp) account.
      - `type` 'waha', required — The channel subtype represented by this detail payload.
    - object
      - `connectionId` string, uuid, nullable, required — The backing connection ID used by this channel, when one exists.
      - `reactionTakeover` object, required — The reaction-based takeover policy configured for the channel.
        - `handoverEmojis` string[], required — The emojis that will handover the chat back to the agent.
        - `status` boolean, required — Whether the reaction takeover is enabled.
      - `splitLongerMessages` boolean, required — Weather longer messages should be split when delivering them to the connected WhatsApp account.
      - `type` 'whatsapp', required — The channel subtype represented by this detail payload.
    - object
      - `connectionId` string, uuid, nullable, required — The backing connection ID used by this channel, when one exists.
      - `reactionTakeover` object, required — The reaction-based takeover policy configured for the channel.
        - `handoverEmojis` string[], required — The emojis that will handover the chat back to the agent.
        - `status` boolean, required — Whether the reaction takeover is enabled.
      - `splitLongerMessages` boolean, required — Weather longer messages should be split when delivering them to the connected Instagram account.
      - `type` 'instagram', required — The channel subtype represented by this detail payload.
    - object
      - `connectionId` string, uuid, nullable, required — The backing connection ID used by this channel, when one exists.
      - `splitLongerMessages` boolean, required — Whether longer messages should be split when delivering them to the connected Telegram account.
      - `type` 'telegram', required — The channel subtype represented by this detail payload.
  - `maxAssistantMessagesPerChatOwner` integer, nullable, required
  - `name` string, required — The display name of the channel.
  - `prompt` string, nullable, required — A prompt to be passed down to the agent in the context of this channel.
  - `responderId` string, uuid, nullable, required — The super identity of the responder (agents or squads) of the channel
  - `showSenderName` boolean, required — Whether to display sender names in chat messages.
  - `status` 'active' | 'inactive', required — The lifecycle status of the channel.
  - `useVoice` 'on-audio/without-transcription' | 'on-audio/with-transcription' | 'always/without-transcription' | 'always/with-transcription' | 'never', required — The voice behavior mode configured for the channel.
  - `workspaceId` string, uuid, required — The workspace ID that owns the channel.

## Other responses

- `400` — Bad Request.
- `401` — Unauthorized.

---

[API](https://skmtc.dev/zaia/apis/public-api.md) · [All operations](https://skmtc.dev/zaia/apis/public-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/zaia/public-api/revisions/58da3b2ba49f/schema)