XYZ icon

XYZ

XYZ chatbot integration (actions)

Get Room Members

AI-generated

Summary

Retrieve a list of members from a specified chat room, optionally filtered by membership status and limited in number, with support for pagination using a token.

Inputs

  • Room ID (required) — The unique identifier of the chat room to get members from.
  • Limit — The maximum number of members to return (minimum 1, default 50).
  • Membership — Filter members by their membership status in the room (ban, invite, join, knock, leave). Defaults to 'join'.
  • Since — A pagination token to retrieve the next set of results starting from this marker.

Output shape

a list of room member records

The output includes an array of members matching the specified room ID and membership filter, limited by the provided limit, and can be paginated using the 'Since' token. Errors are returned per item in failure scenarios.

Discussion