> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.ada.cx/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.ada.cx/_mcp/server.

# Get a list of channels

GET https://example.ada.support/api/v2/channels/

Get a list of channels. This list can be filtered by modality and paginated. The default and maximum limits are 100 channels per page

Reference: https://docs.ada.cx/reference/conversations/get-channels

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Request

### Query parameters

- `limit` (integer, optional) — The number of records to return
- `cursor` (string, optional) — The ID that marks the start or beginning of the returned records
- `type` (enum, required) — The type of the channels to retrieve
  - Allowed values: `custom`, `native`
- `modality` (enum, optional) — The modality of the channels to retrieve
  - Allowed values: `messaging`, `email`, `voice`, `sms`

## Response

### 200

Channels

- `data` (list of Channel, optional)
- `meta` (PaginationMetadata, optional)

## Errors

### 400 Bad Request Error

Bad Request

- `errors` (list of ErrorsErrorsItems, required) — A list of errors

### 401 Unauthorized Error

Unauthorized

- `errors` (list of ErrorsErrorsItems, required) — A list of errors

### 429 Too Many Requests Error

Too Many Requests

- `errors` (list of ErrorsErrorsItems, required) — A list of errors

### 500 Internal Server Error

Internal Server Error

- `errors` (list of ErrorsErrorsItems, required) — A list of errors

## Types

### Channel

- `type`: `custom` (custom)
  - `description` (string, required) — A description of the channel
  - `modality` (enum, required) — The modality of the channel
    - Allowed values: `messaging`, `email`, `voice`, `sms`
  - `name` (string, required) — The name of the channel
  - `capabilities` (BaseChannelCapabilities, optional) — What the channel's surface can render. The AI Agent tailors replies to the declared capabilities. Omitted fields default to false. Read-only on native channels, whose capabilities are fixed by the surface.
  - `created_at` (string, optional) — The date and time the channel was created
  - `id` (string, optional) — The channel ID
  - `metadata` (map from string to CustomChannelMetadata, optional) — A dictionary of key, value pairs assigned to the channel. Metadata may not exceed 4KB total. - `metadata` keys may only be of type: `string` - `metadata` values may only be one of type: `string`, `boolean`, `integer`, or `number` (float)
- `type`: `native` (native)
  - `description` (string, required) — A description of the channel
  - `modality` (enum, required) — The modality of the channel
    - Allowed values: `messaging`, `email`, `voice`, `sms`
  - `name` (string, required) — The name of the channel
  - `capabilities` (BaseChannelCapabilities, optional) — What the channel's surface can render. The AI Agent tailors replies to the declared capabilities. Omitted fields default to false. Read-only on native channels, whose capabilities are fixed by the surface.
  - `id` (string, optional) — The channel ID

### PaginationMetadata

- `next_page_url` (string, optional, nullable) — The URL to the next page of results

### ErrorsErrorsItems

- `type` (string, required) — The error type
- `message` (string, required) — The error message
- `details` (string, optional, nullable) — Extra information about the error

### BaseChannelCapabilities

What the channel's surface can render. The AI Agent tailors replies to the declared capabilities. Omitted fields default to false. Read-only on native channels, whose capabilities are fixed by the surface.

- `markdown` (boolean, optional, default: false) — Preserve Markdown (bold, italic, and links) in replies instead of flattening to plain text.
- `quick_replies` (boolean, optional, default: false) — Deliver the tappable options of a Playbook Ask step as a `quick_replies` message instead of listing them in the reply's text. Applies to conversations created after the capability is set. Only a channel with the `messaging` modality can set it; the request is rejected on other modalities. Custom channels only: native channels always report false because Ada manages their message rendering.

### CustomChannelMetadata

## Examples

**Response**

```json
{
  "data": [
    {
      "type": "custom",
      "description": "A custom messaging channel for my AI Agent",
      "modality": "messaging",
      "name": "My Custom Channel",
      "capabilities": {
        "markdown": true,
        "quick_replies": true
      },
      "created_at": "2020-09-20T00:00:00+00:00",
      "id": "5df263b7db5a7e6ea03fae9b",
      "metadata": {
        "example_key1": "example_string_value",
        "example_key2": true,
        "example_key3": 123,
        "example_key4": 0.95
      }
    }
  ],
  "meta": {
    "next_page_url": "https://example.ada.support/api/v2/api-name?cursor=6658f91ea88ff7e389eff34d"
  }
}
```

**SDK Code**

```python
import requests

url = "https://example.ada.support/api/v2/channels/"

querystring = {"type":"custom"}

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers, params=querystring)

print(response.json())
```

```javascript
const url = 'https://example.ada.support/api/v2/channels/?type=custom';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://example.ada.support/api/v2/channels/?type=custom"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://example.ada.support/api/v2/channels/?type=custom")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://example.ada.support/api/v2/channels/?type=custom")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://example.ada.support/api/v2/channels/?type=custom', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://example.ada.support/api/v2/channels/?type=custom");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://example.ada.support/api/v2/channels/?type=custom")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```