Actions38
- User Actions
- Department Actions
- User Group Actions
- User Group Member Actions
- Unit Actions
- Workforce Type Actions
- Custom User Field Actions
- Contact Scope Actions
Overview
The node "Lark Contacts" provides functionality to manage contacts within the Lark platform, specifically including operations on user groups. The "Query A User Group" operation allows users to retrieve detailed information about a specific user group by its unique identifier. This is useful in scenarios where you need to fetch group metadata or membership details for automation workflows involving team management, communication setups, or directory synchronization.
For example, an HR automation workflow might use this node to query a user group representing a department to get its members and then send targeted notifications or update records accordingly.
Properties
| Name | Meaning |
|---|---|
| Authentication | Method of authenticating API requests. Options: Tenant Token, OAuth2 |
| Group Id | The unique identifier of the user group to query. Required to specify which group to fetch |
| Options | Additional optional settings: |
| Use Custom Body | Whether to send a custom request body instead of the default (boolean) |
Output
The output JSON contains the response from the Lark API for the queried user group. It typically includes fields such as group ID, name, description, member list, and other metadata describing the user group. If binary data were involved (not indicated here), it would represent files or attachments related to the group, but this operation focuses on JSON data only.
Dependencies
- Requires valid authentication credentials configured in n8n:
- Either a Tenant Token credential or an OAuth2 credential for Lark API access.
- The node communicates with the Lark Suite Open APIs at
https://open.larksuite.com/open-apis. - Proper permissions/scopes must be granted to the credentials to read user group information.
Troubleshooting
Common issues:
- Invalid or expired authentication tokens will cause authorization errors.
- Providing an incorrect or non-existent Group Id will result in not found or similar errors.
- Network connectivity problems can cause request failures.
Error messages and resolutions:
- 401 Unauthorized: Check that the API credentials are correct and have not expired.
- 404 Not Found: Verify the Group Id is accurate and the group exists.
- 400 Bad Request: If using a custom body, ensure the JSON structure matches API expectations.
- Timeouts or network errors: Confirm internet connectivity and API endpoint availability.