Rocket.Chat Extended icon

Rocket.Chat Extended

Extended Rocket.Chat operations: channels, messages, threads, reactions, file upload, and more

Channel → Get Many

AI-generated

Summary

Fetch many channels matching the selected channel type, optionally limited and controlled by returnAll flag.

Inputs

  • channelType (required) — Target either public channels ('channel') or private groups ('group').
  • returnAll — If true, ignore the limit and return all available channels; otherwise honor the Limit value.
  • limit — Maximum number of channels to return when returnAll is false; must be between 1 and 500.

Output shape

an array of channel objects (each containing fields like _id, name, type, etc.)

Pagination: when returnAll is false the Limit parameter caps the result size; setting returnAll true returns all channels regardless of limit.

Examples

Example 1: Retrieve up to 20 public channels

channelType=channel, returnAll=false, limit=20

Example 2: Get all private groups the user has joined

channelType=group, returnAll=true

Example 3: Paginated fetch of joined channels with limit 50

channelType=group, returnAll=false, limit=50

Links

Discussion