> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kaisupport.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List channels

> Returns the connected channels, so you can name one in the template
and send endpoints. `external_id` is the provider's handle for the
channel, such as the WhatsApp phone number id.




## OpenAPI

````yaml /openapi.yaml get /channels
openapi: 3.1.0
info:
  title: Kai API
  version: 1.1.0
  description: |
    Push, update, assign and export the contacts of one Kai workspace. Read
    a contact's conversations, list the approved WhatsApp templates, send a
    template message to a customer, and assign the conversation to a
    teammate.

    Every request needs an API key. Make a key in Kai, under
    **Settings → API**. Send the key in the `Authorization` header.

    The API works on one workspace. The key decides which workspace, so no
    request carries a workspace id.
  contact:
    name: Kai support
    url: https://kaisupport.com
servers:
  - url: https://kaisupport.com/api/v1
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Contacts
    description: Customer profiles, their attributes and their account owners.
  - name: Attributes
    description: The attributes that the workspace keeps on every contact.
  - name: Members
    description: The teammates of the workspace. Read-only.
  - name: Conversations
    description: A contact's message threads, and who they are assigned to.
  - name: Templates
    description: The approved WhatsApp message templates of a channel.
  - name: Channels
    description: The connected messaging channels. Read-only.
paths:
  /channels:
    get:
      tags:
        - Channels
      summary: List channels
      description: |
        Returns the connected channels, so you can name one in the template
        and send endpoints. `external_id` is the provider's handle for the
        channel, such as the WhatsApp phone number id.
      operationId: listChannels
      responses:
        '200':
          description: The channels of the workspace.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          format: uuid
                        kind:
                          type: string
                          enum:
                            - intercom
                            - whatsapp_cloud
                            - web_widget
                            - custom_webhook
                        external_id:
                          type: string
                        enabled:
                          type: boolean
                        supports_templates:
                          type: boolean
                        created_at:
                          type: string
                          format: date-time
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
components:
  responses:
    Unauthorized:
      description: The API key is missing or not valid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              type: unauthorized
              message: That API key is not valid.
    Forbidden:
      description: The API key does not have the permission that this endpoint needs.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              type: forbidden
              message: This key does not have the "contacts:write" permission.
  schemas:
    Error:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/ErrorBody'
    ErrorBody:
      type: object
      properties:
        type:
          type: string
          description: A stable machine name for the error.
        message:
          type: string
          description: One sentence for a human reader.
        details:
          description: The attributes or the identities that caused the error.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: |
        Send your API key as `Authorization: Bearer kai_live_...`.

        Make, edit and revoke keys in Kai, under **Settings → API**. Kai stores
        only a hash of the key, so the full key is shown one time. You can
        change the name and the permissions of a key later without a new key.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.