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

# Get Channels

`GET /api/v1/channels/`

## Query parameters

- `page` integer, nullable — The page number from which to start (0-based)
- `limit` integer — The maximum number of items to return
- `search_fields` ChannelProperties[] — String names of fields to search. Correspond by index to search field values
- `search_field_values` string[] — Values of fields to search. Correspond by index to search fields. Unless field name contains "list", an individual search field value cannot be a list
- `order_by` 'id' | 'name' | 'name_exact' | 'channel_service' | 'supported_modes' | 'config' — Names of channel fields supported for filtering/sorting on list endpoint.
- `order_by_direction` 'asc' | 'desc' — The direction in which to order list results, either ascending or descending.
- `fields` ChannelProperties[], nullable — The fields to include in the response
- `start_datetime` string, nullable — The start datetime for filtering results
- `end_datetime` string, nullable — The end datetime for filtering results

## Response `200`

Successful Response

- ListResponseChannel
  - `items` Channel[], required — List of items returned from the query
    - `name` string, required — The channel name
    - `channel_service` 'sip' | 'twilio' | 'email' | 'webchat' | 'africastalking' | 'whatsapp', required — The communication service for a channel.
    - `supported_modes` string, nullable — The comma-delimited list of supported modes for the channel, which defines the possible communication methods for channel targets linked to it.
    - `is_system_channel` boolean — Whether the channel is a built-in system channel (i.e., is not customizable)
    - `id` integer, required — The channel ID
    - `config` ChannelConfigView
      - `telephony` TelephonyConfigurations
        - `pre_input_timeout` number, nullable — Pre input silence threshold
        - `post_speech_input_timeout` number, nullable — Post speech silence timeout to determine input as ended.
        - `post_dtmf_input_timeout` number, nullable — Post dtmf silence timeout to determine input as ended.
        - `overall_input_timeout` number, nullable — Total input timeout
        - `output_padding` number, nullable — Number of seconds to start listening to user input before assistant speech ends
        - `interruptibility` string, nullable — Interruptibility setting for user input.Valid values: none, dtmf_only, speech_only, all
        - `passive_speech_input_enabled` boolean, nullable — Whether passive speech input is enabled (input while assistant is speaking)
        - `passive_input_start` number, nullable — Waiting time to start passive input (in seconds) after start of assistant speech
        - `async_enabled` boolean, nullable — Whether asynchronous mode is enabled for the conversation
        - `transfer_leg_voicemail_detection_enabled` boolean, nullable — Whether transfer leg voicemail detection is enabled
        - `sip_configuration` SipConfiguration — SIP routing configuration for transferring a call to a destination. This is internal telephony/routing configuration used to direct a transfer to specific SIP endpoints.
          - `sip_transfer_mode` 'refer' | 'invite' — How a call should be transferred to a SIP endpoint.
          - `sip_endpoints` SipEndpoint[], nullable — List of SIP endpoints to attempt for the transfer.
            - `host` string, required — SIP endpoint host (IP address or hostname).
            - `port` string, nullable — SIP endpoint port.
            - `transport` 'tls' | 'tcp' | 'udp' — The transport protocol to use for the SIP endpoint.
          - `call_info_placement` string, nullable — Where to place call information during a transfer. Supported values are `uri_parameters`, `to_parameters`, `from_parameters`, or `sip_header:<header-name>`.
      - `email` EmailConfigurations — Email channel configurations.
        - `sending_domain` string, required — The domain to use for sending emails. Must be authenticated in SendGrid.
      - `credentials` object, nullable — Exposed credentials for the channel - currently just account_sid_last_four for Twilio channels
  - `page` integer, required — The page number of the results (0-based)
  - `page_size` integer, required — The number of items returned per page
  - `total_pages` integer, nullable — The total number of pages of results given the indicated page size
  - `total_count` integer, nullable — The total number of items returned from the query

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/asksyllable/apis/syllablesdk.md) · [All operations](https://skmtc.net/asksyllable/apis/syllablesdk/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/asksyllable/syllablesdk/revisions/534f1f22c775/schema)