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 Resource "Contact Scope" and Operation "Obtain The Range Of Contacts Data That An App Can Access," it retrieves information about the scope or range of contact data that an application can access via the Lark API. This is useful in scenarios where an app needs to understand or verify its permissions or visibility over user contacts before performing further operations such as messaging, collaboration, or directory lookups.
Practical examples include:
- An app checking which contacts it can interact with to tailor UI elements accordingly.
- Auditing or logging the extent of accessible contacts for compliance or security reviews.
- Dynamically adjusting functionality based on the contact scope available to the app.
Properties
| Name | Meaning |
|---|---|
| Authentication | Method of authenticating API requests. Options: "Tenant Token" or "OAuth2". |
| Options | Additional optional settings: |
| - Use Custom Body | Boolean flag indicating whether to send a custom request body (true/false). Defaults to false. |
Output
The node outputs JSON data representing the range of contacts accessible by the app. This typically includes details about the scope or limits of contact data visibility granted by the Lark platform. The exact structure depends on the API response but generally contains fields describing accessible departments, users, or groups.
No binary data output is indicated for this operation.
Dependencies
- Requires valid authentication credentials, either a Tenant Token or OAuth2 token, configured in n8n.
- Connects to the Lark Suite Open APIs at
https://open.larksuite.com/open-apis. - Proper API permissions must be granted to the credentials used to successfully retrieve contact scope data.
Troubleshooting
- Authentication errors: Ensure that the provided Tenant Token or OAuth2 token is valid, not expired, and has sufficient permissions.
- Permission denied or empty scope: The app’s permissions might be limited; verify the app’s access rights in the Lark developer console.
- Network or API errors: Check network connectivity and confirm the base URL is reachable.
- Using custom body option: If enabled, ensure the custom body format matches the API expectations to avoid request failures.
Links and References
- Lark Open Platform Documentation
- Lark Contacts API Reference (for detailed API specs)