Actions116
- 💬 Chats Actions
- 👤 Contacts Actions
- 👥 Groups Actions
- Get Info Admin Only
- Set Messages Admin Only
- Get Messages Admin Only
- Get Invite Code
- Revoke Invite Code
- Get Participants
- Add Participants
- Remove Participants
- Promote To Admin
- Demote To Admin
- Create Group
- Get Groups
- Join Info Group
- Join Group
- Refresh Groups
- Get Group
- Delete Group
- Leave Group
- Get Chat Picture
- Set Picture
- Delete Picture
- Set Description
- Set Subject
- Set Info Admin Only
- 🖥️ Sessions Actions
- 🆔 Profile Actions
- 🖼️ Screenshot Actions
- 📤 Chatting Actions
- 📢 Channels Actions
- 🟢 Status Actions
- ✅ Presence Actions
- 🏷️ Labels Actions
- 🔍 Observability Actions
- 🔑 Auth Actions
Overview
This node operation retrieves groups from a specified session, allowing users to fetch and manage group data efficiently. It is useful in scenarios where users need to list groups with sorting and pagination options, such as in messaging or collaboration platforms.
Use Case Examples
- Fetch groups sorted by ID in descending order to display the most recent groups first.
- Retrieve a limited number of groups with an offset for pagination in a user interface.
Properties
| Name | Meaning |
|---|---|
| Session | The session name to identify which session's groups to retrieve. |
| Sort By | Field by which to sort the groups, either by 'Id' or 'Subject'. |
| Sort Order | Order of sorting, either descending (desc) or ascending (asc). |
| Limit | Maximum number of groups to retrieve. |
| Offset | Number of groups to skip before starting to collect the result set. |
| Request Options | Additional request options such as batching, SSL certificate validation, proxy settings, and timeout configuration. |
Output
JSON
id- Unique identifier of the group.subject- Subject or name of the group.members- List of members in the group.createdAt- Timestamp when the group was created.
Dependencies
- Requires an API key credential or session authentication to access group data.
Troubleshooting
- Common issues include invalid session names leading to authentication errors.
- Incorrect sorting or pagination parameters may result in unexpected or empty results.
- SSL certificate validation errors can occur if the server's SSL certificate is invalid; this can be bypassed by enabling the 'Ignore SSL Issues' option.
- Timeout errors may happen if the server is slow to respond; increasing the timeout value can help.