Lark Contacts icon

Lark Contacts

Lark Contacts Management

Overview

The node "Lark Contacts" provides integration with Lark Suite's contacts management API. Specifically, for the Resource "Unit" and Operation "Obtain Units In Batches," it allows users to retrieve multiple organizational units in batch from Lark's contact system. This is useful in scenarios where an organization wants to synchronize or analyze its internal structure, such as departments or teams, by fetching their details programmatically.

Practical examples include:

  • Importing organizational units into another system for HR or directory services.
  • Automating updates of unit information based on changes in Lark Suite.
  • Generating reports about organizational structure.

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 instead of default one.

Output

The node outputs JSON data representing the retrieved units in batch. The exact structure depends on the API response but generally includes details about each organizational unit such as unit ID, name, parent unit, and other metadata.

If binary data were involved (not indicated here), it would typically represent files or attachments related to units, but this node focuses on JSON data only.

Dependencies

  • Requires access to Lark Suite Open APIs.
  • Needs either a Tenant Token or OAuth2 credentials configured in n8n for authentication.
  • Network connectivity to https://open.larksuite.com/open-apis.

Troubleshooting

  • Authentication errors: Ensure that the provided API credentials are valid and have sufficient permissions to access organizational units.
  • API rate limits: If many requests are made in a short time, the API might throttle calls; implement retry logic or reduce request frequency.
  • Invalid custom body: When using the "Use Custom Body" option, ensure the JSON body is correctly formatted according to Lark's API specification.
  • Network issues: Verify network connectivity and proxy settings if applicable.

Links and References

Discussion