> This page is for For Developers.

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

# List chat channels

GET https://api.whop.com/api/v1/chat_channels

Returns a paginated list of chat channels within a specific company, with optional filtering by product.

Required permissions:
 - `chat:read`

Reference: https://whop.ferndocs.com/for-developers/api-reference/api-reference/chat-channels/list-chat-channel

## Authentication

- `Authorization` header (bearer token, required) — A company API key, company scoped JWT, app API key, or user OAuth token. You must prepend your key/token with the word 'Bearer', which will look like `Bearer ***************************`

## Servers

- `https://api.whop.com/api/v1` (Production Whop API, default)
- `http://localhost:3000/api/v1` (Development Whop API)

## Request

### Query parameters

- `after` (string, optional, nullable)
- `before` (string, optional, nullable)
- `first` (integer, optional, nullable)
- `last` (integer, optional, nullable)
- `company_id` (string, required)
- `product_id` (string, optional, nullable)

## Response

### 200

A successful response

- `data` (list of ChatChannelListItem, required) — A list of nodes.
- `page_info` (PageInfo, required) — Information to aid in pagination.

## Errors

### 400 Bad Request Error

Bad request

- `error` (ChatChannelsGetResponsesContentApplicationJsonSchemaError, required)

### 401 Unauthorized Error

Unauthorized

- `error` (ChatChannelsGetResponsesContentApplicationJsonSchemaError, required)

### 403 Forbidden Error

Forbidden

- `error` (ChatChannelsGetResponsesContentApplicationJsonSchemaError, required)

### 404 Not Found Error

Not found

- `error` (ChatChannelsGetResponsesContentApplicationJsonSchemaError, required)

### 422 Unprocessable Entity Error

Verification required

- `error` (ChatChannelsGetResponsesContentApplicationJsonSchemaError, required)

### 500 Internal Server Error

Internal server error

- `error` (ChatChannelsGetResponsesContentApplicationJsonSchemaError, required)

## Types

### ChatChannelListItem

A real-time chat feed attached to an experience, with configurable moderation and posting permissions.

- `ban_media` (boolean, required) — Whether media uploads such as images and videos are blocked in this chat.
- `ban_urls` (boolean, required) — Whether URL links are blocked from being posted in this chat.
- `banned_words` (list of string, required) — A list of words that are automatically filtered from messages in this chat.
- `experience` (ChatChannelListItemExperience, required) — The experience this chat feed is attached to.
- `id` (string, required) — The unique identifier for the entity
- `user_posts_cooldown_seconds` (integer, required, nullable) — The minimum number of seconds a user must wait between consecutive messages. Null if no cooldown is enforced.
- `who_can_post` (enum, required) — The permission level controlling which users can send messages in this chat.
  - Allowed values: `everyone`, `admins`
- `who_can_react` (enum, required) — The permission level controlling which users can add reactions in this chat.
  - Allowed values: `everyone`, `no_one`

### PageInfo

Information about pagination in a connection.

- `end_cursor` (string, required, nullable) — When paginating forwards, the cursor to continue.
- `has_next_page` (boolean, required) — When paginating forwards, are there more items?
- `has_previous_page` (boolean, required) — When paginating backwards, are there more items?
- `start_cursor` (string, required, nullable) — When paginating backwards, the cursor to continue.

### ChatChannelsGetResponsesContentApplicationJsonSchemaError

- `message` (string, required)
- `type` (string, required)
- `code` (string, optional, nullable) — A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json'
- `param` (string, optional, nullable) — The parameter that caused the error, if applicable

### ChatChannelListItemExperience

The experience this chat feed is attached to.

- `id` (string, required) — The unique identifier for the experience.
- `name` (string, required) — The display name of this experience shown to users in the product navigation. Maximum 255 characters.

## Examples

**Response**

```json
{
  "data": [
    {
      "ban_media": true,
      "ban_urls": true,
      "banned_words": [
        "string"
      ],
      "experience": {
        "id": "exp_xxxxxxxxxxxxxx",
        "name": "Trading Signals Chat"
      },
      "id": "string",
      "user_posts_cooldown_seconds": 42,
      "who_can_post": "everyone",
      "who_can_react": "everyone"
    }
  ],
  "page_info": {
    "end_cursor": "string",
    "has_next_page": true,
    "has_previous_page": true,
    "start_cursor": "string"
  }
}
```

**SDK Code**

```python
import requests

url = "https://api.whop.com/api/v1/chat_channels"

querystring = {"company_id":"biz_xxxxxxxxxxxxxx"}

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

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

print(response.json())
```

```javascript
const url = 'https://api.whop.com/api/v1/chat_channels?company_id=biz_xxxxxxxxxxxxxx';
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://api.whop.com/api/v1/chat_channels?company_id=biz_xxxxxxxxxxxxxx"

	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://api.whop.com/api/v1/chat_channels?company_id=biz_xxxxxxxxxxxxxx")

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://api.whop.com/api/v1/chat_channels?company_id=biz_xxxxxxxxxxxxxx")
  .header("Authorization", "Bearer <token>")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.whop.com/api/v1/chat_channels?company_id=biz_xxxxxxxxxxxxxx', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://api.whop.com/api/v1/chat_channels?company_id=biz_xxxxxxxxxxxxxx");
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://api.whop.com/api/v1/chat_channels?company_id=biz_xxxxxxxxxxxxxx")! 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()
```