Lark Contacts icon

Lark Contacts

Lark Contacts Management

Overview

This node interacts with the Lark Contacts API to obtain detailed information about a single department within an organization. It is useful in scenarios where you need to retrieve specific department data such as its name, parent department, or other metadata for use in workflows that manage organizational structures, automate HR processes, or synchronize directory information.

For example, you might use this node to fetch department details before updating employee records or generating reports based on department hierarchies.

Properties

Name Meaning
Authentication Method of authenticating API requests. Options: "Tenant Token" or "OAuth2".
Department Id The unique identifier of the department whose information you want to obtain.
Options Additional optional settings:
- Use Custom Body Whether to send a custom request body instead of the default (boolean).

Output

The node outputs JSON data representing the department's information as returned by the Lark Contacts API. This typically includes fields such as department ID, name, parent department ID, and other relevant metadata describing the department.

If binary data were involved (not indicated here), it would be summarized accordingly, but this node focuses on JSON output only.

Dependencies

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

Troubleshooting

  • Invalid Department Id: If the provided department ID does not exist or is malformed, the API will return an error. Verify the department ID is correct.
  • Authentication Errors: Ensure that the selected authentication method is properly configured and the credentials are valid.
  • API Rate Limits: Excessive requests may lead to rate limiting; implement retry logic or reduce request frequency.
  • Use Custom Body Option: If enabled incorrectly, the custom body may cause request failures. Use this option only if you know the exact API payload structure required.

Links and References

Discussion