---
title: "Grouped query channels"
method: POST
path: "/channels/grouped"
tags: ["product:chat"]
---

# Grouped query channels

`POST /channels/grouped`

Query channels grouped into predefined buckets. Only available for enterprise apps.

## Request body

- GroupedQueryChannelsRequest, nullable
  - `groups` object — Groups to return, keyed by group name. Each group can define limit, next, or prev. 'next' and 'prev' cursors are only allowed when the request contains exactly one group; multi-group pagination is rejected.
  - `limit` integer — Default max channels per group (default 10)
  - `user` UserRequest — User request object
    - `custom` object — Custom user data
    - `id` string, required — User ID
    - `image` string — User's profile image URL
    - `invisible` boolean
    - `language` string
    - `name` string — Optional name of user
    - `privacy_settings` PrivacySettingsResponse
      - `delivery_receipts` DeliveryReceiptsResponse
        - `enabled` boolean
      - `read_receipts` ReadReceiptsResponse
        - `enabled` boolean
      - `typing_indicators` TypingIndicatorsResponse
        - `enabled` boolean
    - `role` string — User's global role
    - `teams` string[] — List of teams the user belongs to
    - `teams_role` object — Map of team-specific roles for the user
  - `user_id` string

## Response `201`

Grouped Query Channels Response

- GroupedQueryChannelsResponse, nullable
  - `duration` string, required — Duration of the request in milliseconds
  - `groups` object, required — Predefined channel groups keyed by group name

## Other responses

- `400` — Bad request
- `429` — Too many requests

## Changes

> 89 revisions in range; 2 not diffed.

- **2026-08-20** `ff38012a3de8` — 21 info
  - added the required property `groups/additionalProperties/channels/items/active_live_locations/items/channel/config/message_retention` to the response with the `201` status
  - added the required property `groups/additionalProperties/channels/items/channel/config/message_retention` to the response with the `201` status
  - added the required property `groups/additionalProperties/channels/items/draft/channel/config/message_retention` to the response with the `201` status
  - added the required property `groups/additionalProperties/channels/items/messages/items/draft/channel/config/message_retention` to the response with the `201` status
  - …17 more
- …earlier changes not shown

[Full history](https://skmtc.dev/getstream/apis/stream-api/changes/channels/grouped/post.md)

---

[API](https://skmtc.dev/getstream/apis/stream-api.md) · [All operations](https://skmtc.dev/getstream/apis/stream-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/getstream/stream-api/revisions/ff38012a3de8/schema)