Lark Contacts

Overview

This node interacts with the Lark Contacts API to query the list of members in a specified user group. It is useful for scenarios where you need to retrieve and manage user group membership information within the Lark ecosystem, such as syncing group members with other systems, auditing group membership, or automating workflows based on group composition.

For example, an organization might use this node to fetch all members of a project team’s user group to send targeted notifications or to update access permissions in another system automatically.

Properties

Output

The node outputs JSON data representing the list of members in the specified user group. This typically includes member details such as user IDs, names, roles within the group, and possibly status information. The exact structure depends on the Lark Contacts API response but generally provides comprehensive membership information.

No binary data output is expected from this operation.

Dependencies

• Requires valid authentication credentials via either:
  • A tenant token credential, or
  • An OAuth2 credential.
• The node communicates with the Lark Suite Open APIs endpoint at https://open.larksuite.com/open-apis.
• Proper configuration of these credentials in n8n is necessary for successful API calls.

Troubleshooting

• Common Issues:

  • Invalid or expired authentication tokens will cause authorization errors.
  • Providing an incorrect or non-existent Group Id will result in errors or empty results.
  • Network connectivity issues can prevent communication with the Lark API.

• Error Messages:

  • Authorization failures usually indicate problems with the provided credentials; verify and refresh tokens as needed.
  • "Group not found" or similar errors suggest the Group Id does not exist or is inaccessible with the current credentials.
  • Timeout or network errors require checking internet connectivity and firewall settings.

Links and References

• Lark Suite Open API Documentation
• Lark Contacts API Reference