Sign in
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
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
account_idstring required

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

Example:biz_xxxxxxxxxxxxxx

Response

A successful response

Example response

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

Changes

Changed in 1 of the 74 revisions of this API.11

  • 697924df40d111See the full diff
    • ▲

      added the new required query request parameter account_id

      new-required-request-parameter

    • ●

      deleted the query request parameter company_id

      request-parameter-removed

    This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 74 revisions, 1 has no diff computed.