Lark Contacts icon

Lark Contacts

Lark Contacts Management

Overview

This node, named "Lark Contacts," is designed to interact with the Lark (Feishu) platform's contacts management API. Specifically, for the "User" resource and the "Obtain Single User Information" operation, it retrieves detailed information about a single user based on their user ID. This is useful in scenarios where you need to fetch user profile details such as name, email, or other contact attributes from Lark within an automated workflow.

Practical examples include:

  • Automatically retrieving user details when processing support tickets.
  • Syncing user information from Lark into a CRM system.
  • Validating user identity before performing further actions in a workflow.

Properties

Name Meaning
Authentication Method of authentication to use: either "Tenant Token" or "OAuth2".
User Id The unique identifier of the user to retrieve. Must correspond to the specified user ID type.
Options Additional optional settings:
- Use Custom Body Boolean flag indicating whether to send a custom request body instead of default parameters.

Output

The node outputs JSON data representing the user's information retrieved from Lark. This typically includes fields such as user ID, name, email, avatar URL, department info, and other profile details as provided by the Lark Contacts API.

If binary data were involved (e.g., user avatar images), it would be included in a separate binary output field, but this node primarily deals with JSON user profile data.

Dependencies

  • Requires access to the Lark (Feishu) Open Platform API.
  • Needs one of two authentication methods configured in n8n:
    • An API key credential using a Tenant Token.
    • OAuth2 credentials for user-level authorization.
  • The base URL for API requests is https://open.larksuite.com/open-apis.
  • Proper permissions/scopes must be granted to the credentials to read user information.

Troubleshooting

  • Common issues:

    • Invalid or expired authentication tokens will cause authorization errors.
    • Providing an incorrect or non-existent User Id will result in "user not found" errors.
    • Network connectivity problems can lead to request timeouts or failures.
  • Error messages and resolutions:

    • 401 Unauthorized: Check that the API credentials are valid and have not expired.
    • 404 Not Found: Verify the User Id is correct and exists in the tenant.
    • 400 Bad Request: If using a custom body, ensure the JSON structure matches API expectations.
    • Rate limit exceeded: Slow down request frequency or check API usage limits.

Links and References

Discussion