App Logo
web.telegram.org

Telegram — List a group's members

List the members of a Telegram group, each with their user id, display name, role label and presence, read from the group's own info panel. Returns the member total Telegram reports alongside the rows actually read, so a partially loaded list is visible rather than silently short. Refuses a conversation that exposes no member list at all, which is what a broadcast channel does for anyone who is not an admin. Note that opening the conversation marks it read.

Input

peerId required

The group's peer id, as returned by get_inbox (groups and channels are negative, e.g. "-5521853307"). A broadcast channel you do not administer has no member list and is refused.

Output

peerId required

The peer id that was actually opened, read back from the address bar.

members required

The member rows read from the panel, in the order the panel lists them.

complete required

True when membersRead matches the total Telegram reports, so nothing was left unloaded. False means the list is partial — large groups load lazily and this reports the shortfall rather than passing off a truncated list as the whole membership.

membersRead required

How many member rows were actually read. Equal to members.length; kept as its own field so a short read is obvious next to membersCount.

verified_on_page required

True when the members were read from a rendered member list, rather than an empty panel being reported as an empty group.

chatTitle optional

The group's title — echo this to a human, since a peer id is not recognisable.

membersCount optional

The member total Telegram reports on the group's profile, parsed from the digits in its own subtitle. Null when no number was shown. Compare with membersRead to see whether the list was fully loaded.

Start building not clicking