latestOpenAPI 3.1.02026-08-193894215.9 MB

23dfbe1a0d1f

Chat channels

List chat channels

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

Required permissions:

  • chat:read
get/chat_channels

Query parameters

afterstring

Returns the elements in the list that come after the specified cursor.

beforestring

Returns the elements in the list that come before the specified cursor.

firstinteger

Returns the first n elements from the list.

Example:42
lastinteger

Returns the last n elements from the list.

Example:42
company_idstring required

The unique identifier of the company to list chat channels for.

Example:biz_xxxxxxxxxxxxxx
product_idstring

The unique identifier of a product to filter by. When set, only chat channels connected to this product are returned.

Example:prod_xxxxxxxxxxxxx

Response

A successful response

Example response

{
  "data": [
    {
      "experience": {
        "id": "exp_xxxxxxxxxxxxxx",
        "name": "Trading Signals Chat"
      },
      "user_posts_cooldown_seconds": 42
    }
  ]
}