---
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

---

[API](https://skmtc.net/getstream/apis/stream-api.md) · [All operations](https://skmtc.net/getstream/apis/stream-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/getstream/stream-api/versions/8d5c27f1f6b2/schema)