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
This node, named "Lark Contacts," is designed to manage contacts within the Lark platform. Specifically, for the "User Group" resource and the "Query The List Of User Groups" operation, it retrieves a list of user groups from Lark. This functionality is useful in scenarios where you need to synchronize or display organizational group structures, manage access control based on groups, or automate workflows involving user groups.
Practical examples include:
- Fetching all user groups to populate a dropdown menu in an internal app.
- Synchronizing user group data with another system for unified identity management.
- Automating notifications or permissions based on group membership.
Properties
Name | Meaning |
---|---|
Authentication | Method used to authenticate API requests. Options: "Tenant Token" or "OAuth2". |
Options | Additional optional settings: |
- Use Custom Body | Boolean flag indicating whether to send a custom request body instead of default query. |
Output
The node outputs JSON data representing the list of user groups retrieved from the Lark API. Each item in the output typically contains details about a user group such as its ID, name, description, and possibly member counts or other metadata depending on the API response.
If binary data were involved (not indicated here), it would represent attachments or files related to user groups, but this node focuses on JSON contact/group data only.
Dependencies
- Requires valid authentication credentials via either a Tenant Token or OAuth2 token for the Lark platform.
- Needs network access to the Lark Open API endpoint at
https://open.larksuite.com/open-apis
. - No additional external dependencies beyond standard HTTP requests.
Troubleshooting
- Authentication errors: Ensure that the provided Tenant Token or OAuth2 credentials are valid and have sufficient permissions to read user groups.
- Empty results: Verify that the authenticated account has user groups created; otherwise, the list will be empty.
- API rate limits: If many requests are made in a short time, the API may throttle responses. Implement retry logic or reduce request frequency.
- Use Custom Body option: If enabled incorrectly, the request body might not match API expectations, causing errors. Use this option only if you know the exact request format required.
Links and References
- Lark Open API Documentation
- Lark Contacts API Reference (for detailed user group endpoints)