Lark Contacts icon

Lark Contacts

Lark Contacts Management

Overview

The node "Lark Contacts" provides integration with the Lark Suite Contacts API, specifically allowing users to obtain detailed information about organizational units within a contact directory. The "Obtain Unit Information" operation fetches data for a specific unit by its unique identifier.

This node is useful in scenarios where you need to programmatically retrieve organizational structure details, such as department names, hierarchy, or metadata, from Lark's contact management system. For example, automating HR workflows, syncing organizational charts, or enriching user profiles with department info.

Properties

Name Meaning
Authentication Method of authenticating API requests. Options: Tenant Token, OAuth2
Unit Id The unique identifier of the organizational unit whose information you want to retrieve
Options Additional optional settings:
• Use Custom Body — whether to send a custom request body (boolean)

Output

The node outputs JSON data representing the details of the requested organizational unit. This typically includes fields such as unit name, ID, parent unit, and other metadata provided by the Lark Contacts API.

No binary data output is involved.

Dependencies

  • Requires an API authentication credential, either a tenant token or OAuth2 token, configured in n8n.
  • Connects to the Lark Suite Open APIs endpoint at https://open.larksuite.com/open-apis.
  • Proper permissions on the Lark account to access contacts and organizational unit information are necessary.

Troubleshooting

  • Invalid Unit Id: If the provided Unit Id does not exist or is malformed, the API will return an error. Verify the Unit Id is correct.
  • Authentication Errors: Using incorrect or expired credentials will cause authentication failures. Ensure the API key or OAuth token is valid and has required scopes.
  • Permission Denied: Insufficient permissions on the Lark account may prevent access to unit information.
  • Use Custom Body Option: Enabling this without providing a proper custom body might lead to malformed requests. Use carefully.

Links and References

Discussion